@open-xchange/linter-presets 1.6.0 → 1.7.0

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

@@ -1,4 +1,4 @@
-import type { Linter } from "eslint";
+import { type ConfigWithExtendsArg } from "../shared/env-utils.js";
 import type { EnvRestrictedOptions } from "../shared/restricted.js";
 /**
  * Configuration options for the environment preset "env.browser".
@@ -17,6 +17,6 @@ export interface EnvBrowserOptions extends EnvRestrictedOptions {
  *  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 browser(envOptions: EnvBrowserOptions): Linter.Config[];
+export default function browser(envOptions: EnvBrowserOptions): ConfigWithExtendsArg;

package/dist/eslint/env/browser.js

@@ -1,6 +1,6 @@
 import JAVASCRIPT_GLOBALS from "globals";
 import CONFUSING_BROWSER_GLOBALS from "confusing-browser-globals";
-import { createConfigArray, createConfig, customRules } from "../shared/env-utils.js";
+import { createConfig, customRules } from "../shared/env-utils.js";
 import { restrictedRulesConfig } from "../shared/restricted.js";
 // constants ==================================================================
 /**
@@ -85,22 +85,23 @@ const RESTRICTED_GLOBALS = AMBIGUOUS_BROWSER_TYPES.map(name => {
  *  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 browser(envOptions) {
-    return createConfigArray(
-    // register global symbols used in browser scripts
-    createConfig("browser:globals", envOptions, {
-        languageOptions: {
-            globals: BROWSER_GLOBALS,
-        },
-    }), 
-    // generate the "no-restricted-?" rules according to passed configuration
-    restrictedRulesConfig("browser:restricted", envOptions, {
-        globals: RESTRICTED_GLOBALS,
-        properties: RESTRICTED_PROPERTIES,
-        syntax: RESTRICTED_SYNTAX,
-    }), 
-    // custom rules
-    customRules("browser:rules", envOptions));
+    return [
+        // register global symbols used in browser scripts
+        createConfig("browser:globals", envOptions, {
+            languageOptions: {
+                globals: BROWSER_GLOBALS,
+            },
+        }),
+        // generate the "no-restricted-?" rules according to passed configuration
+        restrictedRulesConfig("browser:restricted", envOptions, {
+            globals: RESTRICTED_GLOBALS,
+            properties: RESTRICTED_PROPERTIES,
+            syntax: RESTRICTED_SYNTAX,
+        }),
+        // custom rules
+        customRules("browser:rules", envOptions),
+    ];
 }

package/dist/eslint/env/codecept.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.codecept".
  */
@@ -17,6 +16,6 @@ export interface EnvCodeceptOptions 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 codecept(envOptions: EnvCodeceptOptions): Linter.Config[];
+export default function codecept(envOptions: EnvCodeceptOptions): ConfigWithExtendsArg;

package/dist/eslint/env/codecept.js

@@ -1,6 +1,6 @@
 import codeceptPlugin from "eslint-plugin-codeceptjs";
 import chaiExpectPlugin from "eslint-plugin-chai-expect";
-import { createConfigArray, createConfig, customRules } from "../shared/env-utils.js";
+import { createConfig, customRules } from "../shared/env-utils.js";
 // functions ==================================================================
 /**
  * Creates configuration objects with global symbols and linter rules for E2E
@@ -14,31 +14,32 @@ 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 codecept(envOptions) {
-    return createConfigArray(
-    // "codecept" plugin
-    createConfig("codecept:plugin", envOptions, {
-        // register rule implementations of the plugins
-        plugins: {
-            codeceptjs: codeceptPlugin,
-        },
-        // register global symbols of CodeceptJS
-        languageOptions: {
-            globals: codeceptPlugin.environments.codeceptjs.globals,
-        },
-        // recommended rules
-        rules: codeceptPlugin.configs.recommended.rules,
-    }), 
-    // "chai-expect" plugin
-    createConfig("codecept:recommended", envOptions, chaiExpectPlugin.configs["recommended-flat"]), 
-    // custom rules
-    customRules("codecept:rules", envOptions, {
-        "new-cap": ["error", {
-                capIsNewExceptions: ["After", "AfterSuite", "Before", "BeforeSuite", "Feature", "Scenario"],
-            }],
-        "no-restricted-properties": ["warn", { object: "Scenario", property: "todo", message: "Unexpected unimplemented test." }],
-        "codeceptjs/no-skipped-tests": "warn",
-    }));
+    return [
+        // "codecept" plugin
+        createConfig("codecept:plugin", envOptions, {
+            // register rule implementations of the plugins
+            plugins: {
+                codeceptjs: codeceptPlugin,
+            },
+            // register global symbols of CodeceptJS
+            languageOptions: {
+                globals: codeceptPlugin.environments.codeceptjs.globals,
+            },
+            // recommended rules
+            rules: codeceptPlugin.configs.recommended.rules,
+        }),
+        // "chai-expect" plugin
+        createConfig("codecept:recommended", envOptions, chaiExpectPlugin.configs["recommended-flat"]),
+        // custom rules
+        customRules("codecept:rules", envOptions, {
+            "new-cap": ["error", {
+                    capIsNewExceptions: ["After", "AfterSuite", "Before", "BeforeSuite", "Feature", "Scenario"],
+                }],
+            "no-restricted-properties": ["warn", { object: "Scenario", property: "todo", message: "Unexpected unimplemented test." }],
+            "codeceptjs/no-skipped-tests": "warn",
+        }),
+    ];
 }

package/dist/eslint/env/decorators.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.decorators".
  */
@@ -16,6 +15,6 @@ export interface EnvDecoratorsOptions 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 decorators(envOptions: EnvBaseOptions): Linter.Config[];
+export default function decorators(envOptions: EnvBaseOptions): ConfigWithExtendsArg;

package/dist/eslint/env/decorators.js

@@ -1,5 +1,5 @@
 import babelParser from "@babel/eslint-parser";
-import { TS_GLOB, createConfigArray, createConfig, customRules } from "../shared/env-utils.js";
+import { TS_GLOB, createConfig, customRules } from "../shared/env-utils.js";
 // functions ==================================================================
 /**
  * Adds support for native decorators in JavaScript source files.
@@ -12,23 +12,26 @@ import { TS_GLOB, createConfigArray, createConfig, customRules } from "../shared
  *  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 decorators(envOptions) {
-    return createConfigArray(createConfig("decorators:language-options", envOptions, {
-        ignores: TS_GLOB,
-        languageOptions: {
-            parser: babelParser,
-            parserOptions: {
-                requireConfigFile: false,
-                babelOptions: {
-                    babelrc: false,
-                    configFile: false,
-                    plugins: [
-                        ["@babel/plugin-proposal-decorators", { version: "2023-11" }],
-                    ],
+    return [
+        createConfig("decorators:language-options", envOptions, {
+            ignores: TS_GLOB,
+            languageOptions: {
+                parser: babelParser,
+                parserOptions: {
+                    requireConfigFile: false,
+                    babelOptions: {
+                        babelrc: false,
+                        configFile: false,
+                        plugins: [
+                            ["@babel/plugin-proposal-decorators", { version: "2023-11" }],
+                        ],
+                    },
                 },
             },
-        },
-    }), customRules("decorators:rules", envOptions));
+        }),
+        customRules("decorators:rules", envOptions),
+    ];
 }

package/dist/eslint/env/eslint.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.eslint".
  */
@@ -15,6 +14,6 @@ export interface EnvEslintOptions 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 eslint(envOptions: EnvEslintOptions): Linter.Config[];
+export default function eslint(envOptions: EnvEslintOptions): ConfigWithExtendsArg;

package/dist/eslint/env/eslint.js

@@ -1,5 +1,5 @@
 import eslintPlugin from "eslint-plugin-eslint-plugin";
-import { createConfigArray, createConfig, customRules } from "../shared/env-utils.js";
+import { createConfig, customRules } from "../shared/env-utils.js";
 // exports ====================================================================
 /**
  * Adds linter rules for ESLint plugin implementations.
@@ -11,20 +11,21 @@ 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 eslint(envOptions) {
-    return createConfigArray(
-    // register rule implementations and recommended rules
-    createConfig("eslint:recommended", envOptions, eslintPlugin.configs["flat/rules-recommended"]), 
-    // custom rules
-    customRules("eslint:rules", envOptions, {
-        "eslint-plugin/no-meta-schema-default": "error",
-        "eslint-plugin/no-property-in-node": "error",
-        "eslint-plugin/prefer-placeholders": "error",
-        "eslint-plugin/prefer-replace-text": "error",
-        "eslint-plugin/require-meta-default-options": "error",
-        "eslint-plugin/require-meta-docs-description": "error",
-        "eslint-plugin/require-meta-schema-description": "error",
-    }));
+    return [
+        // register rule implementations and recommended rules
+        createConfig("eslint:recommended", envOptions, eslintPlugin.configs["flat/rules-recommended"]),
+        // custom rules
+        customRules("eslint:rules", envOptions, {
+            "eslint-plugin/no-meta-schema-default": "error",
+            "eslint-plugin/no-property-in-node": "error",
+            "eslint-plugin/prefer-placeholders": "error",
+            "eslint-plugin/prefer-replace-text": "error",
+            "eslint-plugin/require-meta-default-options": "error",
+            "eslint-plugin/require-meta-docs-description": "error",
+            "eslint-plugin/require-meta-schema-description": "error",
+        }),
+    ];
 }

package/dist/eslint/env/jest.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.jest".
@@ -19,6 +19,6 @@ export interface EnvJestOptions 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 jest(envOptions: EnvJestOptions): Linter.Config[];
+export default function jest(envOptions: EnvJestOptions): ConfigWithExtendsArg;

package/dist/eslint/env/jest.js

@@ -1,5 +1,5 @@
 import jestPlugin from "eslint-plugin-jest";
-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,41 +16,42 @@ 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 jest(envOptions) {
-    return createConfigArray(
-    // register rule implementations, globals, and recommended rules
-    createConfig("jest:recommended", envOptions, jestPlugin.configs["flat/recommended"]), 
-    // add recommended stylistic rules
-    createConfig("jest:stylistic", envOptions, jestPlugin.configs["flat/style"]), 
-    // "jest-dom" and "testing-library" plugin
-    createUnitTestPluginConfigs("jest", envOptions), 
-    // custom rules
-    customRules("jest:rules", envOptions, {
-        "jest/consistent-test-it": ["error", { fn: "it" }],
-        "jest/no-commented-out-tests": "error",
-        "jest/no-conditional-expect": "off",
-        "jest/no-confusing-set-timeout": "error",
-        "jest/no-duplicate-hooks": "error",
-        "jest/no-test-return-statement": "error",
-        "jest/prefer-comparison-matcher": "error",
-        "jest/prefer-equality-matcher": "error",
-        "jest/prefer-expect-resolves": "error",
-        "jest/prefer-hooks-on-top": "error",
-        "jest/prefer-jest-mocked": "error",
-        "jest/prefer-lowercase-title": "error",
-        "jest/prefer-mock-promise-shorthand": "error",
-        "jest/prefer-spy-on": "error",
-        "jest/prefer-todo": "error",
-        "jest/require-top-level-describe": "error",
-    }), 
-    // enable "jest/unbound-method" for TS files
-    createConfig("jest:typescript", envOptions, {
-        ignores: JS_GLOB,
-        rules: {
-            "jest/unbound-method": "error",
-            "@typescript-eslint/unbound-method": "off", // replaced by "jest/unbound-method"
-        },
-    }));
+    return [
+        // register rule implementations, globals, and recommended rules
+        createConfig("jest:recommended", envOptions, jestPlugin.configs["flat/recommended"]),
+        // add recommended stylistic rules
+        createConfig("jest:stylistic", envOptions, jestPlugin.configs["flat/style"]),
+        // "jest-dom" and "testing-library" plugin
+        createUnitTestPluginConfigs("jest", envOptions),
+        // custom rules
+        customRules("jest:rules", envOptions, {
+            "jest/consistent-test-it": ["error", { fn: "it" }],
+            "jest/no-commented-out-tests": "error",
+            "jest/no-conditional-expect": "off",
+            "jest/no-confusing-set-timeout": "error",
+            "jest/no-duplicate-hooks": "error",
+            "jest/no-test-return-statement": "error",
+            "jest/prefer-comparison-matcher": "error",
+            "jest/prefer-equality-matcher": "error",
+            "jest/prefer-expect-resolves": "error",
+            "jest/prefer-hooks-on-top": "error",
+            "jest/prefer-jest-mocked": "error",
+            "jest/prefer-lowercase-title": "error",
+            "jest/prefer-mock-promise-shorthand": "error",
+            "jest/prefer-spy-on": "error",
+            "jest/prefer-todo": "error",
+            "jest/require-top-level-describe": "error",
+        }),
+        // enable "jest/unbound-method" for TS files
+        createConfig("jest:typescript", envOptions, {
+            ignores: JS_GLOB,
+            rules: {
+                "jest/unbound-method": "error",
+                "@typescript-eslint/unbound-method": "off", // replaced by "jest/unbound-method"
+            },
+        }),
+    ];
 }

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

@@ -1,6 +1,5 @@
-import type { Linter } from "eslint";
 import type ts from "typescript";
-import type { LanguageOptions } from "../shared/env-utils.js";
+import type { ConfigWithExtendsArg, LanguageOptions } from "../shared/env-utils.js";
 import { type EnvRestrictedOptions } from "../shared/restricted.js";
 export type EnvNodeConvertPathPattern = [pattern: string, replacement: string];
 export type EnvNodeConvertPathObject = Record<string, EnvNodeConvertPathPattern>;
@@ -45,6 +44,6 @@ export interface EnvNodeOptions extends EnvRestrictedOptions {
  *  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 node(envOptions: EnvNodeOptions): Linter.Config[];
+export default function node(envOptions: EnvNodeOptions): ConfigWithExtendsArg;

package/dist/eslint/env/node.js

@@ -1,5 +1,5 @@
 import nodePlugin from "eslint-plugin-n";
-import { createConfigArray, createConfig, customRules } from "../shared/env-utils.js";
+import { createConfig, customRules } from "../shared/env-utils.js";
 import { restrictedRulesConfig } from "../shared/restricted.js";
 // functions ==================================================================
 /**
@@ -13,29 +13,30 @@ import { restrictedRulesConfig } from "../shared/restricted.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 node(envOptions) {
     // the plugin configuration key, according to source module type
     const configKey = (envOptions.sourceType === "commonjs") ? "flat/recommended-script" : "flat/recommended-module";
-    return createConfigArray(
-    // register rule implementations
-    createConfig("node:recommended", envOptions, {
-        ...nodePlugin.configs[configKey],
-        settings: {
-            n: {
-                tryExtensions: [".js", ".ts", ".d.ts"], // automatically add missing extensions in imports
-                ...envOptions.settings,
+    return [
+        // register rule implementations
+        createConfig("node:recommended", envOptions, {
+            ...nodePlugin.configs[configKey],
+            settings: {
+                n: {
+                    tryExtensions: [".js", ".ts", ".d.ts"], // automatically add missing extensions in imports
+                    ...envOptions.settings,
+                },
             },
-        },
-    }), 
-    // generate the "no-restricted-?" rules according to passed configuration
-    restrictedRulesConfig("node:restricted", envOptions), 
-    // custom rules
-    customRules("node:rules", envOptions, {
-        "no-console": "off",
-        "n/no-missing-import": ["error", { ignoreTypeImport: true }],
-        "n/no-unsupported-features/node-builtins": ["error", { allowExperimental: true }],
-        "n/prefer-node-protocol": "error",
-    }));
+        }),
+        // generate the "no-restricted-?" rules according to passed configuration
+        restrictedRulesConfig("node:restricted", envOptions),
+        // custom rules
+        customRules("node:rules", envOptions, {
+            "no-console": "off",
+            "n/no-missing-import": ["error", { ignoreTypeImport: true }],
+            "n/no-unsupported-features/node-builtins": ["error", { allowExperimental: true }],
+            "n/prefer-node-protocol": "error",
+        }),
+    ];
 }

package/dist/eslint/env/project.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";
 import type { SharedRuleSettings } from "../shared/rule-utils.js";
 import { type RuleNoInvalidModulesOptions } from "../rules/no-invalid-modules.js";
 import { type RuleNoInvalidHierarchyOptions } from "../rules/no-invalid-hierarchy.js";
@@ -27,6 +26,6 @@ export interface EnvProjectOptions 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 project(envOptions: EnvProjectOptions): Linter.Config[];
+export default function project(envOptions: EnvProjectOptions): ConfigWithExtendsArg;

package/dist/eslint/env/project.js

@@ -1,4 +1,4 @@
-import { createConfigArray, createConfig, customRules } from "../shared/env-utils.js";
+import { createConfig, customRules } from "../shared/env-utils.js";
 import noAmdModuleDirective from "../rules/no-amd-module-directive.js";
 import noInvalidModules from "../rules/no-invalid-modules.js";
 import noInvalidHierarchy from "../rules/no-invalid-hierarchy.js";
@@ -10,31 +10,32 @@ import noInvalidHierarchy from "../rules/no-invalid-hierarchy.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 project(envOptions) {
-    return createConfigArray(
-    // register rule implementations
-    createConfig("project:plugin", envOptions, {
-        plugins: {
-            "env-project": {
-                rules: {
-                    "no-amd-module-directive": noAmdModuleDirective,
-                    "no-invalid-modules": noInvalidModules,
-                    "no-invalid-hierarchy": noInvalidHierarchy,
-                }, // TODO
+    return [
+        // register rule implementations
+        createConfig("project:plugin", envOptions, {
+            plugins: {
+                "env-project": {
+                    rules: {
+                        "no-amd-module-directive": noAmdModuleDirective,
+                        "no-invalid-modules": noInvalidModules,
+                        "no-invalid-hierarchy": noInvalidHierarchy,
+                    }, // TODO
+                },
             },
-        },
-        settings: {
-            "env-project": {
-                alias: envOptions.alias,
+            settings: {
+                "env-project": {
+                    alias: envOptions.alias,
+                },
             },
-        },
-    }), 
-    // custom rules
-    customRules("project:rules", envOptions, {
-        "env-project/no-amd-module-directive": "error",
-        "env-project/no-invalid-modules": ["error", { external: envOptions.external ?? [] }],
-        "env-project/no-invalid-hierarchy": envOptions.hierarchy ? ["error", envOptions.hierarchy] : "off",
-    }));
+        }),
+        // custom rules
+        customRules("project:rules", envOptions, {
+            "env-project/no-amd-module-directive": "error",
+            "env-project/no-invalid-modules": ["error", { external: envOptions.external ?? [] }],
+            "env-project/no-invalid-hierarchy": envOptions.hierarchy ? ["error", envOptions.hierarchy] : "off",
+        }),
+    ];
 }

package/dist/eslint/env/react.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.react".
  */
@@ -47,6 +46,6 @@ export interface EnvReactOptions 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 react(envOptions: EnvReactOptions): Linter.Config[];
+export default function react(envOptions: EnvReactOptions): ConfigWithExtendsArg;