Merge pull request #233 from kevin-lee/update-docusaurus

Bump Docusaurus to 3.5.2 and sbt-devoops to 3.1.0

.github/workflows/doc-site-build-only.yml

@@ -15,7 +15,7 @@ jobs:
         scala:
           - { version: "2.13.12", binary-version: "2.13", java-version: "[email protected]" }
         node:
-          - { version: "16.16.0" }
+          - { version: "18.13.0" }
 
     steps:
       - uses: actions/checkout@v4

.github/workflows/doc-site-publish.yml

@@ -14,7 +14,7 @@ jobs:
         scala:
           - { version: "2.13.12", binary-version: "2.13", java-version: "[email protected]" }
         node:
-          - { version: "16.16.0" }
+          - { version: "18.13.0" }
 
     steps:
       - uses: actions/checkout@v4

project/plugins.sbt

@@ -15,7 +15,7 @@ addSbtPlugin("org.portable-scala" % "sbt-scala-native-crossproject" % "1.3.2")
 
 addSbtPlugin("org.scalameta" % "sbt-native-image" % "0.3.4")
 
-val sbtDevOopsVersion = "3.0.0"
+val sbtDevOopsVersion = "3.1.0"
 addSbtPlugin("io.kevinlee" % "sbt-devoops-scala"     % sbtDevOopsVersion)
 addSbtPlugin("io.kevinlee" % "sbt-devoops-sbt-extra" % sbtDevOopsVersion)
 addSbtPlugin("io.kevinlee" % "sbt-devoops-github"    % sbtDevOopsVersion)

website/docusaurus.config.js → website/docusaurus.config.ts

@@ -1,18 +1,18 @@
 // @ts-check
 // Note: type annotations allow type checking and IDEs autocompletion
+import {themes as prismThemes} from 'prism-react-renderer';
+import type {Config} from '@docusaurus/types';
+import type * as Preset from '@docusaurus/preset-classic';
 
 const algoliaConfig = require('./algolia.config.json');
 const googleAnalyticsConfig = require('./google-analytics.config.json');
 
 // const lightCodeTheme = require('prism-react-renderer/themes/github');
 // const darkCodeTheme = require('prism-react-renderer/themes/dracula');
-const lightCodeTheme = require('prism-react-renderer/themes/nightOwlLight');
-const darkCodeTheme = require('prism-react-renderer/themes/nightOwl');
+const lightCodeTheme = prismThemes.nightOwlLight;
+const darkCodeTheme = prismThemes.nightOwl;
 
-const isEmptyObject = obj => {
-  for (field in obj) return false;
-  return true;
-};
+const isEmptyObject = (obj: object) => Object.keys(obj).length === 0;
 
 const isSearchable = !isEmptyObject(algoliaConfig);
 const hasGoogleAnalytics = !isEmptyObject(googleAnalyticsConfig);
@@ -24,7 +24,7 @@ const classicConfig = {
     lastVersion: 'current',
     "versions": {
       "current": {
-        "label": "0.12.0"
+        "label": "0.13.0"
       },
     }
     // Please change this to your repo.

website/package.json

@@ -15,18 +15,19 @@
     "typecheck": "tsc"
   },
   "dependencies": {
-    "@docusaurus/core": "2.4.3",
-    "@docusaurus/preset-classic": "2.4.3",
-    "@mdx-js/react": "^1.6.22",
-    "clsx": "^1.2.1",
-    "prism-react-renderer": "^1.3.5",
-    "react": "^17.0.2",
-    "react-dom": "^17.0.2"
+    "@docusaurus/core": "3.5.2",
+    "@docusaurus/preset-classic": "3.5.2",
+    "@mdx-js/react": "^3.0.0",
+    "clsx": "^2.0.0",
+    "prism-react-renderer": "^2.3.0",
+    "react": "^18.0.0",
+    "react-dom": "^18.0.0"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "2.4.3",
-    "@tsconfig/docusaurus": "^2.0.1",
-    "typescript": "^5.2.2"
+    "@docusaurus/module-type-aliases": "3.5.2",
+    "@docusaurus/tsconfig": "3.5.2",
+    "@docusaurus/types": "3.5.2",
+    "typescript": "~5.5.2"
   },
   "browserslist": {
     "production": [
@@ -41,6 +42,6 @@
     ]
   },
   "engines": {
-    "node": ">=16.14"
+    "node": ">=18.0"
   }
 }