Merge branch 'develop' into renovate/eslint-monorepo

libraries/codemirror/eslint.js

@@ -35,39 +35,13 @@
             return [];
         }
 
-        await glob.requireLibrary(glob.ESLINT);
-
         if (text.length > 20000) {
             console.log("Skipping linting because of large size: ", text.length);
 
             return [];
         }
 
-        const errors = new eslint().verify(text, {
-            root: true,
-            parserOptions: {
-                ecmaVersion: "2019"
-            },
-            extends: ['eslint:recommended', 'airbnb-base'],
-            env: {
-                'browser': true,
-                'node': true
-            },
-            rules: {
-                'import/no-unresolved': 'off',
-                'func-names': 'off',
-                'comma-dangle': ['warn'],
-                'padded-blocks': 'off',
-                'linebreak-style': 'off',
-                'class-methods-use-this': 'off',
-                'no-unused-vars': ['warn', { vars: 'local', args: 'after-used' }],
-                'no-nested-ternary': 'off',
-                'no-underscore-dangle': ['error', {'allow': ['_super', '_lookupFactory']}]
-            },
-            globals: {
-                "api": "readonly"
-            }
-        });
+        const errors = await glob.linter(text);
 
         console.log(errors);
 

package-lock.json

@@ -44,6 +44,7 @@
         "electron-squirrel-startup": "1.0.1",
         "electron-window-state": "5.0.3",
         "escape-html": "1.0.3",
+        "eslint-linter-browserify": "9.22.0",
         "express": "4.21.2",
         "express-rate-limit": "7.5.0",
         "express-session": "1.18.1",
@@ -165,6 +166,7 @@
         "electron": "34.3.1",
         "eslint": "9.22.0",
         "esm": "3.2.25",
+        "globals": "16.0.0",
         "happy-dom": "17.3.0",
         "i18next-http-backend": "3.0.2",
         "jsdoc": "4.0.4",
@@ -2251,6 +2253,19 @@
         "url": "https://github.com/sponsors/epoberezkin"
       }
     },
+    "node_modules/@eslint/eslintrc/node_modules/globals": {
+      "version": "14.0.0",
+      "resolved": "https://registry.npmjs.org/globals/-/globals-14.0.0.tgz",
+      "integrity": "sha512-oahGvuMGQlPw/ivIYBjVSrWAfWLBeku5tpPE2fOPLi+WHffIWbuh2tCjhyQhTBPMf5E9jDEH4FOmTYgYwbKwtQ==",
+      "dev": true,
+      "license": "MIT",
+      "engines": {
+        "node": ">=18"
+      },
+      "funding": {
+        "url": "https://github.com/sponsors/sindresorhus"
+      }
+    },
     "node_modules/@eslint/eslintrc/node_modules/json-schema-traverse": {
       "version": "0.4.1",
       "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-0.4.1.tgz",
@@ -10128,6 +10143,12 @@
         }
       }
     },
+    "node_modules/eslint-linter-browserify": {
+      "version": "9.22.0",
+      "resolved": "https://registry.npmjs.org/eslint-linter-browserify/-/eslint-linter-browserify-9.22.0.tgz",
+      "integrity": "sha512-b70x+ilh1XkugEZZvGJ6LNPE1+jxjsn4KIdj1OBMBGbzYj7l2lr3N/Y4NHKhFxq2a4v/J8WqojIOvy0AFDmrXw==",
+      "license": "MIT"
+    },
     "node_modules/eslint-scope": {
       "version": "5.1.1",
       "resolved": "https://registry.npmjs.org/eslint-scope/-/eslint-scope-5.1.1.tgz",
@@ -11609,9 +11630,9 @@
       }
     },
     "node_modules/globals": {
-      "version": "14.0.0",
-      "resolved": "https://registry.npmjs.org/globals/-/globals-14.0.0.tgz",
-      "integrity": "sha512-oahGvuMGQlPw/ivIYBjVSrWAfWLBeku5tpPE2fOPLi+WHffIWbuh2tCjhyQhTBPMf5E9jDEH4FOmTYgYwbKwtQ==",
+      "version": "16.0.0",
+      "resolved": "https://registry.npmjs.org/globals/-/globals-16.0.0.tgz",
+      "integrity": "sha512-iInW14XItCXET01CQFqudPOWP2jYMl7T+QRQT+UNcR/iQncN/F0UNpgd76iFkBPgNQb4+X3LV9tLJYzwh+Gl3A==",
       "dev": true,
       "license": "MIT",
       "engines": {

package.json

@@ -100,6 +100,7 @@
     "electron-squirrel-startup": "1.0.1",
     "electron-window-state": "5.0.3",
     "escape-html": "1.0.3",
+    "eslint-linter-browserify": "9.22.0",
     "express": "4.21.2",
     "express-rate-limit": "7.5.0",
     "express-session": "1.18.1",
@@ -218,6 +219,7 @@
     "electron": "34.3.1",
     "eslint": "9.22.0",
     "esm": "3.2.25",
+    "globals": "16.0.0",
     "happy-dom": "17.3.0",
     "i18next-http-backend": "3.0.2",
     "jsdoc": "4.0.4",

src/public/app/services/eslint.spec.ts

@@ -0,0 +1,48 @@
+import { lint } from "./eslint.js";
+import { trimIndentation } from "../../../../spec/support/utils.js";
+import { describe, expect, it } from "vitest";
+
+describe("Linter", () => {
+    it("reports some basic errors", async () => {
+        const result = await lint(trimIndentation`
+            for (const i = 0; i<10; i++) {
+            }
+        `);
+        expect(result).toMatchObject([
+            { message: "'i' is constant.", },
+            { message: "Empty block statement." }
+        ]);
+    });
+
+    it("reports no error for correct script", async () => {
+        const result = await lint(trimIndentation`
+            const foo = "bar";
+            console.log(foo.toString());
+            for (const x of [ 1, 2, 3]) {
+                console.log(x?.toString());
+            }
+
+            api.showMessage("Hi");
+        `);
+        expect(result.length).toBe(0);
+    });
+
+    it("reports unused functions as warnings", async () => {
+        const result = await lint(trimIndentation`
+            function hello() { }
+            function world() { }
+
+            console.log("Hello world");
+        `);
+        expect(result).toMatchObject([
+            {
+                message: "'hello' is defined but never used.",
+                severity: 1
+            },
+            {
+                message: "'world' is defined but never used.",
+                severity: 1
+            }
+        ]);
+    });
+});

src/public/app/services/eslint.ts

@@ -0,0 +1,25 @@
+export async function lint(code: string) {
+
+    const Linter = (await import("eslint-linter-browserify")).Linter;
+    const js = (await import("@eslint/js"));
+    const globals = (await import("globals"));
+
+    return new Linter().verify(code, [
+        js.configs.recommended,
+        {
+            languageOptions: {
+                parserOptions: {
+                    ecmaVersion: 2024
+                },
+                globals: {
+                    ...globals.browser,
+                    api: "readonly"
+                },
+            },
+            rules: {
+                "no-unused-vars": [ "warn", { vars: "local", args: "after-used" }]
+            }
+        }
+    ]);
+
+}

src/public/app/services/glob.ts

@@ -5,6 +5,7 @@ import libraryLoader from "./library_loader.js";
 import ws from "./ws.js";
 import froca from "./froca.js";
 import linkService from "./link.js";
+import { lint } from "./eslint.js";
 
 function setupGlobs() {
     window.glob.isDesktop = utils.isDesktop;
@@ -18,7 +19,7 @@ function setupGlobs() {
     // required for ESLint plugin and CKEditor
     window.glob.getActiveContextNote = () => appContext.tabManager.getActiveContextNote();
     window.glob.requireLibrary = libraryLoader.requireLibrary;
-    window.glob.ESLINT = libraryLoader.ESLINT;
+    window.glob.linter = lint;
     window.glob.appContext = appContext; // for debugging
     window.glob.froca = froca;
     window.glob.treeCache = froca; // compatibility for CKEditor builds for a while

src/public/app/services/library_loader.ts

@@ -42,10 +42,6 @@ const CODE_MIRROR: Library = {
     css: ["node_modules/codemirror/lib/codemirror.css", "node_modules/codemirror/addon/lint/lint.css"]
 };
 
-const ESLINT: Library = {
-    js: ["libraries/eslint/eslint.js"]
-};
-
 const RELATION_MAP: Library = {
     js: ["node_modules/jsplumb/dist/js/jsplumb.min.js", "node_modules/panzoom/dist/panzoom.min.js"],
     css: ["stylesheets/relation_map.css"]
@@ -108,13 +104,17 @@ async function requireLibrary(library: Library) {
     }
 
     if (library.js) {
-        for (const scriptUrl of unwrapValue(library.js)) {
+        for (const scriptUrl of await unwrapValue(library.js)) {
             await requireScript(scriptUrl);
         }
     }
 }
 
-function unwrapValue<T>(value: T | (() => T)) {
+async function unwrapValue<T>(value: T | (() => T) | Promise<(() => T)>) {
+    if (value && typeof value === "object" && "then" in value) {
+        return (await (value as Promise<() => T>))();
+    }
+
     if (typeof value === "function") {
         return (value as () => T)();
     }
@@ -183,7 +183,6 @@ export default {
     loadHighlightingTheme,
     CKEDITOR,
     CODE_MIRROR,
-    ESLINT,
     RELATION_MAP,
     CALENDAR_WIDGET,
     KATEX,

src/public/app/types.d.ts

@@ -6,6 +6,7 @@ import appContext from "./components/app_context.ts";
 import server from "./services/server.ts";
 import library_loader, { Library } from "./services/library_loader.ts";
 import type { init } from "i18next";
+import type { lint } from "./services/eslint.ts";
 
 interface ElectronProcess {
     type: string;
@@ -44,6 +45,7 @@ interface CustomGlobals {
     triliumVersion: string;
     TRILIUM_SAFE_MODE: boolean;
     platform?: typeof process.platform;
+    linter: typeof lint;
 }
 
 type RequireMethod = (moduleName: string) => any;

src/services/utils.ts

@@ -353,7 +353,6 @@ export function processStringOrBuffer(data: string | Buffer | null) {
     }
 
     const detectedEncoding = chardet.detect(data);
-    console.log("Detected as ", detectedEncoding);
     switch (detectedEncoding) {
         case "UTF-16LE":
             return stripBom(data.toString("utf-16le"));

src/views/login.ejs

@@ -6,11 +6,11 @@
     <title><%= t("login.title") %></title>
     <link rel="apple-touch-icon" sizes="180x180" href="<%= assetPath %>/images/app-icons/ios/apple-touch-icon.png">
     <link rel="shortcut icon" href="favicon.ico">
+    <% // TriliumNextTODO: move the css file to ${assetPath}/stylesheets/  %>
+    <link rel="stylesheet" href="<%= appPath %>/login.css">
     <link rel="stylesheet" href="<%= assetPath %>/stylesheets/theme-light.css">
     <link rel="stylesheet" href="<%= assetPath %>/stylesheets/theme-next.css">
     <link rel="stylesheet" href="<%= assetPath %>/stylesheets/style.css">
-    <% // TriliumNextTODO: move the css file to ${assetPath}/stylesheets/  %>
-    <link rel="stylesheet" href="<%= appPath %>/login.css">
 </head>
 <body>
 <div class="container">