feat: more work on the configs

prisis · prisis · commit 260ce395e9b2 · 2025-01-09T19:55:20.000+01:00
Signed-off-by: prisis &lt;d.bannert@anolilab.de&gt;
diff --git a/packages/eslint-config/.prettierrc.cjs b/packages/eslint-config/.prettierrc.cjs
diff --git a/packages/eslint-config/.prettierrc.js b/packages/eslint-config/.prettierrc.js
@@ -0,0 +1,6 @@
+// eslint-disable-next-line import/no-extraneous-dependencies
+import config from "@anolilab/prettier-config";
+
+export default {
+    ...config,
+};
diff --git a/packages/eslint-config/debug-eslint.config.mjs b/packages/eslint-config/debug-eslint.config.mjs
@@ -1,3 +1,4 @@
+// eslint-disable-next-line import/extensions
 import { createConfig } from "./dist";
 
 export default createConfig({});
diff --git a/packages/eslint-config/eslint.config.js b/packages/eslint-config/eslint.config.js
@@ -2,12 +2,18 @@ import { createConfig } from "./dist/index.mjs";
 
 export default createConfig(
     {
-        ignores: ["eslint.config.js", "typegen.d.ts"],
+        ignores: ["eslint.config.js", "src/typegen.d.ts"],
     },
     {
         files: ["**/*.ts"],
         rules: {
             "no-secrets/no-secrets": "off",
         },
     },
+    {
+        files: ["debug-eslint.config.mjs"],
+        rules: {
+            "antfu/no-import-dist": "off"
+        }
+    }
 );
diff --git a/packages/eslint-config/package.json b/packages/eslint-config/package.json
@@ -104,9 +104,10 @@
         "dist"
     ],
     "scripts": {
-        "build": "packem build --development",
-        "build:prod": "packem build --production",
+        "build": "pnpm run build:typegen && pnpm run build:global-vitest && packem build --development",
+        "build:prod": "pnpm run build:typegen && pnpm run build:global-vitest && packem build --production",
         "build:typegen": "tsx ./scripts/typegen.ts",
+        "build:global-vitest": "tsx ./scripts/global-vitest.ts",
         "clean": "rimraf node_modules dist",
         "debug:rules": "pnpm exec eslint-config-inspector --config ./debug-eslint.config.mjs",
         "lint:attw": "attw --pack",
diff --git a/packages/eslint-config/scripts/global-vitest.ts b/packages/eslint-config/scripts/global-vitest.ts
@@ -3,34 +3,38 @@ import { createRequire } from "node:module";
 import { dirname, join } from "node:path";
 import { fileURLToPath } from "node:url";
 
+import type { ModuleBody, SourceFile } from "typescript";
 // eslint-disable-next-line import/no-extraneous-dependencies
 import ts from "typescript";
 
-const __dirname = dirname(fileURLToPath(import.meta.url));
+const rootPath = dirname(fileURLToPath(import.meta.url));
 
-const e = (message, fail = true) => {
+const showMessageAndExit = (message: string, fail = true) => {
     // eslint-disable-next-line no-console
     console.log(message);
 
+    // eslint-disable-next-line unicorn/no-process-exit
     process.exit(fail ? 1 : 0);
 };
 
-function extract(file) {
+const extract = (file: string) => {
     const program = ts.createProgram([file], {});
-    const sourceFile = program.getSourceFile(file);
-    const globals = [];
+    const sourceFile = program.getSourceFile(file) as SourceFile;
+    const globals: string[] = [];
 
     ts.forEachChild(sourceFile, (node) => {
         if (ts.isModuleDeclaration(node)) {
-            ts.forEachChild(node.body, (node) => {
-                if (ts.isVariableStatement(node)) {
-                    ts.forEachChild(node, (node) => {
-                        if (ts.isVariableDeclarationList(node)) {
-                            for (const declaration of node.declarations) {
+            ts.forEachChild(node.body as ModuleBody, (mNode) => {
+                if (ts.isVariableStatement(mNode)) {
+                    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+                    ts.forEachChild(mNode, (vNode: any) => {
+                        if (ts.isVariableDeclarationList(vNode)) {
+                            // eslint-disable-next-line no-restricted-syntax
+                            for (const declaration of vNode.declarations) {
                                 const name = ts.getNameOfDeclaration(declaration);
 
-                                if (name) {
-                                    globals.push(name.escapedText);
+                                if (name && "escapedText" in name) {
+                                    globals.push(name.escapedText as string);
                                 }
                             }
                         }
@@ -41,32 +45,41 @@ function extract(file) {
     });
 
     return globals;
-}
+};
 
 const require = createRequire(import.meta.url);
 const packagePath = require.resolve("vitest/package.json");
+
 const {
     default: { version: vitestVersion },
 } = await import(packagePath, {
     with: { type: "json" },
 });
 
 if (!vitestVersion) {
-    e("Vitest version cannot be read.");
+    showMessageAndExit("Vitest version cannot be read.");
 }
 
-writeFileSync(join(__dirname, "..", "VERSION"), vitestVersion);
-
 const globalsPath = require.resolve("vitest/globals.d.ts");
+
 const globalsArray = extract(globalsPath);
-const globals = {};
+const globals: Record<string, boolean> = {};
+
+if (globalsArray.length === 0) {
+    showMessageAndExit("No globals! Check extractor implementation.");
+}
 
-if (globalsArray.length === 0) e("No globals! Check extractor implementation.");
+globalsArray.forEach((globalName) => {
+    globals[globalName] = true;
+});
 
-globalsArray.forEach(globalName => (globals[globalName] = true));
-const moduleContent = `export default /** @type {const} */ (${JSON.stringify(globals, undefined, 2)});`;
+const moduleContent = `/**
+ * vitest version ${vitestVersion}
+ */
+export default /** @type {const} */ (${JSON.stringify(globals, undefined, 4)});
+`;
 
-writeFileSync(join(__dirname, "..", "index.mjs"), moduleContent);
+writeFileSync(join(rootPath, "..", "src", "utils", "vitest-globals.ts"), moduleContent);
 
 // eslint-disable-next-line no-console
 console.log("Finished generation with result:\n", moduleContent);
diff --git a/packages/eslint-config/src/config/best-practices.ts b/packages/eslint-config/src/config/best-practices.ts
@@ -451,8 +451,7 @@ export default createConfig<OptionsFiles>("all", async (config, oFiles) => {
                 // https://eslint.org/docs/rules/no-void
                 "no-void": "error",
 
-                // eslint-disable-next-line sonarjs/todo-tag
-                // disallow usage of configurable warning terms in comments: e.g. todo
+                // disallow usage of configurable warning terms in comments: e.g. "todo"
                 "no-warning-comments": [
                     "off",
                     {
diff --git a/packages/eslint-config/src/config/plugins/formatters.ts b/packages/eslint-config/src/config/plugins/formatters.ts
@@ -177,7 +177,13 @@ const formatters = async (options: OptionsFormatters, stylistic: StylisticConfig
     if (options.markdown) {
         const formater = options.markdown === true ? "prettier" : options.markdown;
 
-        const GLOB_SLIDEV = options.slidev ? options.slidev === true ? ["**/slides.md"] : options.slidev.files : [];
+        let GLOB_SLIDEV: string[] = [];
+
+        if (typeof options.slidev === "boolean" && options.slidev === true) {
+            GLOB_SLIDEV = ["**/slides.md"];
+        } else if (typeof options.slidev === "object" && options.slidev.files) {
+            GLOB_SLIDEV = options.slidev.files;
+        }
 
         configs.push({
             files: getFilesGlobs("markdown"),
diff --git a/packages/eslint-config/src/config/plugins/imports.ts b/packages/eslint-config/src/config/plugins/imports.ts
@@ -68,21 +68,27 @@ export default createConfig<OptionsCwd & OptionsFiles & OptionsOverrides & Optio
                     "import/extensions": [
                         "error",
                         "ignorePackages",
-                        packageJson.type === "module"
-                            ? {
-                                cjs: "always",
-                                js: "always",
-                                json: "always",
-                                jsx: "always",
-                                mjs: "always",
-                            }
-                            : {
-                                cjs: "never",
-                                js: "never",
-                                json: "always",
-                                jsx: "never",
-                                mjs: "never",
+                        {
+                            checkTypeImports: tsconfigPath !== undefined,
+                            ignorePackages: true,
+                            pattern: {
+                                ...packageJson.type === "module"
+                                    ? {
+                                        cjs: "always",
+                                        js: "always",
+                                        json: "always",
+                                        jsx: "always",
+                                        mjs: "always",
+                                    }
+                                    : {
+                                        cjs: "never",
+                                        js: "never",
+                                        json: "always",
+                                        jsx: "never",
+                                        mjs: "never",
+                                    },
                             },
+                        },
                     ],
 
                     // disallow non-import statements appearing before import statements
@@ -286,7 +292,6 @@ export default createConfig<OptionsCwd & OptionsFiles & OptionsOverrides & Optio
                     // https://github.com/import-js/eslint-plugin-import/blob/44a038c06487964394b1e15b64f3bd34e5d40cde/docs/rules/no-self-import.md
                     "import/no-self-import": "error",
 
-                    // eslint-disable-next-line sonarjs/todo-tag
                     // @TODO: Enable this rule when it's fixed https://github.com/import-js/eslint-plugin-import/issues/2678
                     // Reports modules without any exports, or with unused exports
                     // https://github.com/import-js/eslint-plugin-import/blob/f63dd261809de6883b13b6b5b960e6d7f42a7813/docs/rules/no-unused-modules.md
diff --git a/packages/eslint-config/src/config/plugins/jsonc.ts b/packages/eslint-config/src/config/plugins/jsonc.ts
@@ -1,4 +1,5 @@
 import { hasPackageJsonAnyDependency } from "@visulima/package";
+import type { Linter } from "eslint";
 
 import type {
     OptionsHasPrettier,
@@ -27,6 +28,7 @@ const jsonc = async (
     const hasSortPackageJson = hasPackageJsonAnyDependency(packageJson, ["sort-package-json"]);
 
     if (hasSortPackageJson && !silent) {
+        // eslint-disable-next-line no-console
         console.info(`\n@anolilab/eslint-config found "sort-package-json" package. \n
     Following rules are disabled: jsonc/sort-keys for all package.json files. \n`);
     }
@@ -36,23 +38,17 @@ const jsonc = async (
         {
             files: ["**/*.json5"],
             name: "anolilab/jsonc/json5-rules",
-            rules: {
-                ...jsoncPlugin.configs["flat/recommended-with-json5"].rules,
-            },
+            rules: (jsoncPlugin.configs["recommended-with-json5"] as Linter.Config).rules,
         },
         {
             files: ["**/*.jsonc"],
             name: "anolilab/jsonc/jsonc-rules",
-            rules: {
-                ...jsoncPlugin.configs["flat/recommended-with-jsonc"].rules,
-            },
+            rules: (jsoncPlugin.configs["recommended-with-jsonc"] as Linter.Config).rules,
         },
         {
             files: ["**/*.json"],
             name: "anolilab/jsonc/json-rules",
-            rules: {
-                ...jsoncPlugin.configs["flat/recommended-with-json"].rules,
-            },
+            rules: (jsoncPlugin.configs["recommended-with-json"] as Linter.Config).rules,
         },
         {
             files: ["**/package.json"],
diff --git a/packages/eslint-config/src/config/plugins/markdown.ts b/packages/eslint-config/src/config/plugins/markdown.ts
@@ -24,7 +24,7 @@ export default createConfig<OptionsComponentExtensions & OptionsFiles & OptionsO
             // `eslint-plugin-markdown` only creates virtual files for code blocks,
             // but not the markdown file itself. We use `eslint-merge-processors` to
             // add a pass-through processor for the markdown file itself.
-            processor: mergeProcessors([markdown.processors!.markdown, processorPassThrough]),
+            processor: mergeProcessors([markdown.processors?.markdown, processorPassThrough]),
         },
         {
             files,
diff --git a/packages/eslint-config/src/config/plugins/sonarjs.ts b/packages/eslint-config/src/config/plugins/sonarjs.ts
@@ -25,6 +25,9 @@ export default createConfig<OptionsFiles & OptionsOverrides>("all", async (confi
                 "sonarjs/no-nested-template-literals": "off",
                 "sonarjs/no-tab": "error",
 
+                // This rule does not work will with disable next line
+                "sonarjs/todo-tag": "off",
+
                 ...overrides,
             },
         },
diff --git a/packages/eslint-config/src/config/plugins/vitest.ts b/packages/eslint-config/src/config/plugins/vitest.ts
@@ -7,13 +7,14 @@ import type {
 } from "../../types";
 import { createConfig } from "../../utils/create-config";
 import interopDefault from "../../utils/interop-default";
+import vitestGlobals from "../../utils/vitest-globals";
 
 // Hold the reference so we don't redeclare the plugin on each call
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 let pluginTest: any;
 
 export default createConfig<OptionsFiles & OptionsHasPrettier & OptionsIsInEditor & OptionsOverrides & OptionsTypeScriptWithTypes>(
-    "all",
+    "vitest",
     async (config, oFiles) => {
         const {
             files = oFiles,
@@ -57,7 +58,11 @@ export default createConfig<OptionsFiles & OptionsHasPrettier & OptionsIsInEdito
                         },
                     }
                     : {},
-
+                languageOptions: {
+                    globals: {
+                        ...vitestGlobals,
+                    },
+                },
                 name: "anolilab/vitest/rules",
                 rules: {
                     ...vitestPlugin.configs.all.rules,
diff --git a/packages/eslint-config/src/index.ts b/packages/eslint-config/src/index.ts
@@ -60,20 +60,22 @@ import type {
 } from "./types";
 import { getFilesGlobs } from "./utils/create-config";
 import interopDefault from "./utils/interop-default";
-import isInEditorEnvironment from "./utils/is-in-editor";
+import isInEditorEnvironment from "./utils/is-in-editor-environment";
 
 const flatConfigProperties = ["name", "languageOptions", "linterOptions", "processor", "plugins", "rules", "settings"] satisfies (keyof TypedFlatConfigItem)[];
 
 export type ResolvedOptions<T> = T extends boolean ? never : NonNullable<T>;
 
 export const resolveSubOptions = <K extends keyof OptionsConfig>(options: OptionsConfig, key: K): ResolvedOptions<OptionsConfig[K]> => {
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     return typeof options[key] === "boolean" ? ({} as any) : options[key] || {};
 };
 
 export const getOverrides = <K extends keyof OptionsConfig>(options: OptionsConfig, key: K): Partial<Linter.RulesRecord & RuleOptions> => {
     const sub = resolveSubOptions(options, key);
 
     return {
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
         ...(options.overrides as any)?.[key],
         ..."overrides" in sub ? sub.overrides : {},
     };
@@ -105,6 +107,7 @@ export const getFiles = <K extends keyof OptionsConfig>(options: OptionsConfig,
  */
 export const createConfig = async (
     options: Omit<TypedFlatConfigItem, "files"> & OptionsConfig = {},
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     ...userConfigs: Awaitable<FlatConfigComposer<any, any> | Linter.Config[] | TypedFlatConfigItem | TypedFlatConfigItem[]>[]
     // eslint-disable-next-line sonarjs/cognitive-complexity
 ): Promise<FlatConfigComposer<TypedFlatConfigItem, ConfigNames>> => {
@@ -921,6 +924,7 @@ export const createConfig = async (
     // eslint-disable-next-line unicorn/no-array-reduce
     const fusedConfig = flatConfigProperties.reduce((accumulator, key) => {
         if (key in options) {
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
             accumulator[key] = options[key] as any;
         }
 
@@ -933,6 +937,7 @@ export const createConfig = async (
 
     let composer = new FlatConfigComposer<TypedFlatConfigItem, ConfigNames>();
 
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     composer = composer.append(...configs, ...(userConfigs as any));
 
     return composer;
diff --git a/packages/eslint-config/src/typegen.d.ts b/packages/eslint-config/src/typegen.d.ts
diff --git a/packages/eslint-config/src/utils/interop-default.ts b/packages/eslint-config/src/utils/interop-default.ts
diff --git a/packages/eslint-config/src/utils/is-in-editor-environment.ts b/packages/eslint-config/src/utils/is-in-editor-environment.ts
diff --git a/packages/eslint-config/src/utils/vitest-globals.ts b/packages/eslint-config/src/utils/vitest-globals.ts
diff --git a/packages/eslint-config/src/vender/prettier-types.ts b/packages/eslint-config/src/vender/prettier-types.ts

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+// eslint-disable-next-line import/extensions`
`1`	`2`	`import { createConfig } from "./dist";`
`2`	`3`
`3`	`4`	`export default createConfig({});`
Original file line number	Diff line number	Diff line change
`@@ -451,8 +451,7 @@ export default createConfig<OptionsFiles>("all", async (config, oFiles) => {`
`451`	`451`	`// https://eslint.org/docs/rules/no-void`
`452`	`452`	`"no-void": "error",`
`453`	`453`
`454`		`- // eslint-disable-next-line sonarjs/todo-tag`
`455`		`- // disallow usage of configurable warning terms in comments: e.g. todo`
	`454`	`+ // disallow usage of configurable warning terms in comments: e.g. "todo"`
`456`	`455`	`"no-warning-comments": [`
`457`	`456`	`"off",`
`458`	`457`	`{`