ci: use eslint flat config (#400)

Co-authored-by: Bhsd <55071315+bhsd-harry@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

.github/workflows/postCommit.yaml

@@ -159,11 +159,11 @@ jobs:
       - name: Check environment
         run: 'npx eslint --env-info && echo ---- && echo "stylelint: "$(npx stylelint --version) && echo ---- && echo "v8r: "$(npx v8r --version) && echo ---- && mkdir -vp .cache && echo ".cache:" && ls -lhA .cache'
       - name: Run eslint
-        run: npx eslint --cache --cache-strategy content --cache-location ".cache/" --ext js --exit-on-fatal-error --format @annangela/eslint-formatter-gha --max-warnings 0 ./src
+        run: npx eslint --cache --cache-strategy content --cache-location ".cache/" --exit-on-fatal-error --format @annangela/eslint-formatter-gha --max-warnings 0 ./src
       - name: Run stylelint
         run: npx stylelint --cache --cache-strategy content --cache-location ".cache/"  --formatter github --max-warnings 0 "src/**/*.css"
       - name: Run v8r
-        run: echo "::group::v8r output" && npx v8r && echo "::endgroup::"
+        run: npx v8r
       - name: Check .mailmap
         if: needs.postCommit.result == 'success'
         run: node scripts/emailmapChecker/index.js

.vscode/settings.json

@@ -20,7 +20,7 @@
         "./.vscode/json-schemas/gadget-definition.json": "src/gadgets/*/definition.yaml"
     },
     "files.insertFinalNewline": true,
-    "eslint.experimental.useFlatConfig": false,
+    "eslint.experimental.useFlatConfig": true,
     "conventionalCommits.scopes": [
         "Gadget-abusefilter33test",
         "Gadget-abusefilterEdit",
@@ -126,7 +126,6 @@
         "Gadget-widgetPreload",
         "Gadget-wikiBlame",
         "Gadget-wikieditor-highlight",
-        "Gadget-wikieditor-highlight-cm6",
         "Gadget-Wikiplus",
         "Gadget-wikiplus-highlight",
         "Gadget-zeroFill",

eslint.config.js

@@ -0,0 +1,141 @@
+import fs from "node:fs";
+import path from "node:path";
+import YAML from "yaml";
+import { configs } from "@annangela/eslint-config";
+import readDir from "./scripts/modules/readDir.js";
+
+/**
+ * @type { import("eslint").Linter.FlatConfigFileSpec }
+ */
+const ignores = [
+    "**/dist/**",
+    "**/.*/**",
+    "node_modules",
+];
+
+const srcESlintrcFiles = (await readDir("./src")).filter((n) => path.basename(n) === ".eslintrc.yaml");
+for (const srcESlintrcFile of srcESlintrcFiles) {
+    const dir = path.dirname(srcESlintrcFile);
+    const srcESlintrc = YAML.parse(await fs.promises.readFile(srcESlintrcFile, { encoding: "utf-8" }));
+    if (Array.isArray(srcESlintrc.ignorePatterns)) {
+        for (const ignorePattern of srcESlintrc.ignorePatterns) {
+            ignores.push(path.join(dir, ignorePattern));
+        }
+    }
+}
+
+/**
+ * @typedef { Pick<import("eslint").Linter.FlatConfig, "files" | "ignores"> } FileSpec
+ */
+/**
+ * @type { { browser: FileSpec, node: FileSpec } }
+ */
+const fileSpec = {
+    browser: {
+        files: [
+            "src/**/*",
+            "scripts/generatePolyfill/template.js",
+        ],
+        ignores,
+    },
+    node: {
+        files: [
+            "scripts/**/*",
+            "eslint.config.js",
+        ],
+        ignores: [
+            ...ignores,
+            "scripts/generatePolyfill/template.js",
+        ],
+    },
+};
+
+/**
+ * @type { import("eslint").Linter.FlatConfig[] }
+ */
+const config = [
+    // base
+    {
+        ...configs.base,
+        ignores,
+    },
+    {
+        ...configs.browser,
+        ...fileSpec.browser,
+    },
+    {
+        ...fileSpec.browser,
+        languageOptions: {
+            globals: {
+                mw: false,
+                mediaWiki: false,
+                OO: false,
+                localforage: false,
+                moment: false,
+                LocalObjectStorage: false,
+                insertToBottomRightCorner: false,
+                wgULS: false,
+                wgUVS: false,
+                hashwasm: false,
+                oouiDialog: false,
+                echarts: false,
+                MOE_SKIN_GLOBAL_DATA_REF: false,
+                ace: false,
+                libCachedCode: false,
+                CodeMirror: false,
+            },
+        },
+    },
+    {
+        ...configs.node,
+        ...fileSpec.node,
+    },
+    {
+        ignores,
+        rules: {
+            // other disabled rules for all files
+            "@stylistic/no-mixed-operators": "off",
+        },
+    },
+    {
+        ...fileSpec.browser,
+        rules: {
+            // other disabled rules for browser files
+            "promise/prefer-await-to-callbacks": "off",
+        },
+    },
+    {
+        ...fileSpec.node,
+        rules: {
+            // Running in trusted environment
+            "security/detect-unsafe-regex": "off",
+            "security/detect-object-injection": "off",
+            "security/detect-non-literal-fs-filename": "off",
+            "security/detect-non-literal-regexp": "off",
+            "security/detect-child-process": "off",
+            "n/no-extraneous-import": "off",
+            "n/no-process-exit": "off",
+
+            // github api use underscores naming
+            camelcase: [
+                "error",
+                {
+                    allow: [
+                        "pull_number",
+                        "issue_number",
+                        "head_commit",
+                        "commit_long",
+                        "state_reason",
+                        "workflow_id",
+                        "exclude_pull_requests",
+                        "per_page",
+                        "workflow_runs",
+                    ],
+                },
+            ],
+
+            // other disabled rules for node files
+        },
+    },
+];
+export default config;