@open-xchange/linter-presets 0.1.4 → 0.1.6

package/.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+    "typescript.tsdk": "node_modules/typescript/lib"
+}

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## [0.1.6] - 2024-07-23
+
+- changed: [ESLint] moved rule options for `env.project` into own `modules` option
+- chore: [ESLint] unit test for `env.project`
+
+## [0.1.5] - 2024-07-23
+
+- chore: bump dependencies
+
 ## [0.1.4] - 2024-07-15
 
 - added: [ESLint] option `language.nativeDecorators` to support native ES decorators in JS files

package/dist/eslint/config/base.js

@@ -119,7 +119,7 @@ export default function base(options) {
                 "object-shorthand": "error",
                 "operator-assignment": "error",
                 "prefer-arrow-callback": "error",
-                "prefer-const": ["error", { ignoreReadBeforeAssign: true }],
+                "prefer-const": ["error", { destructuring: "all", ignoreReadBeforeAssign: true }],
                 "prefer-numeric-literals": "error",
                 "prefer-regex-literals": "error",
                 "prefer-rest-params": "error",

package/dist/eslint/config/ts.js

@@ -63,9 +63,11 @@ export default function ts() {
             "@typescript-eslint/no-shadow": ["error", { ignoreOnInitialization: true }],
             "@typescript-eslint/no-unnecessary-template-expression": "error",
             "@typescript-eslint/no-unsafe-enum-comparison": "error",
+            "@typescript-eslint/no-unsafe-function-type": "error",
             "@typescript-eslint/no-unsafe-unary-minus": "error",
             "@typescript-eslint/no-unused-vars": ["error", NO_UNUSED_VARS_OPTIONS],
             "@typescript-eslint/no-useless-constructor": "error",
+            "@typescript-eslint/no-wrapper-object-types": "error",
             "@typescript-eslint/only-throw-error": "error",
             "@typescript-eslint/prefer-find": "error",
             "@typescript-eslint/prefer-literal-enum-member": "error",

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

@@ -1,14 +1,9 @@
 import type { TSESLint } from "@typescript-eslint/utils";
-import type { EnvBaseOptions, EnvRestrictedOptions } from "../shared/env-utils.js";
+import type { EnvRestrictedOptions } from "../shared/env-utils.js";
 /**
  * Configuration options for the environment preset "env.browser".
  */
-export interface EnvBrowserOptions extends EnvBaseOptions {
-    /**
-     * All globals, imports, properties, and syntax constructs to be banned for
-     * the files included by the environment.
-     */
-    restricted?: EnvRestrictedOptions;
+export interface EnvBrowserOptions extends EnvRestrictedOptions {
 }
 /**
  * Creates configuration objects with global symbols and linter rules for for
@@ -18,10 +13,10 @@ export interface EnvBrowserOptions extends EnvBaseOptions {
  * - `globals`
  * - `confusing-browser-globals`
  *
- * @param options
+ * @param envOptions
  *  Configuration options for the environment.
  *
  * @returns
  *  An array of configuration objects to be added to the flat configuration.
  */
-export default function browser(options: EnvBrowserOptions): TSESLint.FlatConfig.ConfigArray;
+export default function browser(envOptions: EnvBrowserOptions): TSESLint.FlatConfig.ConfigArray;

package/dist/eslint/env/browser.js

@@ -1,6 +1,6 @@
 import JAVASCRIPT_GLOBALS from "globals";
 import CONFUSING_BROWSER_GLOBALS from "confusing-browser-globals";
-import { generateRestrictedRules } from "../shared/env-utils.js";
+import { concatConfigs, createConfig, restrictedRules, customRules } from "../shared/env-utils.js";
 // constants ==================================================================
 /**
  * Global builtin symbols that are confusing or deprecated.
@@ -84,37 +84,26 @@ const RESTRICTED_GLOBALS = AMBIGUOUS_BROWSER_TYPES.map(name => {
  * - `globals`
  * - `confusing-browser-globals`
  *
- * @param options
+ * @param envOptions
  *  Configuration options for the environment.
  *
  * @returns
  *  An array of configuration objects to be added to the flat configuration.
  */
-export default function browser(options) {
-    // configuration properties
-    const { files, ignores = [], rules } = options;
+export default function browser(envOptions) {
+    return concatConfigs(
+    // register global symbols used in browser scripts
+    createConfig(envOptions, {
+        languageOptions: {
+            globals: BROWSER_GLOBALS,
+        },
+    }), 
     // generate the "no-restricted-?" rules according to passed configuration
-    const restricted = generateRestrictedRules({
+    restrictedRules(envOptions, {
         globals: RESTRICTED_GLOBALS,
         properties: RESTRICTED_PROPERTIES,
         syntax: RESTRICTED_SYNTAX,
-    }, options?.restricted);
-    return [
-        // base configuration for the environment
-        {
-            files,
-            ignores,
-            // register global symbols used in browser scripts
-            languageOptions: {
-                globals: BROWSER_GLOBALS,
-            },
-            // configure rules
-            rules: {
-                ...restricted.rules,
-                ...rules,
-            },
-        },
-        // "no-restricted-?" rules overrides for specific files
-        ...restricted.overrides,
-    ];
+    }), 
+    // custom rules
+    customRules(envOptions));
 }

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

@@ -13,10 +13,10 @@ export interface EnvCodeceptOptions extends EnvBaseOptions {
  * - `eslint-plugin-codeceptjs`
  * - `eslint-plugin-chai-expect`
  *
- * @param options
+ * @param envOptions
  *  Configuration options for the environment.
  *
  * @returns
  *  An array of configuration objects to be added to the flat configuration.
  */
-export default function codecept(options: EnvCodeceptOptions): TSESLint.FlatConfig.ConfigArray;
+export default function codecept(envOptions: EnvCodeceptOptions): TSESLint.FlatConfig.ConfigArray;

package/dist/eslint/env/codecept.js

@@ -6,6 +6,7 @@
 */
 import codeceptPlugin from "eslint-plugin-codeceptjs";
 import chaiExpectPlugin from "eslint-plugin-chai-expect";
+import { concatConfigs, createConfig, customRules } from "../shared/env-utils.js";
 // functions ==================================================================
 /**
  * Creates configuration objects with global symbols and linter rules for E2E
@@ -15,47 +16,35 @@ import chaiExpectPlugin from "eslint-plugin-chai-expect";
  * - `eslint-plugin-codeceptjs`
  * - `eslint-plugin-chai-expect`
  *
- * @param options
+ * @param envOptions
  *  Configuration options for the environment.
  *
  * @returns
  *  An array of configuration objects to be added to the flat configuration.
  */
-export default function codecept(options) {
-    // configuration properties
-    const { files, ignores = [], rules } = options;
-    return [
-        {
-            files,
-            ignores,
-            // register rule implementations of the plugins
-            plugins: {
-                codeceptjs: codeceptPlugin,
-            },
-            // register global symbols of CodeceptJS
-            languageOptions: {
-                globals: {
-                    ...codeceptPlugin.environments.codeceptjs.globals,
-                },
-            },
-            // configure plugin rules
-            rules: {
-                // recommended rules
-                ...codeceptPlugin.configs.recommended.rules,
-                // extra rules
-                "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",
-                // custom rules
-                ...rules,
-            },
+export default function codecept(envOptions) {
+    return concatConfigs(
+    // "codecept" plugin
+    createConfig(envOptions, {
+        // register rule implementations of the plugins
+        plugins: {
+            codeceptjs: codeceptPlugin,
         },
-        {
-            files,
-            ignores,
-            ...chaiExpectPlugin.configs["recommended-flat"],
+        // register global symbols of CodeceptJS
+        languageOptions: {
+            globals: codeceptPlugin.environments.codeceptjs.globals,
         },
-    ];
+        // recommended rules
+        rules: codeceptPlugin.configs.recommended.rules,
+    }), 
+    // "chai-expect" plugin
+    createConfig(envOptions, chaiExpectPlugin.configs["recommended-flat"]), 
+    // custom rules
+    customRules(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/eslint.d.ts

@@ -11,10 +11,10 @@ export interface EnvEslintOptions extends EnvBaseOptions {
  * Wraps the following packages:
  * - `eslint-plugin-eslint-plugin`
  *
- * @param options
+ * @param envOptions
  *  Configuration options for the environment.
  *
  * @returns
  *  An array of configuration objects to be added to the flat configuration.
  */
-export default function eslint(options: EnvEslintOptions): TSESLint.FlatConfig.ConfigArray;
+export default function eslint(envOptions: EnvEslintOptions): TSESLint.FlatConfig.ConfigArray;

package/dist/eslint/env/eslint.js

@@ -1,4 +1,5 @@
 import eslintPlugin from "eslint-plugin-eslint-plugin";
+import { concatConfigs, createConfig, customRules } from "../shared/env-utils.js";
 // exports ====================================================================
 /**
  * Adds linter rules for ESLint plugin implementations.
@@ -6,29 +7,16 @@ import eslintPlugin from "eslint-plugin-eslint-plugin";
  * Wraps the following packages:
  * - `eslint-plugin-eslint-plugin`
  *
- * @param options
+ * @param envOptions
  *  Configuration options for the environment.
  *
  * @returns
  *  An array of configuration objects to be added to the flat configuration.
  */
-export default function eslint(options) {
-    // configuration properties
-    const { files, ignores = [], rules = {} } = options;
-    // the plugin configuration
-    const pluginConfig = eslintPlugin.configs["flat/rules-recommended"];
-    return [
-        // register rule implementations and recommended rules
-        {
-            files,
-            ignores,
-            ...pluginConfig,
-        },
-        // reconfigure plugin rules
-        {
-            files,
-            ignores,
-            rules,
-        },
-    ];
+export default function eslint(envOptions) {
+    return concatConfigs(
+    // register rule implementations and recommended rules
+    createConfig(envOptions, eslintPlugin.configs["flat/rules-recommended"]), 
+    // custom rules
+    customRules(envOptions));
 }

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

@@ -12,10 +12,10 @@ export interface EnvJestOptions extends EnvBaseOptions {
  * Wraps the following packages:
  * - `eslint-plugin-jest`
  *
- * @param options
+ * @param envOptions
  *  Configuration options for the environment.
  *
  * @returns
  *  An array of configuration objects to be added to the flat configuration.
  */
-export default function jest(options: EnvJestOptions): TSESLint.FlatConfig.ConfigArray;
+export default function jest(envOptions: EnvJestOptions): TSESLint.FlatConfig.ConfigArray;

package/dist/eslint/env/jest.js

@@ -1,4 +1,5 @@
 import jestPlugin from "eslint-plugin-jest";
+import { concatConfigs, createConfig, customRules } from "../shared/env-utils.js";
 // functions ==================================================================
 /**
  * Creates configuration objects with global symbols and linter rules for unit
@@ -7,43 +8,36 @@ import jestPlugin from "eslint-plugin-jest";
  * Wraps the following packages:
  * - `eslint-plugin-jest`
  *
- * @param options
+ * @param envOptions
  *  Configuration options for the environment.
  *
  * @returns
  *  An array of configuration objects to be added to the flat configuration.
  */
-export default function jest(options) {
-    // config properties
-    const { files, ignores = [], rules } = options;
-    return [{
-            files,
-            ignores,
-            // register rule implementations, globals
-            ...jestPlugin.configs["flat/recommended"],
-            // configure plugin rules
-            rules: {
-                // recommended rules
-                ...jestPlugin.configs["flat/recommended"].rules,
-                ...jestPlugin.configs["flat/style"].rules,
-                // extra rules
-                "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-lowercase-title": "error",
-                "jest/prefer-mock-promise-shorthand": "error",
-                "jest/prefer-spy-on": "error",
-                "jest/prefer-todo": "error",
-                "jest/require-top-level-describe": "error",
-                // custom rules
-                ...rules,
-            },
-        }];
+export default function jest(envOptions) {
+    return concatConfigs(
+    // register rule implementations, globals, and recommended rules
+    createConfig(envOptions, jestPlugin.configs["flat/recommended"]), 
+    // add recommended stylistic rules
+    createConfig(envOptions, {
+        rules: jestPlugin.configs["flat/style"].rules,
+    }), 
+    // custom rules
+    customRules(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-lowercase-title": "error",
+        "jest/prefer-mock-promise-shorthand": "error",
+        "jest/prefer-spy-on": "error",
+        "jest/prefer-todo": "error",
+        "jest/require-top-level-describe": "error",
+    }));
 }

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

@@ -1,18 +1,13 @@
 import type { TSESLint } from "@typescript-eslint/utils";
-import type { LanguageOptions, EnvBaseOptions, EnvRestrictedOptions } from "../shared/env-utils.js";
+import type { LanguageOptions, EnvRestrictedOptions } from "../shared/env-utils.js";
 /**
  * Configuration options for the environment preset "env.node".
  */
-export interface EnvNodeOptions extends EnvBaseOptions {
+export interface EnvNodeOptions extends EnvRestrictedOptions {
     /**
      * The module mode used by the linted files. Default value is "module".
      */
     sourceType?: LanguageOptions["sourceType"];
-    /**
-     * All globals, imports, properties, and syntax constructs to be banned for
-     * the files included by the environment.
-     */
-    restricted?: EnvRestrictedOptions;
 }
 /**
  * Creates configuration objects with global symbols and linter rules for
@@ -21,10 +16,10 @@ export interface EnvNodeOptions extends EnvBaseOptions {
  * Wraps the following packages:
  * - `eslint-plugin-n`
  *
- * @param options
+ * @param envOptions
  *  Configuration options for the environment.
  *
  * @returns
  *  An array of configuration objects to be added to the flat configuration.
  */
-export default function node(options: EnvNodeOptions): TSESLint.FlatConfig.ConfigArray;
+export default function node(envOptions: EnvNodeOptions): TSESLint.FlatConfig.ConfigArray;

package/dist/eslint/env/node.js

@@ -1,5 +1,5 @@
 import nodePlugin from "eslint-plugin-n";
-import { generateRestrictedRules } from "../shared/env-utils.js";
+import { concatConfigs, createConfig, restrictedRules, customRules } from "../shared/env-utils.js";
 // functions ==================================================================
 /**
  * Creates configuration objects with global symbols and linter rules for
@@ -8,44 +8,30 @@ import { generateRestrictedRules } from "../shared/env-utils.js";
  * Wraps the following packages:
  * - `eslint-plugin-n`
  *
- * @param options
+ * @param envOptions
  *  Configuration options for the environment.
  *
  * @returns
  *  An array of configuration objects to be added to the flat configuration.
  */
-export default function node(options) {
-    // configuration properties
-    const { files, ignores = [], sourceType = "module", rules } = options;
-    // the plugin configuration
-    const configKey = (sourceType === "commonjs") ? "flat/recommended-script" : "flat/recommended-module";
-    const nodeConfig = nodePlugin.configs[configKey];
-    // generate the "no-restricted-?" rules according to passed configuration
-    const restricted = generateRestrictedRules({}, options?.restricted);
-    return [
-        // register rule implementations
-        {
-            files,
-            ignores,
-            ...nodeConfig,
-            settings: {
-                node: {
-                    tryExtensions: [".js", ".ts", ".d.ts"], // automatically add missing extensions in imports
-                },
-            },
-        },
-        // reconfigure plugin rules
-        {
-            files,
-            ignores,
-            rules: {
-                "n/no-unsupported-features/node-builtins": ["error", { allowExperimental: true }],
-                "n/prefer-node-protocol": "error",
-                ...restricted.rules,
-                ...rules,
+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 concatConfigs(
+    // register rule implementations
+    createConfig(envOptions, {
+        ...nodePlugin.configs[configKey],
+        settings: {
+            node: {
+                tryExtensions: [".js", ".ts", ".d.ts"], // automatically add missing extensions in imports
             },
         },
-        // "no-restricted-?" rules overrides for specific files
-        ...restricted.overrides,
-    ];
+    }), 
+    // generate the "no-restricted-?" rules according to passed configuration
+    restrictedRules(envOptions), 
+    // custom rules
+    customRules(envOptions, {
+        "n/no-unsupported-features/node-builtins": ["error", { allowExperimental: true }],
+        "n/prefer-node-protocol": "error",
+    }));
 }

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

@@ -4,15 +4,19 @@ import { type RuleNoInvalidModulesOptions } from "../rules/no-invalid-modules.js
 /**
  * Configuration options for the environment preset "env.project".
  */
-export interface EnvProjectOptions extends EnvBaseOptions, RuleNoInvalidModulesOptions {
+export interface EnvProjectOptions extends EnvBaseOptions {
+    /**
+     * Options to be passed to the rule "env-project/no-invalid-modules".
+     */
+    modules?: RuleNoInvalidModulesOptions;
 }
 /**
  * Adds custom linter rules for checking project setup and module hierarchy.
  *
- * @param options
+ * @param envOptions
  *  Configuration options for the environment.
  *
  * @returns
  *  An array of configuration objects to be added to the flat configuration.
  */
-export default function project(options: EnvProjectOptions): TSESLint.FlatConfig.ConfigArray;
+export default function project(envOptions: EnvProjectOptions): TSESLint.FlatConfig.ConfigArray;

package/dist/eslint/env/project.js

@@ -1,35 +1,32 @@
+import { concatConfigs, createConfig, customRules } from "../shared/env-utils.js";
 import noAmdModuleDirective from "../rules/no-amd-module-directive.js";
 import noInvalidModules from "../rules/no-invalid-modules.js";
 // exports ====================================================================
 /**
  * Adds custom linter rules for checking project setup and module hierarchy.
  *
- * @param options
+ * @param envOptions
  *  Configuration options for the environment.
  *
  * @returns
  *  An array of configuration objects to be added to the flat configuration.
  */
-export default function project(options) {
-    // configuration properties
-    const { files, ignores = [], rules, ...rest } = options;
-    return [{
-            files,
-            ignores,
-            // register rule implementations
-            plugins: {
-                "env-project": {
-                    rules: {
-                        "no-amd-module-directive": noAmdModuleDirective,
-                        "no-invalid-modules": noInvalidModules,
-                    },
+export default function project(envOptions) {
+    return concatConfigs(
+    // register rule implementations
+    createConfig(envOptions, {
+        plugins: {
+            "env-project": {
+                rules: {
+                    "no-amd-module-directive": noAmdModuleDirective,
+                    "no-invalid-modules": noInvalidModules,
                 },
             },
-            // configure rules
-            rules: {
-                "env-project/no-amd-module-directive": "error",
-                "env-project/no-invalid-modules": ["error", rest],
-                ...rules,
-            },
-        }];
+        },
+    }), 
+    // custom rules
+    customRules(envOptions, {
+        "env-project/no-amd-module-directive": "error",
+        "env-project/no-invalid-modules": ["error", envOptions.modules ?? {}],
+    }));
 }

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

@@ -20,10 +20,10 @@ export interface EnvReactOptions extends EnvBaseOptions {
  * - `eslint-plugin-jsx-expressions`
  * - `eslint-plugin-jsx-a11y`
  *
- * @param options
+ * @param envOptions
  *  Configuration options for the environment.
  *
  * @returns
  *  An array of configuration objects to be added to the flat configuration.
  */
-export default function react(options: EnvReactOptions): TSESLint.FlatConfig.ConfigArray;
+export default function react(envOptions: EnvReactOptions): TSESLint.FlatConfig.ConfigArray;