Rename to rehype-mermaid

remcohaszing · Oct 20, 2023 · 3bef767 · 3bef767
1 parent 2fd0da0
commit 3bef767
Show file tree

Hide file tree

Showing 5 changed files with 24 additions and 19 deletions.
diff --git a/README.md b/README.md
@@ -1,9 +1,9 @@
-# rehype-mermaidjs
+# rehype-mermaid
 
-[![github actions](https://github.com/remcohaszing/rehype-mermaidjs/actions/workflows/ci.yaml/badge.svg)](https://github.com/remcohaszing/rehype-mermaidjs/actions/workflows/ci.yaml)
-[![codecov](https://codecov.io/gh/remcohaszing/rehype-mermaidjs/branch/main/graph/badge.svg)](https://codecov.io/gh/remcohaszing/rehype-mermaidjs)
-[![npm version](https://img.shields.io/npm/v/rehype-mermaidjs)](https://www.npmjs.com/package/rehype-mermaidjs)
-[![npm downloads](https://img.shields.io/npm/dm/rehype-mermaidjs)](https://www.npmjs.com/package/rehype-mermaidjs)
+[![github actions](https://github.com/remcohaszing/rehype-mermaid/actions/workflows/ci.yaml/badge.svg)](https://github.com/remcohaszing/rehype-mermaid/actions/workflows/ci.yaml)
+[![codecov](https://codecov.io/gh/remcohaszing/rehype-mermaid/branch/main/graph/badge.svg)](https://codecov.io/gh/remcohaszing/rehype-mermaid)
+[![npm version](https://img.shields.io/npm/v/rehype-mermaid)](https://www.npmjs.com/package/rehype-mermaid)
+[![npm downloads](https://img.shields.io/npm/dm/rehype-mermaid)](https://www.npmjs.com/package/rehype-mermaid)
 
 A [rehype](https://rehype.js.org) plugin to render [mermaid](https://mermaid-js.github.io) diagrams.
 
@@ -28,12 +28,13 @@ A [rehype](https://rehype.js.org) plugin to render [mermaid](https://mermaid-js.
 - [Compatibility](#compatibility)
 - [Related Projects](#related-projects)
 - [Contributing](#contributing)
+- [Acknowledgements](#acknowledgements)
 - [License](#license)
 
 ## Installation
 
 ```sh
-npm install rehype-mermaidjs
+npm install rehype-mermaid
 ```
 
 In Node.js this package uses [playwright](https://playwright.dev) under the hood. To use it, you may
@@ -88,7 +89,7 @@ The following script:
 import { readFile } from 'node:fs/promises'
 
 import { rehype } from 'rehype'
-import rehypeMermaid from 'rehype-mermaidjs'
+import rehypeMermaid from 'rehype-mermaid'
 
 const { value } = await rehype()
   .use(rehypeMermaid, {
@@ -267,6 +268,10 @@ slightly different results. Don’t worry about adding new fixtures, but don’t
 that cause CI to fail. Furthermore see my global
 [contributing guidelines](https://github.com/remcohaszing/.github/blob/main/CONTRIBUTING.md).
 
+## Acknowledgements
+
+Thanks to [@bitekong](https://github.com/bitekong) for giving me the npm package name.
+
 ## License
 
 [MIT](LICENSE.md) © [Remco Haszing](https://github.com/remcohaszing)
diff --git a/index.ts b/index.ts
@@ -239,12 +239,12 @@ const rehypeMermaid: Plugin<[RehypeMermaidOptions?], Root> = (options) => {
           replacement = options.errorFallback(node, diagram, result.reason, file)
         } else {
           const message = file.message(result.reason, {
-            ruleId: 'rehype-mermaidjs',
-            source: 'rehype-mermaidjs',
+            ruleId: 'rehype-mermaid',
+            source: 'rehype-mermaid',
             ancestors
           })
           message.fatal = true
-          message.url = 'https://github.com/remcohaszing/rehype-mermaidjs'
+          message.url = 'https://github.com/remcohaszing/rehype-mermaid'
           throw message
         }
 

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,5 +1,5 @@
 {
-  "name": "rehype-mermaidjs",
+  "name": "rehype-mermaid",
   "version": "2.0.0",
   "description": "A rehype plugin to render mermaid diagrams",
   "exports": "./index.js",
@@ -14,9 +14,9 @@
   },
   "author": "Remco Haszing <remcohaszing@gmail.com>",
   "license": "MIT",
-  "repository": "remcohaszing/rehype-mermaidjs",
-  "bugs": "https://github.com/remcohaszing/rehype-mermaidjs/issues",
-  "homepage": "https://github.com/remcohaszing/rehype-mermaidjs#readme",
+  "repository": "remcohaszing/rehype-mermaid",
+  "bugs": "https://github.com/remcohaszing/rehype-mermaid/issues",
+  "homepage": "https://github.com/remcohaszing/rehype-mermaid#readme",
   "funding": "https://github.com/sponsors/remcohaszing",
   "keywords": [
     "documentation",

diff --git a/test/test.ts b/test/test.ts
@@ -106,8 +106,8 @@ test('invalid diagram unhandled', async () => {
     () => processor.process('<pre class="mermaid">This is not a valid diagram</pre>'),
     (error) => {
       assert(error instanceof VFileMessage)
-      assert.equal(error.source, 'rehype-mermaidjs')
-      assert.equal(error.ruleId, 'rehype-mermaidjs')
+      assert.equal(error.source, 'rehype-mermaid')
+      assert.equal(error.ruleId, 'rehype-mermaid')
       assert.equal(
         error.reason,
         'No diagram type detected matching given configuration for text: This is not a valid diagram'
@@ -116,7 +116,7 @@ test('invalid diagram unhandled', async () => {
         start: { line: 1, column: 1, offset: 0 },
         end: { line: 1, column: 55, offset: 54 }
       })
-      assert.equal(error.url, 'https://github.com/remcohaszing/rehype-mermaidjs')
+      assert.equal(error.url, 'https://github.com/remcohaszing/rehype-mermaid')
       const root = error.ancestors![0] as Root
       const html = root.children[0] as Element
       const body = html.children[1] as Element