@open-xchange/linter-presets 1.6.0 → 1.7.0

package/dist/eslint/env/react.js

@@ -5,7 +5,7 @@ import reactRefreshPlugin from "eslint-plugin-react-refresh";
 import jsxA11yPlugin from "eslint-plugin-jsx-a11y";
 import { fixupPluginRules } from "@eslint/compat";
 import { parser } from "typescript-eslint";
-import { createConfigArray, createConfig, customRules, convertRuleWarningsToErrors } from "../shared/env-utils.js";
+import { createConfig, customRules, convertRuleWarningsToErrors } from "../shared/env-utils.js";
 // functions ==================================================================
 /**
  * Creates configuration objects with linter rules for ReactJS.
@@ -21,71 +21,72 @@ import { createConfigArray, createConfig, customRules, convertRuleWarningsToErro
  *  Configuration options for the environment.
  *
  * @returns
- *  An array of configuration objects to be added to the flat configuration.
+ *  The configuration entries to be added to the resulting configuration array.
  */
 export default function react(envOptions) {
     // recommended configuration of the main plugin
     const recommendedConfig = reactPlugin.configs["recommended-typescript"];
-    return createConfigArray(
-    // configure "react" plugin for all source files (JSX and TSX)
-    createConfig("react:recommended", envOptions, {
-        // auto-detect installed React version
-        languageOptions: {
-            parser: parser,
-            parserOptions: { projectService: true },
-        },
-        // register rule implementations and language settings
-        ...recommendedConfig,
-        rules: {
-            // raise all recommended rules to "error" level
-            ...convertRuleWarningsToErrors(recommendedConfig.rules),
-            // custom overrides
-            "@eslint-react/jsx-no-iife": "error",
-            "@eslint-react/jsx-no-undef": "error",
-            "@eslint-react/no-children-prop": "error",
-            "@eslint-react/no-class-component": "error",
-            "@eslint-react/no-duplicate-jsx-props": "error",
-            "@eslint-react/no-implicit-key": "error",
-            "@eslint-react/no-missing-component-display-name": "error",
-            "@eslint-react/no-useless-fragment": "error",
-            "@eslint-react/prefer-read-only-props": "error",
-            "@eslint-react/prefer-shorthand-boolean": "error",
-            "@eslint-react/prefer-shorthand-fragment": "error",
-            "@eslint-react/use-jsx-vars": "error",
-            "@eslint-react/dom/no-flush-sync": "error",
-            "@eslint-react/dom/no-unknown-property": "error",
-            "@eslint-react/hooks-extra/no-unnecessary-use-callback": "error",
-            "@eslint-react/hooks-extra/no-unnecessary-use-memo": "error",
-            "@eslint-react/naming-convention/filename-extension": ["error", { allow: "as-needed" }],
-            "@eslint-react/naming-convention/use-state": "error",
-        },
-    }), 
-    // "react-hooks" plugin
-    createConfig("react:hooks", envOptions, {
-        // register rule implementations of the plugins
-        plugins: {
-            "react-hooks": reactHooksPlugin,
-        },
-        // recommended rules (raise all recommended rules to "error" level)
-        rules: convertRuleWarningsToErrors(reactHooksPlugin.configs.recommended.rules),
-    }), 
-    // "react-hooks-static-deps" plugin
-    (envOptions.additionalHooks ?? envOptions.staticHooks) && createConfig("react:exhaustive-deps", envOptions, {
-        plugins: {
-            "react-hooks-static-deps": fixupPluginRules(reactHooksStaticDepsPlugin), // https://github.com/stoikio/eslint-plugin-react-hooks-static-deps/issues/1
-        },
-        rules: {
-            "react-hooks/exhaustive-deps": "off",
-            "react-hooks-static-deps/exhaustive-deps": ["error", {
-                    additionalHooks: envOptions.additionalHooks,
-                    staticHooks: envOptions.staticHooks,
-                }],
-        },
-    }), 
-    // "react-refresh" plugin
-    createConfig("react:refresh", envOptions, reactRefreshPlugin.configs.vite), 
-    // "jsx-a11y" plugin
-    createConfig("react:jsx-a11y", envOptions, jsxA11yPlugin.flatConfigs.recommended), 
-    // custom rules
-    customRules("react:rules", envOptions));
+    return [
+        // configure "react" plugin for all source files (JSX and TSX)
+        createConfig("react:recommended", envOptions, {
+            // auto-detect installed React version
+            languageOptions: {
+                parser: parser,
+                parserOptions: { projectService: true },
+            },
+            // register rule implementations and language settings
+            ...recommendedConfig,
+            rules: {
+                // raise all recommended rules to "error" level
+                ...convertRuleWarningsToErrors(recommendedConfig.rules),
+                // custom overrides
+                "@eslint-react/jsx-no-iife": "error",
+                "@eslint-react/jsx-no-undef": "error",
+                "@eslint-react/no-children-prop": "error",
+                "@eslint-react/no-class-component": "error",
+                "@eslint-react/no-duplicate-jsx-props": "error",
+                "@eslint-react/no-implicit-key": "error",
+                "@eslint-react/no-missing-component-display-name": "error",
+                "@eslint-react/no-useless-fragment": "error",
+                "@eslint-react/prefer-read-only-props": "error",
+                "@eslint-react/prefer-shorthand-boolean": "error",
+                "@eslint-react/prefer-shorthand-fragment": "error",
+                "@eslint-react/use-jsx-vars": "error",
+                "@eslint-react/dom/no-flush-sync": "error",
+                "@eslint-react/dom/no-unknown-property": "error",
+                "@eslint-react/hooks-extra/no-unnecessary-use-callback": "error",
+                "@eslint-react/hooks-extra/no-unnecessary-use-memo": "error",
+                "@eslint-react/naming-convention/filename-extension": ["error", { allow: "as-needed" }],
+                "@eslint-react/naming-convention/use-state": "error",
+            },
+        }),
+        // "react-hooks" plugin
+        createConfig("react:hooks", envOptions, {
+            // register rule implementations of the plugins
+            plugins: {
+                "react-hooks": reactHooksPlugin,
+            },
+            // recommended rules (raise all recommended rules to "error" level)
+            rules: convertRuleWarningsToErrors(reactHooksPlugin.configs.recommended.rules),
+        }),
+        // "react-hooks-static-deps" plugin
+        (envOptions.additionalHooks ?? envOptions.staticHooks) && createConfig("react:exhaustive-deps", envOptions, {
+            plugins: {
+                "react-hooks-static-deps": fixupPluginRules(reactHooksStaticDepsPlugin), // https://github.com/stoikio/eslint-plugin-react-hooks-static-deps/issues/1
+            },
+            rules: {
+                "react-hooks/exhaustive-deps": "off",
+                "react-hooks-static-deps/exhaustive-deps": ["error", {
+                        additionalHooks: envOptions.additionalHooks,
+                        staticHooks: envOptions.staticHooks,
+                    }],
+            },
+        }),
+        // "react-refresh" plugin
+        createConfig("react:refresh", envOptions, reactRefreshPlugin.configs.vite),
+        // "jsx-a11y" plugin
+        createConfig("react:jsx-a11y", envOptions, jsxA11yPlugin.flatConfigs.recommended),
+        // custom rules
+        customRules("react:rules", envOptions),
+    ];
 }

package/dist/eslint/env/tsconfig.d.ts

@@ -1,5 +1,4 @@
-import type { Linter } from "eslint";
-import type { EnvBaseOptions } from "../shared/env-utils.js";
+import type { ConfigWithExtendsArg, EnvBaseOptions } from "../shared/env-utils.js";
 /**
  * Configuration options for the environment preset "env.tsconfig".
  */
@@ -16,6 +15,6 @@ export interface EnvTSConfigOptions extends EnvBaseOptions {
  *  Configuration options for the environment.
  *
  * @returns
- *  An array of configuration objects to be added to the flat configuration.
+ *  The configuration entries to be added to the resulting configuration array.
  */
-export default function tsconfig(envOptions: EnvTSConfigOptions): Linter.Config[];
+export default function tsconfig(envOptions: EnvTSConfigOptions): ConfigWithExtendsArg;

package/dist/eslint/env/tsconfig.js

@@ -1,4 +1,4 @@
-import { createConfigArray, createConfig, customRules } from "../shared/env-utils.js";
+import { createConfig, customRules } from "../shared/env-utils.js";
 // functions ==================================================================
 /**
  * Creates configuration objects for TypeScript projects.
@@ -7,19 +7,20 @@ import { createConfigArray, createConfig, customRules } from "../shared/env-util
  *  Configuration options for the environment.
  *
  * @returns
- *  An array of configuration objects to be added to the flat configuration.
+ *  The configuration entries to be added to the resulting configuration array.
  */
 export default function tsconfig(envOptions) {
-    return createConfigArray(
-    // path to project configuration file
-    createConfig("tsconfig:language-options", envOptions, {
-        languageOptions: {
-            parserOptions: {
-                projectService: false,
-                project: envOptions.project,
+    return [
+        // path to project configuration file
+        createConfig("tsconfig:language-options", envOptions, {
+            languageOptions: {
+                parserOptions: {
+                    projectService: false,
+                    project: envOptions.project,
+                },
             },
-        },
-    }), 
-    // custom rules
-    customRules("tsconfig:rules", envOptions));
+        }),
+        // custom rules
+        customRules("tsconfig:rules", envOptions),
+    ];
 }

package/dist/eslint/env/vitest.d.ts

@@ -1,4 +1,4 @@
-import type { Linter } from "eslint";
+import { type ConfigWithExtendsArg } from "../shared/env-utils.js";
 import { type EnvUnitTestOptions } from "../shared/unittest.js";
 /**
  * Configuration options for the environment preset "env.vitest".
@@ -19,6 +19,6 @@ export interface EnvVitestOptions extends EnvUnitTestOptions {
  *  Configuration options for the environment.
  *
  * @returns
- *  An array of configuration objects to be added to the flat configuration.
+ *  The configuration entries to be added to the resulting configuration array.
  */
-export default function vitest(envOptions: EnvVitestOptions): Linter.Config[];
+export default function vitest(envOptions: EnvVitestOptions): ConfigWithExtendsArg;

package/dist/eslint/env/vitest.js

@@ -1,5 +1,5 @@
 import vitestPlugin from "@vitest/eslint-plugin";
-import { JS_GLOB, createConfigArray, createConfig, customRules } from "../shared/env-utils.js";
+import { JS_GLOB, createConfig, customRules } from "../shared/env-utils.js";
 import { createUnitTestPluginConfigs } from "../shared/unittest.js";
 // functions ==================================================================
 /**
@@ -16,59 +16,60 @@ import { createUnitTestPluginConfigs } from "../shared/unittest.js";
  *  Configuration options for the environment.
  *
  * @returns
- *  An array of configuration objects to be added to the flat configuration.
+ *  The configuration entries to be added to the resulting configuration array.
  */
 export default function vitest(envOptions) {
-    return createConfigArray(
-    // "vitest" plugin
-    createConfig("vitest:recommended", envOptions, {
-        // register rule implementations of the plugins
-        plugins: {
-            vitest: vitestPlugin,
-        },
-        // register global symbols of Vitest
-        languageOptions: {
-            globals: vitestPlugin.environments.env.globals,
-        },
-        // recommended rules
-        rules: vitestPlugin.configs.recommended.rules,
-    }), 
-    // "jest-dom" and "testing-library" plugin
-    createUnitTestPluginConfigs("vitest", envOptions), 
-    // allow to add type-checking expectations in tests
-    createConfig("vitest:type-check", envOptions, {
-        ignores: JS_GLOB,
-        settings: {
-            vitest: {
-                typecheck: true,
-            },
-        },
-    }), 
-    // custom rules
-    customRules("vitest:rules", envOptions, {
+    return [
         // "vitest" plugin
-        "vitest/consistent-test-it": "error",
-        "vitest/no-alias-methods": "error",
-        "vitest/no-disabled-tests": "warn",
-        "vitest/no-duplicate-hooks": "error",
-        "vitest/no-focused-tests": "error",
-        "vitest/no-standalone-expect": "error",
-        "vitest/no-test-prefixes": "error",
-        "vitest/no-test-return-statement": "error",
-        "vitest/prefer-comparison-matcher": "error",
-        "vitest/prefer-each": "error",
-        "vitest/prefer-equality-matcher": "error",
-        "vitest/prefer-expect-resolves": "error",
-        "vitest/prefer-hooks-in-order": "error",
-        "vitest/prefer-hooks-on-top": "error",
-        "vitest/prefer-mock-promise-shorthand": "error",
-        "vitest/prefer-spy-on": "error",
-        "vitest/prefer-strict-equal": "error",
-        "vitest/prefer-to-be": "error",
-        "vitest/prefer-to-contain": "error",
-        "vitest/prefer-to-have-length": "error",
-        "vitest/prefer-vi-mocked": "error",
-        "vitest/require-top-level-describe": "error",
-        "vitest/valid-expect-in-promise": "error",
-    }));
+        createConfig("vitest:recommended", envOptions, {
+            // register rule implementations of the plugins
+            plugins: {
+                vitest: vitestPlugin,
+            },
+            // register global symbols of Vitest
+            languageOptions: {
+                globals: vitestPlugin.environments.env.globals,
+            },
+            // recommended rules
+            rules: vitestPlugin.configs.recommended.rules,
+        }),
+        // "jest-dom" and "testing-library" plugin
+        createUnitTestPluginConfigs("vitest", envOptions),
+        // allow to add type-checking expectations in tests
+        createConfig("vitest:type-check", envOptions, {
+            ignores: JS_GLOB,
+            settings: {
+                vitest: {
+                    typecheck: true,
+                },
+            },
+        }),
+        // custom rules
+        customRules("vitest:rules", envOptions, {
+            // "vitest" plugin
+            "vitest/consistent-test-it": "error",
+            "vitest/no-alias-methods": "error",
+            "vitest/no-disabled-tests": "warn",
+            "vitest/no-duplicate-hooks": "error",
+            "vitest/no-focused-tests": "error",
+            "vitest/no-standalone-expect": "error",
+            "vitest/no-test-prefixes": "error",
+            "vitest/no-test-return-statement": "error",
+            "vitest/prefer-comparison-matcher": "error",
+            "vitest/prefer-each": "error",
+            "vitest/prefer-equality-matcher": "error",
+            "vitest/prefer-expect-resolves": "error",
+            "vitest/prefer-hooks-in-order": "error",
+            "vitest/prefer-hooks-on-top": "error",
+            "vitest/prefer-mock-promise-shorthand": "error",
+            "vitest/prefer-spy-on": "error",
+            "vitest/prefer-strict-equal": "error",
+            "vitest/prefer-to-be": "error",
+            "vitest/prefer-to-contain": "error",
+            "vitest/prefer-to-have-length": "error",
+            "vitest/prefer-vi-mocked": "error",
+            "vitest/require-top-level-describe": "error",
+            "vitest/valid-expect-in-promise": "error",
+        }),
+    ];
 }

package/dist/eslint/index.d.ts

@@ -1,4 +1,5 @@
 import type { Linter } from "eslint";
+import { PathResolver } from "../utils/resolver.js";
 import type { ConfigWithExtendsArg, LanguageOptions, PackagesOptions, StylisticOptions } from "./shared/env-utils.js";
 import node from "./env/node.js";
 import browser from "./env/browser.js";
@@ -10,19 +11,22 @@ import eslint from "./env/eslint.js";
 import project from "./env/project.js";
 import tsconfig from "./env/tsconfig.js";
 import decorators from "./env/decorators.js";
-export * from "../utils/resolver.js";
 /**
  * Configuration options for linting the entire project with ESLint.
  */
-export interface ConfigureOptions {
+export interface ProjectOptions {
+    /**
+     * The URL of the project root containing the ESLint configuration file.
+     * Should usually be set to `import.meta.url`.
+     */
+    root: string;
     /**
      * Glob patterns with all files and folders to be ignored by ESLint.
      */
     ignores?: readonly string[];
     /**
-     * Full path to the template file containing the license header to be used
-     * in all source files. The function `resolver` helps to to convert a local
-     * path to an absolute path.
+     * Path to the template file containing the license header to be used in
+     * all source files. May be a path relative to the project root.
      */
     license?: string;
     /**
@@ -46,28 +50,29 @@ export interface ConfigureOptions {
  * A collection with all available environment presets.
  */
 export declare const env: {
-    node: typeof node;
-    browser: typeof browser;
-    jest: typeof jest;
-    vitest: typeof vitest;
-    codecept: typeof codecept;
-    react: typeof react;
-    eslint: typeof eslint;
-    project: typeof project;
-    tsconfig: typeof tsconfig;
-    decorators: typeof decorators;
+    readonly node: typeof node;
+    readonly browser: typeof browser;
+    readonly jest: typeof jest;
+    readonly vitest: typeof vitest;
+    readonly codecept: typeof codecept;
+    readonly react: typeof react;
+    readonly eslint: typeof eslint;
+    readonly project: typeof project;
+    readonly tsconfig: typeof tsconfig;
+    readonly decorators: typeof decorators;
 };
 /**
- * Generates ESLint configuration objects targeting the source files in the
- * entire project.
+ * Generates a complete ESLint configuration array.
  *
  * @param options
- *  Global plugin configuration options.
+ *  Options for the base configuration that will be generated.
  *
  * @param configs
- *  Additional configuration entries.
+ *  Additional configuration entries: Each parameter may be a callback function
+ *  that will be invoked with a `PathResolver` utility.
  *
  * @returns
- *  An array of configuration objects to be added to the flat configuration.
+ *  The resulting ESLint configuration array that must be returned from the
+ *  `eslint.config.*` file.
  */
-export declare function defineConfig(options: ConfigureOptions, ...configs: ConfigWithExtendsArg[]): Linter.Config[];
+export declare function defineConfig(options: ProjectOptions, ...configs: Array<ConfigWithExtendsArg | ((resolver: PathResolver) => ConfigWithExtendsArg)>): Linter.Config[];

package/dist/eslint/index.js

@@ -1,5 +1,6 @@
-import { globalIgnores } from "@eslint/config-helpers";
-import { createConfigArray } from "./shared/env-utils.js";
+import { defineConfig as defineEslintConfig, globalIgnores } from "@eslint/config-helpers";
+import { flattenDeepArrays } from "../utils/utils.js";
+import { PathResolver } from "../utils/resolver.js";
 import base from "./core/base.js";
 import js from "./core/js.js";
 import ts from "./core/ts.js";
@@ -24,8 +25,6 @@ import eslint from "./env/eslint.js";
 import project from "./env/project.js";
 import tsconfig from "./env/tsconfig.js";
 import decorators from "./env/decorators.js";
-// re-exports =================================================================
-export * from "../utils/resolver.js";
 // environment presets ========================================================
 /**
  * A collection with all available environment presets.
@@ -44,17 +43,18 @@ export const env = {
 };
 // functions ==================================================================
 /**
- * Generates ESLint configuration objects targeting the source files in the
- * entire project.
+ * Generates a complete ESLint configuration array.
  *
  * @param options
- *  Global plugin configuration options.
+ *  Options for the base configuration that will be generated.
  *
  * @param configs
- *  Additional configuration entries.
+ *  Additional configuration entries: Each parameter may be a callback function
+ *  that will be invoked with a `PathResolver` utility.
  *
  * @returns
- *  An array of configuration objects to be added to the flat configuration.
+ *  The resulting ESLint configuration array that must be returned from the
+ *  `eslint.config.*` file.
  */
 export function defineConfig(options, ...configs) {
     const ignores = [
@@ -94,7 +94,9 @@ export function defineConfig(options, ...configs) {
             ...options.stylistic?.indent,
         },
     };
-    return createConfigArray(
+    // the resolver for relative file paths
+    const resolver = new PathResolver(options.root);
+    return defineEslintConfig(flattenDeepArrays(
     // ignore certain files and folders
     globalIgnores(ignores, "index:global-ignores"), 
     // module types and standard rules for all JS/TS source files
@@ -102,7 +104,7 @@ export function defineConfig(options, ...configs) {
     // default configuration for JavaScript files
     js(), 
     // default configuration for TypeScript files
-    ts(), 
+    ts(resolver.root), 
     // default configuration for Vue.js files
     vue(languageConfig, stylisticConfig), 
     // default configuration for JSON files
@@ -112,7 +114,7 @@ export function defineConfig(options, ...configs) {
     // default configuration for Markdown files
     markdown(), 
     // check for correct license headers
-    options.license ? license(options.license) : undefined, 
+    options.license ? license(resolver.path(options.license)) : undefined, 
     // default configuration for ESLint inline directives
     directives(), 
     // default configuration for outdated dependencies
@@ -128,5 +130,5 @@ export function defineConfig(options, ...configs) {
     // custom rules
     options.rules && { name: "index:custom-rules", rules: options.rules }, 
     // custom configuration entries
-    configs);
+    configs.map(config => (typeof config === "function") ? config(resolver) : config)));
 }

package/dist/eslint/shared/env-utils.d.ts

@@ -1,5 +1,5 @@
 import type { Linter } from "eslint";
-import { type ConfigWithExtends } from "@eslint/config-helpers";
+import type { ConfigWithExtends } from "@eslint/config-helpers";
 import type { DeepRequired, DeepOptArray } from "../../utils/utils.js";
 export type ConfigWithExtendsArg = DeepOptArray<ConfigWithExtends>;
 /**
@@ -201,20 +201,8 @@ export declare const NO_IMPLICIT_COERCION_OPTIONS: {
  */
 export declare function extGlob(extensions: string[]): string[];
 /**
- * A version of ESLint's `defineConfig` that flattens multiple configuration
- * objects or deeply nested arrays into a flat array while skipping all falsy
- * parameters.
- *
- * @param configs
- *  The configuration objects to be flattened and filtered.
- *
- * @returns
- *  The flattened configuration array.
- */
-export declare function createConfigArray(...configs: ConfigWithExtendsArg[]): Linter.Config[];
-/**
- * Creates a flat configuration object with "files" and "ignores" settings from
- * an environment's "envOptions" object.
+ * Creates a configuration entry with "files" and "ignores" settings from an
+ * environment's "envOptions" object.
  *
  * @param name
  *  The name of the configuration entry.
@@ -222,20 +210,20 @@ export declare function createConfigArray(...configs: ConfigWithExtendsArg[]): L
  * @param envOptions
  *  The environment options containing "files" and "ignores" settings.
  *
- * @param flatConfig
- *  Properties for the flat configuration to be built. Additional "files" and
+ * @param config
+ *  Properties for the configuration entry to be built. Additional "files" and
  *  "ignores" properties will be merged with the settings from "envOptions".
  *
  * @param rules
  *  Hard-coded rule settings to be added to the configuration.
  *
  * @returns
- *  The resulting flat configuration object.
+ *  The resulting configuration entry.
  */
-export declare function createConfig(name: string, envOptions: EnvFilesOptions, flatConfig: Linter.Config, rules?: Linter.RulesRecord): Linter.Config;
+export declare function createConfig(name: string, envOptions: EnvFilesOptions, config: Linter.Config, rules?: Linter.RulesRecord): Linter.Config;
 /**
- * Creates a flat configuration object with "files", "ignores", and "rules"
- * settings from an environment's "envOptions" object.
+ * Creates a configuration entry with "files", "ignores", and "rules" settings
+ * from an environment's "envOptions" object.
  *
  * @param name
  *  The name of the configuration entry.
@@ -250,7 +238,7 @@ export declare function createConfig(name: string, envOptions: EnvFilesOptions,
  *  allow to override them.
  *
  * @returns
- *  The resulting flat configuration object, if the environment options contain
+ *  The resulting configuration entry, if the environment options contain
  *  custom rule settings, otherwise `undefined`.
  */
 export declare function customRules(name: string, envOptions: EnvBaseOptions, rules?: Linter.RulesRecord): Linter.Config | undefined;
@@ -265,7 +253,7 @@ export declare function customRules(name: string, envOptions: EnvBaseOptions, ru
  * @returns
  *  The fixed configuration options.
  */
-export declare function fixMissingFilesOption(configs: Linter.Config[]): Linter.Config[];
+export declare function fixMissingFilesOption(...configs: ConfigWithExtendsArg[]): ConfigWithExtends[];
 /**
  * Converts all warnings in the passed rule options to errors.
  *