@open-xchange/linter-presets 1.6.1 → 1.7.0

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## `1.7.0` – 2025-Jul-17
+
+- added: (ESLint and StyleLint) mandatory option `root`
+- added: (ESLint) configuration entries can be callback functions receiving a path resolver
+- changed: (ESLint and StyleLint) option `license` can be a relative path
+- removed: (ESLint and StyleLint) `createResolver` function
+- fixed: (ESLint) set `tsconfigRootDir` for TypeScript plugin to fix errors in VS Code
+- chore: bump dependencies
+
 ## `1.6.1` – 2025-Jul-16
 
 - removed: (ESLint) deprecated rule `@stylistic/jsx-indent`
@@ -9,7 +18,7 @@
 - changed: dedicated package exports `/eslint` and `/stylelint`
 - changed: (ESLint) replaced `configure` function with `defineConfig` function
 - changed: (StyleLint) replaced `configure` function with `defineConfig` function
-- changed: replaced `resolver` function with `createResolver` function (exported from both sub packages)
+- changed: (ESLint and StyleLint) replaced `resolver` function with `createResolver` function
 - added: (ESLint) new plugin `eslint-plugin-regexp`
 - added: (ESLint) disable `no-duplicate-imports` rule in `.d.ts` files
 - chore: bump dependencies

package/dist/eslint/core/base.d.ts

@@ -1,5 +1,4 @@
-import type { Linter } from "eslint";
-import { type LanguageConfig } from "../shared/env-utils.js";
+import type { ConfigWithExtendsArg, LanguageConfig } from "../shared/env-utils.js";
 /**
  * Defines standard module settings and additional rules targeting JavaScript
  * _and_ TypeScript source files.
@@ -11,6 +10,6 @@ import { type LanguageConfig } from "../shared/env-utils.js";
  *  Resolved configuration options.
  *
  * @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 base(languageConfig: LanguageConfig): Linter.Config[];
+export default function base(languageConfig: LanguageConfig): ConfigWithExtendsArg;

package/dist/eslint/core/base.js

@@ -1,5 +1,5 @@
 import eslintJs from "@eslint/js";
-import { SRC_GLOB, VUE_GLOB, NO_IMPLICIT_COERCION_OPTIONS, extGlob, createConfigArray } from "../shared/env-utils.js";
+import { SRC_GLOB, VUE_GLOB, NO_IMPLICIT_COERCION_OPTIONS, extGlob } from "../shared/env-utils.js";
 import { builtinRestrictedRules } from "../shared/restricted.js";
 // functions ==================================================================
 /**
@@ -13,7 +13,7 @@ import { builtinRestrictedRules } from "../shared/restricted.js";
  *  Resolved configuration options.
  *
  * @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 base(languageConfig) {
     // returns language options for specific file extensions
@@ -25,98 +25,99 @@ export default function base(languageConfig) {
             languageOptions: { ecmaVersion, sourceType },
         };
     };
-    return createConfigArray(
-    // global linter configuration
-    {
-        name: "base:linter-options",
-        linterOptions: {
-            // report unused inline linter directives in source code
-            reportUnusedDisableDirectives: "error",
+    return [
+        // global linter configuration
+        {
+            name: "base:linter-options",
+            linterOptions: {
+                // report unused inline linter directives in source code
+                reportUnusedDisableDirectives: "error",
+            },
         },
-    }, 
-    // ECMA version and module type for ES modules
-    languageOptions("module", "mjs", "mts"), 
-    // ECMA version and module type for CommonJS modules
-    languageOptions("commonjs", "cjs", "cts"), 
-    // ECMA version and module type for *.js and *.ts files
-    languageOptions(languageConfig.sourceType, "js", "jsx", "ts", "tsx"), 
-    // configure linter rules
-    {
-        name: "base:rules",
-        files: [...SRC_GLOB, ...VUE_GLOB],
-        rules: {
-            // enable all rules recommended by ESLint itself
-            ...eslintJs.configs.recommended.rules,
-            // possible problems
-            "no-cond-assign": ["error", "except-parens"],
-            "no-constant-binary-expression": "error",
-            "no-constructor-return": "error",
-            "no-control-regex": "off",
-            "no-duplicate-imports": ["error", { allowSeparateTypeImports: true }],
-            "no-new-native-nonconstructor": "error",
-            "no-new-symbol": "off", // disabled in favour of "no-new-native-nonconstructor"
-            "no-promise-executor-return": ["error", { allowVoid: true }],
-            "no-self-compare": "error",
-            "no-template-curly-in-string": "error",
-            "no-unassigned-vars": "error",
-            "no-unreachable-loop": "error",
-            "no-unsafe-optional-chaining": ["error", { disallowArithmeticOperators: true }],
-            "no-unused-private-class-members": "error",
-            "require-atomic-updates": "error",
-            // suggestions
-            "block-scoped-var": "error",
-            curly: "error",
-            eqeqeq: "error",
-            "grouped-accessor-pairs": "error",
-            "new-cap": "error",
-            "no-alert": "error",
-            "no-caller": "error",
-            "no-console": "error",
-            "no-else-return": "error",
-            "no-empty": "off",
-            "no-empty-static-block": "error",
-            "no-eval": "error",
-            "no-extend-native": "error",
-            "no-extra-bind": "error",
-            "no-extra-label": "error",
-            "no-implicit-coercion": ["error", NO_IMPLICIT_COERCION_OPTIONS],
-            "no-implied-eval": "error",
-            "no-iterator": "error",
-            "no-label-var": "error",
-            "no-labels": "error",
-            "no-lone-blocks": "error",
-            "no-lonely-if": "error",
-            "no-multi-str": "error",
-            "no-new": "error",
-            "no-new-func": "error",
-            "no-new-wrappers": "error",
-            "no-object-constructor": "error",
-            "no-octal-escape": "error",
-            "no-proto": "error",
-            "no-return-assign": ["error", "except-parens"],
-            "no-script-url": "error",
-            "no-sequences": ["error", { allowInParentheses: false }],
-            "no-unneeded-ternary": ["error", { defaultAssignment: false }],
-            "no-unused-expressions": "error",
-            "no-useless-assignment": "error",
-            "no-useless-call": "error",
-            "no-useless-computed-key": "error",
-            "no-useless-concat": "error",
-            "no-useless-rename": "error",
-            "no-useless-return": "error",
-            "no-var": "error",
-            "object-shorthand": "error",
-            "operator-assignment": "error",
-            "prefer-arrow-callback": "error",
-            "prefer-const": ["error", { destructuring: "all", ignoreReadBeforeAssign: true }],
-            "prefer-numeric-literals": "error",
-            "prefer-regex-literals": "error",
-            "prefer-rest-params": "error",
-            "prefer-spread": "error",
-            radix: "error",
-            "symbol-description": "error",
-            // built-in restricted items
-            ...builtinRestrictedRules(),
+        // ECMA version and module type for ES modules
+        languageOptions("module", "mjs", "mts"),
+        // ECMA version and module type for CommonJS modules
+        languageOptions("commonjs", "cjs", "cts"),
+        // ECMA version and module type for *.js and *.ts files
+        languageOptions(languageConfig.sourceType, "js", "jsx", "ts", "tsx"),
+        // configure linter rules
+        {
+            name: "base:rules",
+            files: [...SRC_GLOB, ...VUE_GLOB],
+            rules: {
+                // enable all rules recommended by ESLint itself
+                ...eslintJs.configs.recommended.rules,
+                // possible problems
+                "no-cond-assign": ["error", "except-parens"],
+                "no-constant-binary-expression": "error",
+                "no-constructor-return": "error",
+                "no-control-regex": "off",
+                "no-duplicate-imports": ["error", { allowSeparateTypeImports: true }],
+                "no-new-native-nonconstructor": "error",
+                "no-new-symbol": "off", // disabled in favour of "no-new-native-nonconstructor"
+                "no-promise-executor-return": ["error", { allowVoid: true }],
+                "no-self-compare": "error",
+                "no-template-curly-in-string": "error",
+                "no-unassigned-vars": "error",
+                "no-unreachable-loop": "error",
+                "no-unsafe-optional-chaining": ["error", { disallowArithmeticOperators: true }],
+                "no-unused-private-class-members": "error",
+                "require-atomic-updates": "error",
+                // suggestions
+                "block-scoped-var": "error",
+                curly: "error",
+                eqeqeq: "error",
+                "grouped-accessor-pairs": "error",
+                "new-cap": "error",
+                "no-alert": "error",
+                "no-caller": "error",
+                "no-console": "error",
+                "no-else-return": "error",
+                "no-empty": "off",
+                "no-empty-static-block": "error",
+                "no-eval": "error",
+                "no-extend-native": "error",
+                "no-extra-bind": "error",
+                "no-extra-label": "error",
+                "no-implicit-coercion": ["error", NO_IMPLICIT_COERCION_OPTIONS],
+                "no-implied-eval": "error",
+                "no-iterator": "error",
+                "no-label-var": "error",
+                "no-labels": "error",
+                "no-lone-blocks": "error",
+                "no-lonely-if": "error",
+                "no-multi-str": "error",
+                "no-new": "error",
+                "no-new-func": "error",
+                "no-new-wrappers": "error",
+                "no-object-constructor": "error",
+                "no-octal-escape": "error",
+                "no-proto": "error",
+                "no-return-assign": ["error", "except-parens"],
+                "no-script-url": "error",
+                "no-sequences": ["error", { allowInParentheses: false }],
+                "no-unneeded-ternary": ["error", { defaultAssignment: false }],
+                "no-unused-expressions": "error",
+                "no-useless-assignment": "error",
+                "no-useless-call": "error",
+                "no-useless-computed-key": "error",
+                "no-useless-concat": "error",
+                "no-useless-rename": "error",
+                "no-useless-return": "error",
+                "no-var": "error",
+                "object-shorthand": "error",
+                "operator-assignment": "error",
+                "prefer-arrow-callback": "error",
+                "prefer-const": ["error", { destructuring: "all", ignoreReadBeforeAssign: true }],
+                "prefer-numeric-literals": "error",
+                "prefer-regex-literals": "error",
+                "prefer-rest-params": "error",
+                "prefer-spread": "error",
+                radix: "error",
+                "symbol-description": "error",
+                // built-in restricted items
+                ...builtinRestrictedRules(),
+            },
         },
-    });
+    ];
 }

package/dist/eslint/core/directives.d.ts

@@ -1,4 +1,4 @@
-import type { Linter } from "eslint";
+import { type ConfigWithExtendsArg } from "../shared/env-utils.js";
 /**
  * Checks inline linter directives.
  *
@@ -6,6 +6,6 @@ import type { Linter } from "eslint";
  * - `eslint-plugin-eslint-comments`
  *
  * @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 directives(): Linter.Config[];
+export default function directives(): ConfigWithExtendsArg;

package/dist/eslint/core/directives.js

@@ -1,5 +1,5 @@
 import commentsPluginConfigs from "@eslint-community/eslint-plugin-eslint-comments/configs";
-import { SRC_GLOB, VUE_GLOB, createConfigArray } from "../shared/env-utils.js";
+import { SRC_GLOB, VUE_GLOB } from "../shared/env-utils.js";
 // functions ==================================================================
 /**
  * Checks inline linter directives.
@@ -8,13 +8,13 @@ import { SRC_GLOB, VUE_GLOB, createConfigArray } from "../shared/env-utils.js";
  * - `eslint-plugin-eslint-comments`
  *
  * @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 directives() {
     // register rule implementations and recommended rules
-    return createConfigArray({
+    return {
         name: "directives:recommended",
         files: [...SRC_GLOB, ...VUE_GLOB],
         ...commentsPluginConfigs.recommended,
-    });
+    };
 }

package/dist/eslint/core/js.d.ts

@@ -1,9 +1,9 @@
-import type { Linter } from "eslint";
+import { type ConfigWithExtendsArg } from "../shared/env-utils.js";
 /**
  * Defines additional standard rules targeting JavaScript but _not_ TypeScript
  * source files.
  *
  * @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 js(): Linter.Config[];
+export default function js(): ConfigWithExtendsArg;

package/dist/eslint/core/js.js

@@ -1,14 +1,14 @@
-import { JS_GLOB, NO_UNUSED_VARS_OPTIONS, createConfigArray } from "../shared/env-utils.js";
+import { JS_GLOB, NO_UNUSED_VARS_OPTIONS } from "../shared/env-utils.js";
 // functions ==================================================================
 /**
  * Defines additional standard rules targeting JavaScript but _not_ TypeScript
  * source files.
  *
  * @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 js() {
-    return createConfigArray({
+    return {
         name: "js:recommended",
         files: JS_GLOB,
         rules: {
@@ -28,5 +28,5 @@ export default function js() {
             "prefer-promise-reject-errors": "error",
             "require-await": "error",
         },
-    });
+    };
 }

package/dist/eslint/core/jsdoc.d.ts

@@ -1,4 +1,4 @@
-import type { Linter } from "eslint";
+import { type ConfigWithExtendsArg } from "../shared/env-utils.js";
 /**
  * Checks the JSDoc comments in source files.
  *
@@ -6,6 +6,6 @@ import type { Linter } from "eslint";
  * - `eslint-plugin-jsdoc`
  *
  * @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 jsdoc(): Linter.Config[];
+export default function jsdoc(): ConfigWithExtendsArg;

package/dist/eslint/core/jsdoc.js

@@ -1,5 +1,5 @@
 import jsdocPlugin from "eslint-plugin-jsdoc";
-import { TS_GLOB, SRC_GLOB, createConfigArray } from "../shared/env-utils.js";
+import { TS_GLOB, SRC_GLOB } from "../shared/env-utils.js";
 // functions ==================================================================
 /**
  * Checks the JSDoc comments in source files.
@@ -8,52 +8,53 @@ import { TS_GLOB, SRC_GLOB, createConfigArray } from "../shared/env-utils.js";
  * - `eslint-plugin-jsdoc`
  *
  * @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 jsdoc() {
-    return createConfigArray(
-    // register rule implementations and recommended rules
-    {
-        name: "jsdoc:recommended",
-        files: SRC_GLOB,
-        ...jsdocPlugin.configs["flat/recommended-error"],
-    }, 
-    // general configuration
-    {
-        name: "jsdoc:settings",
-        settings: {
-            jsdoc: {
-                tagNamePreference: {
-                    // disallowed tags for ES6 keywords `const`, `class`, `extends`
-                    augments: false,
-                    class: false,
-                    const: false,
-                    constant: false,
-                    constructor: false,
-                    extends: false,
+    return [
+        // register rule implementations and recommended rules
+        {
+            name: "jsdoc:recommended",
+            files: SRC_GLOB,
+            ...jsdocPlugin.configs["flat/recommended-error"],
+        },
+        // general configuration
+        {
+            name: "jsdoc:settings",
+            settings: {
+                jsdoc: {
+                    tagNamePreference: {
+                        // disallowed tags for ES6 keywords `const`, `class`, `extends`
+                        augments: false,
+                        class: false,
+                        const: false,
+                        constant: false,
+                        constructor: false,
+                        extends: false,
+                    },
                 },
             },
         },
-    }, 
-    // overrides for TypeScript files
-    {
-        name: "jsdoc:typescript",
-        files: TS_GLOB,
-        rules: {
-            ...jsdocPlugin.configs["flat/recommended-typescript-error"].rules,
-            "jsdoc/check-param-names": ["error", { allowExtraTrailingParamDocs: true }], // overload signatures
+        // overrides for TypeScript files
+        {
+            name: "jsdoc:typescript",
+            files: TS_GLOB,
+            rules: {
+                ...jsdocPlugin.configs["flat/recommended-typescript-error"].rules,
+                "jsdoc/check-param-names": ["error", { allowExtraTrailingParamDocs: true }], // overload signatures
+            },
         },
-    }, 
-    // configure plugin rules
-    {
-        name: "jsdoc:rules",
-        files: SRC_GLOB,
-        rules: {
-            "jsdoc/check-template-names": "error",
-            "jsdoc/require-asterisk-prefix": "error",
-            "jsdoc/require-template": ["error", { requireSeparateTemplates: true }],
-            "jsdoc/require-throws": "error",
-            "jsdoc/tag-lines": "off",
+        // configure plugin rules
+        {
+            name: "jsdoc:rules",
+            files: SRC_GLOB,
+            rules: {
+                "jsdoc/check-template-names": "error",
+                "jsdoc/require-asterisk-prefix": "error",
+                "jsdoc/require-template": ["error", { requireSeparateTemplates: true }],
+                "jsdoc/require-throws": "error",
+                "jsdoc/tag-lines": "off",
+            },
         },
-    });
+    ];
 }

package/dist/eslint/core/json.d.ts

@@ -1,5 +1,4 @@
-import type { Linter } from "eslint";
-import { type StylisticConfig } from "../shared/env-utils.js";
+import type { ConfigWithExtendsArg, StylisticConfig } from "../shared/env-utils.js";
 /**
  * Defines standard linting rules for JSON files.
  *
@@ -10,6 +9,6 @@ import { type StylisticConfig } from "../shared/env-utils.js";
  *  Resolved configuration options.
  *
  * @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 json(stylisticConfig: StylisticConfig): Linter.Config[];
+export default function json(stylisticConfig: StylisticConfig): ConfigWithExtendsArg;

package/dist/eslint/core/json.js

@@ -1,5 +1,5 @@
 import jsonPlugin from "eslint-plugin-jsonc";
-import { createConfigArray, fixMissingFilesOption } from "../shared/env-utils.js";
+import { fixMissingFilesOption } from "../shared/env-utils.js";
 // functions ==================================================================
 /**
  * Defines standard linting rules for JSON files.
@@ -11,11 +11,11 @@ import { createConfigArray, fixMissingFilesOption } from "../shared/env-utils.js
  *  Resolved configuration options.
  *
  * @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 json(stylisticConfig) {
     // add missing "files" property in configurations with rules (otherwise, plugin conflicts with "@eslint/markdown")
-    return fixMissingFilesOption(createConfigArray(
+    return fixMissingFilesOption(
     // register rule implementations and recommended rules
     jsonPlugin.configs["flat/recommended-with-json"], 
     // reconfigure plugin rules
@@ -35,5 +35,5 @@ export default function json(stylisticConfig) {
         rules: {
             "jsonc/no-comments": "off",
         },
-    }));
+    });
 }

package/dist/eslint/core/license.d.ts

@@ -1,4 +1,4 @@
-import type { Linter } from "eslint";
+import { type ConfigWithExtendsArg } from "../shared/env-utils.js";
 /**
  * Checks the existence of license headers in source files.
  *
@@ -6,9 +6,9 @@ import type { Linter } from "eslint";
  * - `eslint-plugin-license-header`
  *
  * @param path
- *  Path to the template file containing the license header.
+ *  Absolute path to the template file containing the license header.
  *
  * @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 license(path: string): Linter.Config[];
+export default function license(path: string): ConfigWithExtendsArg;

package/dist/eslint/core/license.js

@@ -1,5 +1,5 @@
 import licensePlugin from "eslint-plugin-license-header";
-import { SRC_GLOB, createConfigArray } from "../shared/env-utils.js";
+import { SRC_GLOB } from "../shared/env-utils.js";
 // functions ==================================================================
 /**
  * Checks the existence of license headers in source files.
@@ -8,13 +8,13 @@ import { SRC_GLOB, createConfigArray } from "../shared/env-utils.js";
  * - `eslint-plugin-license-header`
  *
  * @param path
- *  Path to the template file containing the license header.
+ *  Absolute path to the template file containing the license header.
  *
  * @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 license(path) {
-    return createConfigArray({
+    return {
         name: "license:recommended",
         files: SRC_GLOB,
         // register rule implementations of the plugin
@@ -25,5 +25,5 @@ export default function license(path) {
         rules: {
             "license-header/header": ["error", path],
         },
-    });
+    };
 }

package/dist/eslint/core/markdown.d.ts

@@ -6,6 +6,6 @@ import type { Linter } from "eslint";
  * - `@eslint/markdown`
  *
  * @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 markdown(): Linter.Config[];

package/dist/eslint/core/markdown.js

@@ -7,7 +7,7 @@ import markdownPlugin from "@eslint/markdown";
  * - `@eslint/markdown`
  *
  * @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 markdown() {
     return markdownPlugin.configs.recommended;

package/dist/eslint/core/packages.d.ts

@@ -1,5 +1,4 @@
-import type { Linter } from "eslint";
-import { type PackagesConfig } from "../shared/env-utils.js";
+import type { ConfigWithExtendsArg, PackagesConfig } from "../shared/env-utils.js";
 /**
  * Defines linting rules for outdated or unneeded external dependencies.
  *
@@ -10,6 +9,6 @@ import { type PackagesConfig } from "../shared/env-utils.js";
  *  Resolved configuration options.
  *
  * @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 packages(packagesConfig: PackagesConfig): Linter.Config[];
+export default function packages(packagesConfig: PackagesConfig): ConfigWithExtendsArg;

package/dist/eslint/core/packages.js

@@ -1,5 +1,4 @@
 import * as dependPlugin from "eslint-plugin-depend";
-import { createConfigArray } from "../shared/env-utils.js";
 // functions ==================================================================
 /**
  * Defines linting rules for outdated or unneeded external dependencies.
@@ -11,21 +10,23 @@ import { createConfigArray } from "../shared/env-utils.js";
  *  Resolved configuration options.
  *
  * @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 packages(packagesConfig) {
-    return createConfigArray(
-    // register rule implementations and recommended rules
-    {
-        name: "packages:recommended",
-        ...dependPlugin.configs["flat/recommended"],
-    }, {
-        name: "packages:rules",
-        rules: {
-            "depend/ban-dependencies": ["error", {
-                    modules: packagesConfig.banned,
-                    allowed: packagesConfig.allowed,
-                }],
+    return [
+        // register rule implementations and recommended rules
+        {
+            name: "packages:recommended",
+            ...dependPlugin.configs["flat/recommended"],
         },
-    });
+        {
+            name: "packages:rules",
+            rules: {
+                "depend/ban-dependencies": ["error", {
+                        modules: packagesConfig.banned,
+                        allowed: packagesConfig.allowed,
+                    }],
+            },
+        },
+    ];
 }