Update docs dependencies (#1073)

Author: ecraig12345

.github/workflows/pr.yml

@@ -61,7 +61,7 @@ jobs:
 
       - run: yarn test:e2e
 
-  # The docs have a separate installation using Node 20 due to needing newer dependencies
+  # The docs have a separate installation using Node 22 due to needing newer dependencies
   docs:
     name: build docs
 
@@ -71,11 +71,11 @@ jobs:
       - name: Check out code
         uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5
 
-      - name: Install Node.js 20
+      - name: Install Node.js 22
         uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4
         with:
           cache: yarn
-          node-version: 20
+          node-version: 22
 
       - run: yarn --immutable
         working-directory: ./docs

.gitignore

@@ -9,4 +9,5 @@ package-lock.json
 docs/.vuepress/.cache
 docs/.vuepress/.temp
 docs/.yarn/*
+!docs/.yarn/patches/
 !docs/.yarn/releases/

docs/.nvmrc

@@ -1 +1 @@
-20
+22

docs/.vuepress/client.mjs renamed to docs/.vuepress/client.js

@@ -1,6 +1,4 @@
-// @ts-check
-import { defineClientConfig } from 'vuepress/client';
-import { defineMermaidConfig } from 'vuepress-plugin-md-enhance/client';
+import { defineMermaidConfig } from '@vuepress/plugin-markdown-chart/client';
 
 defineMermaidConfig({
   // This can use a CSS variable because text is rendered in HTML tags
@@ -22,9 +20,3 @@ defineMermaidConfig({
   },
   // some spacing options available under "flowchart"
 });
-
-export default defineClientConfig({
-  enhance: context => {
-    context.app.directive;
-  },
-});

docs/.vuepress/config.mjs renamed to docs/.vuepress/config.js

@@ -1,9 +1,8 @@
-// @ts-check
 import { viteBundler } from '@vuepress/bundler-vite';
+import { markdownChartPlugin } from '@vuepress/plugin-markdown-chart';
 import { searchPlugin } from '@vuepress/plugin-search';
 import { defaultTheme } from '@vuepress/theme-default';
 import { defineUserConfig } from 'vuepress';
-import { mdEnhancePlugin } from 'vuepress-plugin-md-enhance';
 
 export default defineUserConfig({
   title: 'beachball',
@@ -40,7 +39,7 @@ export default defineUserConfig({
     ],
   }),
   plugins: [
-    mdEnhancePlugin({
+    markdownChartPlugin({
       mermaid: true,
     }),
     searchPlugin(),

docs/package.json

@@ -1,25 +1,26 @@
 {
-  "name": "beachball-docs",
+  "name": "@beachball/docs",
   "version": "0.0.0",
   "description": "Separate package with separate build to get rid of very outdated deps while keeping beachball v2 on Node 14",
   "private": true,
+  "type": "module",
   "scripts": {
     "docs": "vuepress dev --host localhost",
     "docs:build": "vuepress build",
     "release:docs": "yarn docs:build && yarn gh-pages -d .vuepress/dist --dotfiles"
   },
   "devDependencies": {
     "@vuepress/bundler-vite": "^2.0.0-rc.18",
+    "@vuepress/plugin-markdown-chart": "^2.0.0-rc.109",
     "@vuepress/plugin-search": "^2.0.0-rc.61",
     "@vuepress/theme-default": "^2.0.0-rc",
     "gh-pages": "^6.0.0",
     "mermaid": "^11.4.0",
     "sass-embedded": "^1.81.0",
-    "vuepress": "^2.0.0-rc",
-    "vuepress-plugin-md-enhance": "^2.0.0-rc.59"
+    "vuepress": "^2.0.0-rc"
   },
   "engines": {
-    "node": ">=20",
+    "node": ">=22",
     "yarn": "^4"
   },
   "packageManager": "[email protected]"

docs/tsconfig.json

@@ -0,0 +1,13 @@
+{
+  "compilerOptions": {
+    "noEmit": true,
+    "allowJs": true,
+    "checkJs": true,
+    "strict": true,
+    "lib": ["es2022", "dom"],
+    "module": "es2022",
+    "moduleResolution": "bundler",
+    "types": []
+  },
+  "include": ["./.vuepress/*.js"]
+}