@open-xchange/linter-presets 1.5.1 → 1.6.0

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## `1.6.0` – 2025-Jul-16
+
+- 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)
+- added: (ESLint) new plugin `eslint-plugin-regexp`
+- added: (ESLint) disable `no-duplicate-imports` rule in `.d.ts` files
+- chore: bump dependencies
+
 ## `1.5.1` – 2025-Jul-03
 
 - chore: bump dependencies

package/README.md

@@ -4,49 +4,43 @@ This package provides configuration presets for [ESLint](https://eslint.org/) an
 
 ## ESLint
 
-The module `eslint` exports a `configure` function for setting up the entire project (e.g. TypeScript files, JSON files, license headers, etc.), and a set of environment presets that apply more ESLint plugins and rules to a specific subset of the project (e.g. browser code, unit test code, etc.).
+The module `eslint` exports a `defineConfig` function for setting up the entire project (e.g. TypeScript files, JSON files, license headers, etc.), and a set of environment presets that apply more ESLint plugins and rules to a specific subset of the project (e.g. browser code, unit test code, etc.).
 
 Usage example:
 
-```js
-// eslint.config.js
-import { eslint } from "@open-xchange/linter-presets"
+```ts
+// eslint.config.ts
+import { defineConfig, env } from "@open-xchange/linter-presets/eslint";
 
-export default [
+export default defineConfig(
 
-  // global project configuration
-  ...eslint.configure({ /* config options */ }),
+  // required parameter: global project configuration
+  { /* config options */ },
 
   // add environments
-  ...eslint.env.browser({ files: ["src/**/*.js"], /* ... */ }),
-  ...eslint.env.vitest({ files: ["test/**/*.js"], /* ... */ }),
+  env.browser({ files: ["src/**/*.js"], /* ... */ }),
+  env.vitest({ files: ["test/**/*.js"], /* ... */ }),
 
   // add custom configurations
   { /* ... */ },
-]
+);
 ```
 
-See the [`eslint` module documentation](./doc/eslint/README.md) for more details.
+See the [`eslint` module documentation](./docs/eslint/README.md) for more details.
 
 ## StyleLint
 
-The module `stylelint` exports a `configure` function for setting up the entire project (e.g. CSS files, SCSS files, license headers, etc.).
+The module `stylelint` exports a `defineConfig` function for setting up the entire project (e.g. CSS files, SCSS files, license headers, etc.).
 
 Usage example:
 
-```js
+```ts
 // stylelint.config.js
-import { stylelint } from "@open-xchange/linter-presets"
+import { defineConfig } from "@open-xchange/linter-presets/stylelint";
 
-export default stylelint.configure({
+export default defineConfig({
   /* config options */
-})
+});
 ```
 
-See the [`stylelint` module documentation](./doc/stylelint/README.md) for more details.
-
-## Utils
-
-The module `utils` exports utility functions to be used in ESLint and StyleLint configuration files.
-
-See the [`utils` module documentation](./doc/utils/README.md) for more details.
+See the [`stylelint` module documentation](./docs/stylelint/README.md) for more details.

package/dist/eslint/core/base.js

@@ -0,0 +1,122 @@
+import eslintJs from "@eslint/js";
+import { SRC_GLOB, VUE_GLOB, NO_IMPLICIT_COERCION_OPTIONS, extGlob, createConfigArray } from "../shared/env-utils.js";
+import { builtinRestrictedRules } from "../shared/restricted.js";
+// functions ==================================================================
+/**
+ * Defines standard module settings and additional rules targeting JavaScript
+ * _and_ TypeScript source files.
+ *
+ * Wraps the following packages:
+ * - `@eslint/js`
+ *
+ * @param languageConfig
+ *  Resolved configuration options.
+ *
+ * @returns
+ *  An array of configuration objects to be added to the flat configuration.
+ */
+export default function base(languageConfig) {
+    // returns language options for specific file extensions
+    const languageOptions = (sourceType, ...extensions) => {
+        const { ecmaVersion } = languageConfig;
+        return {
+            name: `base:language-options:${sourceType}:${extensions.join(",")}`,
+            files: extGlob(extensions),
+            languageOptions: { ecmaVersion, sourceType },
+        };
+    };
+    return createConfigArray(
+    // 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(),
+        },
+    });
+}

package/dist/eslint/{config → core}/directives.js

@@ -1,5 +1,5 @@
 import commentsPluginConfigs from "@eslint-community/eslint-plugin-eslint-comments/configs";
-import { SRC_GLOB, VUE_GLOB } from "../shared/env-utils.js";
+import { SRC_GLOB, VUE_GLOB, createConfigArray } from "../shared/env-utils.js";
 // functions ==================================================================
 /**
  * Checks inline linter directives.
@@ -12,8 +12,9 @@ import { SRC_GLOB, VUE_GLOB } from "../shared/env-utils.js";
  */
 export default function directives() {
     // register rule implementations and recommended rules
-    return [{
-            files: [...SRC_GLOB, ...VUE_GLOB],
-            ...commentsPluginConfigs.recommended,
-        }];
+    return createConfigArray({
+        name: "directives:recommended",
+        files: [...SRC_GLOB, ...VUE_GLOB],
+        ...commentsPluginConfigs.recommended,
+    });
 }

package/dist/eslint/core/js.js

@@ -0,0 +1,32 @@
+import { JS_GLOB, NO_UNUSED_VARS_OPTIONS, createConfigArray } 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.
+ */
+export default function js() {
+    return createConfigArray({
+        name: "js:recommended",
+        files: JS_GLOB,
+        rules: {
+            // possible problems
+            "no-loss-of-precision": "off",
+            "no-unused-vars": ["error", NO_UNUSED_VARS_OPTIONS],
+            // suggestions
+            "default-param-last": "error",
+            "dot-notation": "error",
+            "no-array-constructor": "error",
+            "no-invalid-this": "error",
+            "no-loop-func": "error",
+            "no-redeclare": "error",
+            "no-shadow": ["error", { ignoreOnInitialization: true }],
+            "no-throw-literal": "error",
+            "no-useless-constructor": "error",
+            "prefer-promise-reject-errors": "error",
+            "require-await": "error",
+        },
+    });
+}

package/dist/eslint/core/jsdoc.js

@@ -0,0 +1,59 @@
+import jsdocPlugin from "eslint-plugin-jsdoc";
+import { TS_GLOB, SRC_GLOB, createConfigArray } from "../shared/env-utils.js";
+// functions ==================================================================
+/**
+ * Checks the JSDoc comments in source files.
+ *
+ * Wraps the following packages:
+ * - `eslint-plugin-jsdoc`
+ *
+ * @returns
+ *  An array of configuration objects to be added to the flat configuration.
+ */
+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,
+                },
+            },
+        },
+    }, 
+    // 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",
+        },
+    });
+}

package/dist/eslint/core/json.js

@@ -0,0 +1,39 @@
+import jsonPlugin from "eslint-plugin-jsonc";
+import { createConfigArray, fixMissingFilesOption } from "../shared/env-utils.js";
+// functions ==================================================================
+/**
+ * Defines standard linting rules for JSON files.
+ *
+ * Wraps the following packages:
+ * - `eslint-plugin-jsonc`
+ *
+ * @param stylisticConfig
+ *  Resolved configuration options.
+ *
+ * @returns
+ *  An array of configuration objects to be added to the flat configuration.
+ */
+export default function json(stylisticConfig) {
+    // add missing "files" property in configurations with rules (otherwise, plugin conflicts with "@eslint/markdown")
+    return fixMissingFilesOption(createConfigArray(
+    // register rule implementations and recommended rules
+    jsonPlugin.configs["flat/recommended-with-json"], 
+    // reconfigure plugin rules
+    {
+        name: "json:rules",
+        rules: {
+            "jsonc/array-bracket-spacing": "error",
+            "jsonc/comma-style": "error",
+            "jsonc/indent": ["error", stylisticConfig.indent.json],
+            "jsonc/key-spacing": ["error", { mode: "minimum" }],
+            "jsonc/no-irregular-whitespace": "error",
+            "jsonc/no-octal-escape": "error",
+        },
+    }, {
+        name: "json:tsconfig",
+        files: ["**/tsconfig.json", "**/tsconfig.*.json"],
+        rules: {
+            "jsonc/no-comments": "off",
+        },
+    }));
+}

package/dist/eslint/{config → core}/license.js

@@ -1,5 +1,5 @@
 import licensePlugin from "eslint-plugin-license-header";
-import { SRC_GLOB } from "../shared/env-utils.js";
+import { SRC_GLOB, createConfigArray } from "../shared/env-utils.js";
 // functions ==================================================================
 /**
  * Checks the existence of license headers in source files.
@@ -14,15 +14,16 @@ import { SRC_GLOB } from "../shared/env-utils.js";
  *  An array of configuration objects to be added to the flat configuration.
  */
 export default function license(path) {
-    return [{
-            files: SRC_GLOB,
-            // register rule implementations of the plugin
-            plugins: {
-                "license-header": licensePlugin,
-            },
-            // configure plugin rules
-            rules: {
-                "license-header/header": ["error", path],
-            },
-        }];
+    return createConfigArray({
+        name: "license:recommended",
+        files: SRC_GLOB,
+        // register rule implementations of the plugin
+        plugins: {
+            "license-header": licensePlugin,
+        },
+        // configure plugin rules
+        rules: {
+            "license-header/header": ["error", path],
+        },
+    });
 }

package/dist/eslint/{config → core}/packages.d.ts

@@ -1,5 +1,5 @@
 import type { Linter } from "eslint";
-import type { PackagesConfig } from "../shared/env-utils.js";
+import { type PackagesConfig } from "../shared/env-utils.js";
 /**
  * Defines linting rules for outdated or unneeded external dependencies.
  *

package/dist/eslint/{config → core}/packages.js

@@ -1,4 +1,5 @@
 import * as dependPlugin from "eslint-plugin-depend";
+import { createConfigArray } from "../shared/env-utils.js";
 // functions ==================================================================
 /**
  * Defines linting rules for outdated or unneeded external dependencies.
@@ -13,16 +14,18 @@ import * as dependPlugin from "eslint-plugin-depend";
  *  An array of configuration objects to be added to the flat configuration.
  */
 export default function packages(packagesConfig) {
-    return [
-        // register rule implementations and recommended rules
-        dependPlugin.configs["flat/recommended"],
-        {
-            rules: {
-                "depend/ban-dependencies": ["error", {
-                        modules: packagesConfig.banned,
-                        allowed: packagesConfig.allowed,
-                    }],
-            },
+    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,
+                }],
         },
-    ];
+    });
 }

package/dist/eslint/core/promises.js

@@ -0,0 +1,31 @@
+import promisePlugin from "eslint-plugin-promise";
+import { createConfigArray } from "../shared/env-utils.js";
+// functions ==================================================================
+/**
+ * Checks for correct usage of native promises.
+ *
+ * Wraps the following packages:
+ * - `eslint-plugin-promise`
+ *
+ * @returns
+ *  An array of configuration objects to be added to the flat configuration.
+ */
+export default function promises() {
+    return createConfigArray(
+    // register rule implementations and recommended rules
+    {
+        name: "promises:recommended",
+        ...promisePlugin.configs["flat/recommended"],
+    }, 
+    // reconfigure plugin rules
+    {
+        name: "promises:rules",
+        rules: {
+            "promise/always-return": ["error", { ignoreLastCallback: true }],
+            "promise/no-callback-in-promise": "off",
+            "promise/no-nesting": "error", // warning => error
+            "promise/no-return-in-finally": "error",
+            "promise/valid-params": "error", // warning => error
+        },
+    });
+}

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

@@ -0,0 +1,11 @@
+import type { Linter } from "eslint";
+/**
+ * Checks the regular expressions in source files.
+ *
+ * Wraps the following packages:
+ * - `eslint-plugin-regexp`
+ *
+ * @returns
+ *  An array of configuration objects to be added to the flat configuration.
+ */
+export default function regexp(): Linter.Config[];

package/dist/eslint/core/regexp.js

@@ -0,0 +1,21 @@
+import * as regexpPlugin from "eslint-plugin-regexp";
+import { SRC_GLOB, createConfigArray } from "../shared/env-utils.js";
+// functions ==================================================================
+/**
+ * Checks the regular expressions in source files.
+ *
+ * Wraps the following packages:
+ * - `eslint-plugin-regexp`
+ *
+ * @returns
+ *  An array of configuration objects to be added to the flat configuration.
+ */
+export default function regexp() {
+    return createConfigArray(
+    // register rule implementations and recommended rules
+    {
+        name: "regexp:recommended",
+        files: SRC_GLOB,
+        ...regexpPlugin.configs["flat/recommended"],
+    });
+}

package/dist/eslint/core/stylistic.js

@@ -0,0 +1,121 @@
+import stylisticPlugin from "@stylistic/eslint-plugin";
+import migratePlugin from "@stylistic/eslint-plugin-migrate";
+import { createConfigArray, getCommaDangleConfig } from "../shared/env-utils.js";
+// functions ==================================================================
+/**
+ * Defines standard (opinionated) linter rules for source code style.
+ *
+ * Wraps the following packages:
+ * - `@stylistic/eslint-plugin`
+ * - `@stylistic/eslint-plugin-migrate`
+ *
+ * @param stylisticConfig
+ *  Resolved configuration options.
+ *
+ * @returns
+ *  An array of configuration objects to be added to the flat configuration.
+ */
+export default function stylistic(stylisticConfig) {
+    // configuration properties
+    const { indent, semi, quotes } = stylisticConfig;
+    return createConfigArray(
+    // globally disable all deprecated stylistic core rules
+    {
+        name: "stylistic:disable-legacy",
+        ...stylisticPlugin.configs["disable-legacy"],
+    }, 
+    // "@stylistic" plugin
+    {
+        name: "stylistic:recommended",
+        // do not lint markdown files
+        ignores: ["**/*.md"],
+        // register rule implementations of the plugins
+        plugins: {
+            "@stylistic": stylisticPlugin,
+        },
+        // configure plugin rules
+        rules: {
+            "@stylistic/array-bracket-spacing": "error",
+            "@stylistic/arrow-spacing": "error",
+            "@stylistic/block-spacing": "error",
+            "@stylistic/brace-style": ["error", "1tbs", { allowSingleLine: true }],
+            "@stylistic/comma-dangle": getCommaDangleConfig(stylisticConfig),
+            "@stylistic/comma-spacing": "error",
+            "@stylistic/comma-style": "error",
+            "@stylistic/computed-property-spacing": "error",
+            "@stylistic/eol-last": "error",
+            "@stylistic/function-call-spacing": "error",
+            "@stylistic/generator-star-spacing": "error",
+            "@stylistic/indent": ["error", indent.js, { SwitchCase: 1, MemberExpression: "off", flatTernaryExpressions: true }],
+            "@stylistic/indent-binary-ops": ["error", indent.js],
+            "@stylistic/jsx-child-element-spacing": "error",
+            "@stylistic/jsx-curly-brace-presence": "error",
+            "@stylistic/jsx-curly-spacing": "error",
+            "@stylistic/jsx-equals-spacing": "error",
+            "@stylistic/jsx-function-call-newline": "error",
+            "@stylistic/jsx-indent": ["error", indent.js, { checkAttributes: true, indentLogicalExpressions: true }],
+            "@stylistic/jsx-indent-props": ["error", indent.js],
+            "@stylistic/jsx-one-expression-per-line": "off",
+            "@stylistic/jsx-pascal-case": "error",
+            "@stylistic/jsx-quotes": "error",
+            "@stylistic/jsx-self-closing-comp": "error",
+            "@stylistic/jsx-wrap-multilines": "error",
+            "@stylistic/key-spacing": ["error", { mode: "minimum" }],
+            "@stylistic/keyword-spacing": "error",
+            "@stylistic/linebreak-style": "error",
+            "@stylistic/member-delimiter-style": "error",
+            "@stylistic/new-parens": "error",
+            "@stylistic/no-extra-semi": "error",
+            "@stylistic/no-floating-decimal": "error",
+            "@stylistic/no-mixed-operators": ["error", {
+                    groups: [
+                        // allow to mix arithmetic operators
+                        // ["+", "-", "*", "/", "%", "**"],
+                        ["&", "|", "^", "~", "<<", ">>", ">>>"],
+                        ["==", "!=", "===", "!==", ">", ">=", "<", "<="],
+                        ["&&", "||"],
+                        ["in", "instanceof"],
+                    ],
+                    allowSamePrecedence: true,
+                }],
+            "@stylistic/no-multiple-empty-lines": ["error", { max: 2 }],
+            "@stylistic/no-tabs": "error",
+            "@stylistic/no-trailing-spaces": "error",
+            "@stylistic/no-whitespace-before-property": "error",
+            "@stylistic/object-curly-spacing": ["error", "always"],
+            "@stylistic/quote-props": ["error", "as-needed"],
+            "@stylistic/quotes": (quotes === "off") ? "off" : ["error", quotes, { avoidEscape: true }],
+            "@stylistic/rest-spread-spacing": "error",
+            "@stylistic/semi": (semi === "off") ? "off" : ["error", semi],
+            "@stylistic/semi-spacing": "error",
+            "@stylistic/semi-style": "error",
+            "@stylistic/space-before-blocks": "error",
+            "@stylistic/space-before-function-paren": ["error", { anonymous: "always", named: "never", asyncArrow: "always" }],
+            "@stylistic/space-in-parens": "error",
+            "@stylistic/space-infix-ops": "error",
+            "@stylistic/space-unary-ops": "error",
+            "@stylistic/switch-colon-spacing": "error",
+            "@stylistic/template-curly-spacing": "error",
+            "@stylistic/template-tag-spacing": "error",
+            "@stylistic/type-annotation-spacing": "error",
+            "@stylistic/type-generic-spacing": "error",
+            "@stylistic/type-named-tuple-spacing": "error",
+            "@stylistic/wrap-iife": "error",
+            "@stylistic/yield-star-spacing": "error",
+        },
+    }, 
+    // "@stylistic/migrate" plugin
+    {
+        name: "stylistic:migrate",
+        // register rule implementations of the plugins
+        plugins: {
+            "@stylistic/migrate": migratePlugin,
+        },
+        // configure plugin rules
+        rules: {
+            "@stylistic/migrate/migrate-js": "error",
+            "@stylistic/migrate/migrate-ts": "error",
+            "@stylistic/migrate/migrate-jsx": "error",
+        },
+    });
+}