Put mermaid as first-class dependency

pasqal-io · Feb 14, 2025 · 64aada1 · 64aada1
1 parent d2c3742
commit 64aada1
Show file tree

Hide file tree

Showing 5 changed files with 15 additions and 16 deletions.
diff --git a/docs/package.json b/docs/package.json
@@ -14,10 +14,9 @@
   },
   "dependencies": {
     "@astrojs/starlight": "^0.31.1",
+    "@pasqal-io/starlight-client-mermaid": "workspace:*",
     "astro": "^5.1.10",
-    "mermaid": "^11.4.1",
-    "sharp": "^0.33.5",
-    "@pasqal-io/starlight-client-mermaid": "workspace:*"
+    "sharp": "^0.33.5"
   },
   "engines": {
     "node": "^18.17.1 || ^20.3.0 || >=21.0.0"

diff --git a/docs/src/content/docs/getting-started.mdx b/docs/src/content/docs/getting-started.mdx
@@ -21,30 +21,30 @@ import { Steps, Tabs, TabItem } from '@astrojs/starlight/components'
 
 <Steps>
 
-1. The plugin requires the installation of the [`mermaid`](https://www.npmjs.com/package/mermaid) package in your Starlight project, alongside its own package `starlight-client-mermaid`. You can install both at once with your preferred package manager:
+1. The plugin package `@pasqal-io/starlight-client-mermaid` can be installed with your package manager of choice:
 
    <Tabs syncKey="pkg">
 
    <TabItem label="npm">
 
    ```sh
-   npm install @pasqal-io/starlight-client-mermaid mermaid
+   npm install @pasqal-io/starlight-client-mermaid
    ```
 
    </TabItem>
 
    <TabItem label="pnpm">
 
    ```sh
-   pnpm add @pasqal-io/starlight-client-mermaid mermaid
+   pnpm add @pasqal-io/starlight-client-mermaid
    ```
 
    </TabItem>
 
    <TabItem label="Yarn">
 
    ```sh
-   yarn add @pasqal-io/starlight-client-mermaid mermaid
+   yarn add @pasqal-io/starlight-client-mermaid
    ```
 
    </TabItem>

diff --git a/packages/starlight-client-mermaid/index.ts b/packages/starlight-client-mermaid/index.ts
@@ -66,6 +66,9 @@ export default function starlightClientMermaid(
                 },
                 vite: {
                   plugins: [vitePluginStarlightClientMermaidConfig(options)],
+                  optimizeDeps: {
+                    include: ["mermaid"], // used in dev to prevent issues with ESM imports of mermaid deps
+                  },
                 },
               });
             },

diff --git a/packages/starlight-client-mermaid/package.json b/packages/starlight-client-mermaid/package.json
@@ -11,13 +11,12 @@
     "./package.json": "./package.json"
   },
   "devDependencies": {
-    "@astrojs/markdown-remark": "^6.0.2",
     "@astrojs/starlight": "^0.31.1",
     "astro": "^5.1.10"
   },
   "peerDependencies": {
-    "@astrojs/starlight": ">=0.31",
-    "mermaid": "^11.4.1"
+    "@astrojs/markdown-remark": "^6.0.2",
+    "@astrojs/starlight": ">=0.31"
   },
   "engines": {
     "node": "^18.17.1 || ^20.3.0 || >=21.0.0"
@@ -33,6 +32,7 @@
   },
   "bugs": "https://github.com/pasqal-io/starlight-client-mermaid/issues",
   "dependencies": {
+    "mermaid": "^11.4.1",
     "unist-util-visit": "^5.0.0"
   }
 }
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
-Original file line number
+Diff line change
@@ Expand Up / @@ -66,6 +66,9 @@ export default function starlightClientMermaid( @@
                     },
                     vite: {
                       plugins: [vitePluginStarlightClientMermaidConfig(options)],
+                      optimizeDeps: {
+                        include: ["mermaid"], // used in dev to prevent issues with ESM imports of mermaid deps
+                      },
                     },
                   });
                 },
@@ Expand Down @@