Repository: graphql-markdown/graphql-markdown
Pull request #662 (2022-10-04 16:01:02)

:bookmark:  rename package
# Description

Rename package and bump version

# Checklist

- [x] My changes follow the [contributing guidelines](https://github.com/graphql-markdown/graphql-markdown/blob/main/CONTRIBUTING.md) of this project.
- [x] I have performed a self-review of my code.
- [x] I have made corresponding changes to the documentation.
- [ ] I have added tests that prove my fix is effective or that my changes work.
- [x] New and existing unit tests pass locally with my changes.


sonarcloud[bot]: Kudos, SonarCloud Quality Gate passed!&nbsp; &nbsp; [![Quality Gate passed](https://sonarsource.github.io/sonarcloud-github-static-resources/v2/checks/QualityGateBadge/passed-16px.png 'Quality Gate passed')](https://sonarcloud.io/dashboard?id=graphql-markdown_graphql-markdown&pullRequest=662)

[![Bug](https://sonarsource.github.io/sonarcloud-github-static-resources/v2/common/bug-16px.png 'Bug')](https://sonarcloud.io/project/issues?id=graphql-markdown_graphql-markdown&pullRequest=662&resolved=false&types=BUG) [![A](https://sonarsource.github.io/sonarcloud-github-static-resources/v2/checks/RatingBadge/A-16px.png 'A')](https://sonarcloud.io/project/issues?id=graphql-markdown_graphql-markdown&pullRequest=662&resolved=false&types=BUG) [0 Bugs](https://sonarcloud.io/project/issues?id=graphql-markdown_graphql-markdown&pullRequest=662&resolved=false&types=BUG)  
[![Vulnerability](https://sonarsource.github.io/sonarcloud-github-static-resources/v2/common/vulnerability-16px.png 'Vulnerability')](https://sonarcloud.io/project/issues?id=graphql-markdown_graphql-markdown&pullRequest=662&resolved=false&types=VULNERABILITY) [![A](https://sonarsource.github.io/sonarcloud-github-static-resources/v2/checks/RatingBadge/A-16px.png 'A')](https://sonarcloud.io/project/issues?id=graphql-markdown_graphql-markdown&pullRequest=662&resolved=false&types=VULNERABILITY) [0 Vulnerabilities](https://sonarcloud.io/project/issues?id=graphql-markdown_graphql-markdown&pullRequest=662&resolved=false&types=VULNERABILITY)  
[![Security Hotspot](https://sonarsource.github.io/sonarcloud-github-static-resources/v2/common/security_hotspot-16px.png 'Security Hotspot')](https://sonarcloud.io/project/security_hotspots?id=graphql-markdown_graphql-markdown&pullRequest=662&resolved=false&types=SECURITY_HOTSPOT) [![E](https://sonarsource.github.io/sonarcloud-github-static-resources/v2/checks/RatingBadge/E-16px.png 'E')](https://sonarcloud.io/project/security_hotspots?id=graphql-markdown_graphql-markdown&pullRequest=662&resolved=false&types=SECURITY_HOTSPOT) [1 Security Hotspot](https://sonarcloud.io/project/security_hotspots?id=graphql-markdown_graphql-markdown&pullRequest=662&resolved=false&types=SECURITY_HOTSPOT)  
[![Code Smell](https://sonarsource.github.io/sonarcloud-github-static-resources/v2/common/code_smell-16px.png 'Code Smell')](https://sonarcloud.io/project/issues?id=graphql-markdown_graphql-markdown&pullRequest=662&resolved=false&types=CODE_SMELL) [![A](https://sonarsource.github.io/sonarcloud-github-static-resources/v2/checks/RatingBadge/A-16px.png 'A')](https://sonarcloud.io/project/issues?id=graphql-markdown_graphql-markdown&pullRequest=662&resolved=false&types=CODE_SMELL) [0 Code Smells](https://sonarcloud.io/project/issues?id=graphql-markdown_graphql-markdown&pullRequest=662&resolved=false&types=CODE_SMELL)

[![No Coverage information](https://sonarsource.github.io/sonarcloud-github-static-resources/v2/checks/CoverageChart/NoCoverageInfo-16px.png 'No Coverage information')](https://sonarcloud.io/component_measures?id=graphql-markdown_graphql-markdown&pullRequest=662) No Coverage information  
[![0.0%](https://sonarsource.github.io/sonarcloud-github-static-resources/v2/checks/Duplications/3-16px.png '0.0%')](https://sonarcloud.io/component_measures?id=graphql-markdown_graphql-markdown&pullRequest=662&metric=new_duplicated_lines_density&view=list) [0.0% Duplication](https://sonarcloud.io/component_measures?id=graphql-markdown_graphql-markdown&pullRequest=662&metric=new_duplicated_lines_density&view=list)


codesee-maps[bot]: <details>
<summary><b>👇 <a href="https://app.codesee.io/r/reviews?pr=662&src=https%3A%2F%2Fgithub.com%2Fgraphql-markdown%2Fgraphql-markdown">Click on the image</a> for a new way to code review</b>
</summary>

  - Make big changes easier — review code in small groups of related files
  - Know where to start — see the whole change at a glance
  - Take a code tour — explore the change with an interactive tour
  - Make comments and review — all fully sync’ed with github

    [Try it now!](https://app.codesee.io/r/reviews?pr=662&src=https%3A%2F%2Fgithub.com%2Fgraphql-markdown%2Fgraphql-markdown)
</details>

[![Review these changes using an interactive CodeSee Map](https://s3.us-east-2.amazonaws.com/maps.codesee.io/images/github/graphql-markdown/graphql-markdown/662/b601e39f/9ebcbaa9cebb7fd19f6809e893d2bd44b06a8395.svg)](https://app.codesee.io/r/reviews?pr=662&src=https%3A%2F%2Fgithub.com%2Fgraphql-markdown%2Fgraphql-markdown)

#### Legend
![CodeSee Map Legend](https://app.codesee.io/Legend_v2.png)
coveralls: 
[![Coverage Status](https://coveralls.io/builds/53000682/badge)](https://coveralls.io/builds/53000682)

Coverage remained the same at 95.036% when pulling **9ebcbaa9cebb7fd19f6809e893d2bd44b06a8395 on chore/rename-package** into **7d52e2b6b49106ea94cccfb9a224c8344cd59134 on main**.


Patch:
diff --git a/Earthfile b/Earthfile
index 62e8a964..b0c1688c 100644
--- a/Earthfile
+++ b/Earthfile
@@ -53,8 +53,8 @@ mutation-test:
 
 build-package:
   FROM +deps
-  RUN npm pack | tail -n 1 | xargs -t -I{} mv {} docusaurus2-graphql-doc-generator.tgz
-  SAVE ARTIFACT docusaurus2-graphql-doc-generator.tgz
+  RUN npm pack | tail -n 1 | xargs -t -I{} mv {} docusaurus-plugin.tgz
+  SAVE ARTIFACT docusaurus-plugin.tgz
 
 build-docusaurus:
   WORKDIR /
@@ -67,8 +67,8 @@ build-docusaurus:
 smoke-init:
   FROM +build-docusaurus
   RUN npm install graphql @graphql-tools/url-loader
-  COPY +build-package/docusaurus2-graphql-doc-generator.tgz ./
-  RUN npm install ./docusaurus2-graphql-doc-generator.tgz
+  COPY +build-package/docusaurus-plugin.tgz ./
+  RUN npm install ./docusaurus-plugin.tgz
   COPY ./scripts/config-plugin.js ./config-plugin.js
   COPY ./website/src/css/custom.css ./src/css/custom.css
   COPY --dir ./tests/__data__ ./data
@@ -116,9 +116,9 @@ build-docs:
   COPY ./website ./
   COPY --dir docs ./docs
   COPY +build-examples/examples ./examples
-  COPY +build-package/docusaurus2-graphql-doc-generator.tgz .
+  COPY +build-package/docusaurus-plugin.tgz .
   RUN npm install
-  RUN npm install ./docusaurus2-graphql-doc-generator.tgz
+  RUN npm install ./docusaurus-plugin.tgz
   RUN npm run build
   SAVE ARTIFACT --force ./build AS LOCAL build
 
diff --git a/README.md b/README.md
index 2ef0844e..77f0178e 100644
--- a/README.md
+++ b/README.md
@@ -2,13 +2,13 @@
 
 <h1 align="center">GraphQL documentation generator for Docusaurus</h1>
 
-[![Latest Version](https://img.shields.io/npm/v/@edno/docusaurus2-graphql-doc-generator?style=flat-square)](https://www.npmjs.com/package/@edno/docusaurus2-graphql-doc-generator)
+[![Latest Version](https://img.shields.io/npm/v/@graphql-markdown/docusaurus?style=flat-square)](https://www.npmjs.com/package/@graphql-markdown/docusaurus)
 [![GitHub License](https://img.shields.io/github/license/graphql-markdown/graphql-markdown?style=flat-square)](https://raw.githubusercontent.com/graphql-markdown/graphql-markdown/main/LICENSE)
 [![Buy us a tree](https://img.shields.io/badge/Treeware-%F0%9F%8C%B3-lightgreen)](https://plant.treeware.earth/graphql-markdown/graphql-markdown)
 [![Coverage Status](https://img.shields.io/coveralls/github/graphql-markdown/graphql-markdown?style=flat-square)](https://coveralls.io/github/graphql-markdown/graphql-markdown?branch=main)
 [![Mutation Score](https://img.shields.io/endpoint?label=mutation%20score&style=flat-square&url=https%3A%2F%2Fbadge-api.stryker-mutator.io%2Fgithub.com%2Fgraphql-markdown%2Fgraphql-markdown%2Fmain)](https://dashboard.stryker-mutator.io/reports/github.com/graphql-markdown/graphql-markdown/main)
 [![Sonar Tech Debt](https://img.shields.io/sonar/tech_debt/graphql-markdown_graphql-markdown/main?server=https%3A%2F%2Fsonarcloud.io&style=flat-square)](https://sonarcloud.io/project/overview?id=graphql-markdown_graphql-markdown)
-[![Snyk Package Health](https://snyk.io/advisor/npm-package/@edno/docusaurus2-graphql-doc-generator/badge.svg)](https://snyk.io/advisor/npm-package/@edno/docusaurus2-graphql-doc-generator)
+[![Snyk Package Health](https://snyk.io/advisor/npm-package/@graphql-markdown/docusaurus/badge.svg)](https://snyk.io/advisor/npm-package/@graphql-markdown/docusaurus)
 [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
 
 This plugin generates **Markdown pages** from a **GraphQL schema** for **Docusaurus** [docs feature](https://docusaurus.io/docs/docs-introduction).
@@ -18,15 +18,15 @@ This plugin generates **Markdown pages** from a **GraphQL schema** for **Docusau
 **`graphql` package is a peer-dependency, and it should be installed separately.**
 
 ```shell
-npm install @edno/docusaurus2-graphql-doc-generator graphql
+npm install @graphql-markdown/docusaurus graphql
 ```
 
-Add `@edno/docusaurus2-graphql-doc-generator` to your site's `docusaurus.config.js` plugins option:
+Add `@graphql-markdown/docusaurus` to your site's `docusaurus.config.js` plugins option:
 
 ```js
 module.exports = {
   // ...
-  plugins: ["@edno/docusaurus2-graphql-doc-generator"],
+  plugins: ["@graphql-markdown/docusaurus"],
 };
 ```
 
diff --git a/docs/advanced/additional-schema.md b/docs/advanced/additional-schema.md
index 642cd28f..066e9801 100644
--- a/docs/advanced/additional-schema.md
+++ b/docs/advanced/additional-schema.md
@@ -12,7 +12,7 @@ Assign a unique `id` attribute to each plugin instance (if not set, then `id` va
 ```js {15 }
 plugins: [
     [
-      "@edno/docusaurus2-graphql-doc-generator",
+      "@graphql-markdown/docusaurus",
        {
         // id: 'swapi', // omitted => default instance
         schema: "./schema/swapi.graphql",
@@ -22,7 +22,7 @@ plugins: [
       },
     ],
     [
-      "@edno/docusaurus2-graphql-doc-generator",
+      "@graphql-markdown/docusaurus",
       {
         id: "admin",
         schema: "./schema/admin.graphql",
diff --git a/docs/advanced/custom-root-types.md b/docs/advanced/custom-root-types.md
index 6a9ae631..0e95c587 100644
--- a/docs/advanced/custom-root-types.md
+++ b/docs/advanced/custom-root-types.md
@@ -20,7 +20,7 @@ Add the option `rootTypes` to the loader options under `docusaurus2-graphql-doc-
 ```js
 plugins: [
   [
-    "@edno/docusaurus2-graphql-doc-generator",
+    "@graphql-markdown/docusaurus",
     {
       // ... other options
       loaders: {
diff --git a/docs/advanced/group-by-directive.md b/docs/advanced/group-by-directive.md
index 87462ae3..a7dbe0f8 100644
--- a/docs/advanced/group-by-directive.md
+++ b/docs/advanced/group-by-directive.md
@@ -32,7 +32,7 @@ or the plugin configuration `groupByDirective`:
 ```js {6-10}
 plugins: [
   [
-    "@edno/docusaurus2-graphql-doc-generator",
+    "@graphql-markdown/docusaurus",
     {
       // ... other options
       groupByDirective: {
diff --git a/docs/advanced/schema-loading.md b/docs/advanced/schema-loading.md
index e017a716..1b1befc6 100644
--- a/docs/advanced/schema-loading.md
+++ b/docs/advanced/schema-loading.md
@@ -20,7 +20,7 @@ Once done, you can declare the loader into `docusaurus2-graphql-doc-generator` c
 ```js
 plugins: [
   [
-    "@edno/docusaurus2-graphql-doc-generator",
+    "@graphql-markdown/docusaurus",
     {
       // ... other options
       loaders: {
diff --git a/docs/configuration.md b/docs/configuration.md
index 8d233f55..68420ed3 100644
--- a/docs/configuration.md
+++ b/docs/configuration.md
@@ -11,7 +11,7 @@ module.exports = {
   // ...
   plugins: [
     [
-      "@edno/docusaurus2-graphql-doc-generator",
+      "@graphql-markdown/docusaurus",
       {
         schema: "./schema/swapi.graphql",
         rootPath: "./docs", // docs will be generated under './docs/swapi' (rootPath/baseURL)
diff --git a/docs/get-started.md b/docs/get-started.md
index 52588525..23a7c156 100644
--- a/docs/get-started.md
+++ b/docs/get-started.md
@@ -56,10 +56,10 @@ The `npm run start` command builds your website locally and serves it through a
 
 ### Install the plugin
 
-Add the `@edno/docusaurus2-graphql-doc-generator` plugin to your site installation:
+Add the `@graphql-markdown/docusaurus` plugin to your site installation:
 
 ```shell
-npm install @edno/docusaurus2-graphql-doc-generator graphql
+npm install @graphql-markdown/docusaurus graphql
 ```
 
 :::info
diff --git a/docs/intro.md b/docs/intro.md
index 719bb747..c9cd18d4 100644
--- a/docs/intro.md
+++ b/docs/intro.md
@@ -6,7 +6,7 @@ hide_table_of_contents: true
 
 # Introduction
 
-The `@edno/docusaurus2-graphql-doc-generator` package extends the Docusaurus CLI with commands for generating MDX using a GraphQL schema as the source.
+The `@graphql-markdown/docusaurus` package extends the Docusaurus CLI with commands for generating MDX using a GraphQL schema as the source.
 
 ## Features
 
diff --git a/docs/settings.md b/docs/settings.md
index ccf23b95..e6415f30 100644
--- a/docs/settings.md
+++ b/docs/settings.md
@@ -52,7 +52,7 @@ Use these options to tweak some of the Docusaurus documentation features:
 ```js {9-13}
 plugins: [
     [
-      "@edno/docusaurus2-graphql-doc-generator",
+      "@graphql-markdown/docusaurus",
        {
         schema: "./schema/swapi.graphql",
         rootPath: "./docs",
@@ -125,7 +125,7 @@ Use these options to toggle type information rendered on pages:
 ```js {9-13}
 plugins: [
     [
-      "@edno/docusaurus2-graphql-doc-generator",
+      "@graphql-markdown/docusaurus",
        {
         schema: "./schema/swapi.graphql",
         rootPath: "./docs",
diff --git a/package-lock.json b/package-lock.json
index 8508a2f2..b5a2b659 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -1,12 +1,12 @@
 {
-  "name": "@edno/docusaurus2-graphql-doc-generator",
-  "version": "1.13.1",
+  "name": "@graphql-markdown/docusaurus",
+  "version": "1.14.0",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
-      "name": "@edno/docusaurus2-graphql-doc-generator",
-      "version": "1.13.1",
+      "name": "@graphql-markdown/docusaurus",
+      "version": "1.14.0",
       "license": "MIT",
       "dependencies": {
         "@graphql-inspector/core": "^3.3.0",
diff --git a/package.json b/package.json
index 5ae1bac2..5629f231 100644
--- a/package.json
+++ b/package.json
@@ -1,11 +1,11 @@
 {
-  "name": "@edno/docusaurus2-graphql-doc-generator",
+  "name": "@graphql-markdown/docusaurus",
   "homepage": "https://graphql-markdown.github.io",
   "description": "Docusaurus plugin for generating Markdown documentation from a GraphQL schema.",
   "bugs": {
     "url": "https://github.com/graphql-markdown/graphql-markdown/issues"
   },
-  "version": "1.13.1",
+  "version": "1.14.0",
   "license": "MIT",
   "main": "src/index.js",
   "repository": {
diff --git a/scripts/config-plugin.js b/scripts/config-plugin.js
index a4dc3698..2f6b00d6 100644
--- a/scripts/config-plugin.js
+++ b/scripts/config-plugin.js
@@ -68,8 +68,8 @@ const config = {
     ],
   ],
   plugins: [
-    ["@edno/docusaurus2-graphql-doc-generator", "@config1@"],
-    ["@edno/docusaurus2-graphql-doc-generator", "@config2@"],
+    ["@graphql-markdown/docusaurus", "@config1@"],
+    ["@graphql-markdown/docusaurus", "@config2@"],
   ],
 };
 
diff --git a/src/config.js b/src/config.js
index 6eb1e05c..89e9482e 100644
--- a/src/config.js
+++ b/src/config.js
@@ -4,7 +4,7 @@ const { tmpdir } = require("os");
 const { parseGroupByOption } = require("./lib/group-info");
 const { COMPARE_METHOD } = require("./lib/diff");
 
-const PACKAGE_NAME = "@edno/docusaurus2-graphql-doc-generator";
+const PACKAGE_NAME = "@graphql-markdown/docusaurus";
 const ASSETS_LOCATION = join(__dirname, "../assets/");
 
 const DEFAULT_OPTIONS = {


Test patch:
diff --git a/tests/unit/config.test.js b/tests/unit/config.test.js
index 8a74bd8d..0652c77f 100644
--- a/tests/unit/config.test.js
+++ b/tests/unit/config.test.js
@@ -28,9 +28,7 @@ describe("config", () => {
           outputDir: join(DEFAULT_OPTIONS.rootPath, DEFAULT_OPTIONS.baseURL),
           prettify: DEFAULT_OPTIONS.pretty,
           schemaLocation: DEFAULT_OPTIONS.schema,
-          tmpDir: expect.stringMatching(
-            /.+@edno\/docusaurus2-graphql-doc-generator$/,
-          ),
+          tmpDir: expect.stringMatching(/.+@graphql-markdown\/docusaurus$/),
           docOptions: DEFAULT_OPTIONS.docOptions,
           printTypeOptions: DEFAULT_OPTIONS.printTypeOptions,
         }),