Upgrade to ESLint 9

eslint.config.mjs

@@ -0,0 +1,67 @@
+import typescriptEslint from "@typescript-eslint/eslint-plugin";
+import notice from "eslint-plugin-notice";
+import tsdoc from "eslint-plugin-tsdoc";
+import tsParser from "@typescript-eslint/parser";
+import path from "node:path";
+import { fileURLToPath } from "node:url";
+import js from "@eslint/js";
+import { FlatCompat } from "@eslint/eslintrc";
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+const compat = new FlatCompat({
+    baseDirectory: __dirname,
+    recommendedConfig: js.configs.recommended,
+    allConfig: js.configs.all
+});
+
+export default [{
+    ignores: [
+        "**/node_modules/",
+        "**/dist/",
+        "**/generated-docs/",
+        "packages/prosemirror-lwdita-demo/docker.js",
+        "packages/prosemirror-lwdita/scripts/fix.js"
+    ],
+}, ...compat.extends(
+    "eslint:recommended",
+    "plugin:@typescript-eslint/eslint-recommended",
+    "plugin:@typescript-eslint/recommended",
+), {
+    files: ["**/*.ts", "**/*.tsx"],
+
+    languageOptions: {
+        parser: tsParser,
+    },
+
+    plugins: {
+        "@typescript-eslint": typescriptEslint,
+        notice,
+        tsdoc,
+    },
+
+    rules: {
+        "@typescript-eslint/no-empty-interface": 0,
+        "tsdoc/syntax": "warn",
+
+        "notice/notice": ["error", {
+            templateFile: "config/notice.js",
+        }],
+
+        "@typescript-eslint/no-unused-vars": ["error", {
+            args: "all",
+            argsIgnorePattern: "^_",
+            caughtErrors: "all",
+            caughtErrorsIgnorePattern: "^_",
+            destructuredArrayIgnorePattern: "^_",
+            varsIgnorePattern: "^_",
+            ignoreRestSiblings: true,
+        }],
+    },
+}, {
+    files: ["**/*.spec.ts"],
+
+    rules: {
+        "@typescript-eslint/no-unused-expressions": "off",
+    },
+}];

package.json

@@ -33,9 +33,9 @@
     "test:demo": "yarn workspace @evolvedbinary/prosemirror-lwdita-demo test",
     "coverage": "yarn workspace @evolvedbinary/prosemirror-lwdita coverage",
     "coveralls": "yarn workspace @evolvedbinary/prosemirror-lwdita coveralls",
-    "generate-docs": "yarn workspace @evolvedbinary/prosemirror-lwdita generate-docs",
-    "lint": "eslint packages/* --ext .ts",
-    "lint:fix": "eslint packages/* --ext .ts --fix",
+    "generate-docs": "yarn workspace @evolvedbinary/prosemirror-lwdita generate-docs && yarn workspace @evolvedbinary/prosemirror-lwdita-backend generate-docs",
+    "lint": "eslint packages/*",
+    "lint:fix": "eslint packages/* --fix",
     "start:backend": "yarn workspace @evolvedbinary/prosemirror-lwdita-backend start",
     "test:backend": "yarn workspace @evolvedbinary/prosemirror-lwdita-backend test",
     "clean:backend": "yarn workspace @evolvedbinary/prosemirror-lwdita-backend run clean"
@@ -54,7 +54,7 @@
     "@tsconfig/recommended": "^1.0.7",
     "@typescript-eslint/eslint-plugin": "^8.11.0",
     "@typescript-eslint/parser": "^8.11.0",
-    "eslint": "^8.57.0",
+    "eslint": "^9.13.0",
     "eslint-plugin-notice": "^1.0.0",
     "eslint-plugin-tsdoc": "^0.3.0",
     "globals": "^15.11.0",

packages/prosemirror-lwdita-backend/package.json

@@ -10,7 +10,8 @@
     "serve": "node ./dist/server.js",
     "clean": "rimraf dist",
     "build": "tsc",
-    "test": "mocha"
+    "test": "mocha",
+    "generate-docs": "typedoc"
   },
   "engines": {
     "node": ">=20.1.0 <21",
@@ -71,6 +72,8 @@
     "sinon-chai": "^4.0.0",
     "supertest": "^7.0.0",
     "ts-node": "^10.9.2",
+    "typedoc": "^0.26.10",
+    "typedoc-plugin-missing-exports": "^3.0.0",
     "typescript": "^5.6.3"
   },
   "packageManager": "[email protected]"

packages/prosemirror-lwdita-backend/src/api/modules/octokit.module.mts

@@ -143,7 +143,7 @@ const createFork = async (octokit: Octokit, owner: string, repo: string): Promis
 const createBranch = async (octokit: Octokit, owner: string, repo: string, branch: string, newBranch: string): Promise<BranchInfo | undefined> => {
   try {
     // get the repo data
-    const { data: repoData } = await octokit.repos.get({
+    const { _data: repoData } = await octokit.repos.get({
       owner, // this should be the authenticated user name
       repo,
     });
@@ -160,7 +160,7 @@ const createBranch = async (octokit: Octokit, owner: string, repo: string, branc
 
     //TODO(YB): Check if the branch already exists
     // create the new branch
-    const { data: refData } = await octokit.git.createRef({
+    const { _data: refData } = await octokit.git.createRef({
       owner,
       repo,
       ref: `refs/heads/${newBranch}`,

packages/prosemirror-lwdita-backend/typedoc.json

@@ -0,0 +1,21 @@
+{
+  "$schema": "https://typedoc.org/schema.json",
+  "entryPoints": ["./src/server.ts"],
+  "exclude": ["generated-docs/**/*.ts", "dist/**/*.ts", "node_modules/**/*.ts"],
+  "out": "generated-docs",
+  "treatWarningsAsErrors": true,
+  "highlightLanguages": [
+      "bash",
+      "console",
+      "css",
+      "html",
+      "javascript",
+      "json",
+      "jsonc",
+      "json5",
+      "tsx",
+      "typescript",
+      "xml"
+  ],
+  "plugin": ["typedoc-plugin-missing-exports"]
+}

packages/prosemirror-lwdita/src/untravel-document.ts

@@ -108,7 +108,6 @@ function getJditaNodeName(type: string): string {
  * @param prosemirrorDocument - prosemirror document
  * @returns JDita node
  */
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
 function createMediaJDITAObject(nodeName: string, attributes: Record<string, string>, children: JDita[]): JDita {
   if (nodeName === 'video') {
     // we must populate the video node with the necessary attributes and children

packages/prosemirror-lwdita/tsdoc.json

@@ -0,0 +1,10 @@
+{
+    "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
+    "extends": ["typedoc/tsdoc.json"],
+    "tagDefinitions": [
+        {
+            "tagName": "@decorator",
+            "syntaxKind": "block"
+        }
+    ]
+}

packages/prosemirror-lwdita/typedoc.json

@@ -1,6 +1,21 @@
 {
   "$schema": "https://typedoc.org/schema.json",
   "entryPoints": ["./src/index.ts"],
+  "exclude": ["generated-docs/**/*.ts", "dist/**/*.ts", "node_modules/**/*.ts"],
   "out": "generated-docs",
   "treatWarningsAsErrors": true,
-}
+  "highlightLanguages": [
+      "bash",
+      "console",
+      "css",
+      "html",
+      "javascript",
+      "json",
+      "jsonc",
+      "json5",
+      "tsx",
+      "typescript",
+      "xml"
+  ],
+  "plugin": ["typedoc-plugin-missing-exports"]
+}