@perfective/eslint-config 0.29.2 → 0.30.0

package/LICENSE

@@ -1,6 +1,6 @@
 The MIT License
 
-Copyright (c) 2020-2024 Andrey Mikheychik (https://github.com/amikheychik)
+Copyright (c) 2020-2025 Andrey Mikheychik (https://github.com/amikheychik)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.adoc

@@ -90,21 +90,25 @@ npm install --save-dev \
 +
 [source,javascript]
 ----
-const perfectiveEslintConfig = require('@perfective/eslint-config');
-const perfectiveCypressConfig = require('@perfective/eslint-config/cypress');
-const perfectiveJestConfig = require('@perfective/eslint-config/jest');
-const perfectiveJestDomConfig = require('@perfective/eslint-config/jest-dom');
-const perfectiveRxjsConfig = require('@perfective/eslint-config/rxjs');
-const perfectiveTestingLibraryConfig = require('@perfective/eslint-config/testing-library');
-
-module.exports = [
-    ...perfectiveEslintConfig.default,
-    perfectiveCypressConfig.cypressConfig(),
-    perfectiveJestConfig.jestConfig(),
-    perfectiveJestDomConfig.jestDomConfig(),
-    perfectiveRxjsConfig.rxjsConfig(),
-    perfectiveTestingLibraryConfig.testingLibrarysConfig(),
+import perfectiveEslintConfig from '@perfective/eslint-config';
+
+// Optional dependencies.
+import { cypressConfig } from '@perfective/eslint-config/cypress';
+import { jestConfig } from '@perfective/eslint-config/jest';
+import { jestDomConfig } from '@perfective/eslint-config/jest-dom';
+import { rxjsConfig } from '@perfective/eslint-config/rxjs';
+import { testingLibraryConfig } from '@perfective/eslint-config/testing-library';
+
+const eslintConfig = [
+    ...perfectiveEslintConfig,
+    cypressConfig(),
+    jestConfig(),
+    jestDomConfig(),
+    rxjsConfig(),
+    testingLibraryConfig(),
 ];
+
+export default eslintConfig;
 ----
 
 == Rules Configuration Extension Functions
@@ -122,11 +126,11 @@ you can use these functions in the `eslint.config.js` file:
 
 [source,javascript]
 ----
-const perfectiveEslintConfig = require('@perfective/eslint-config');
-const rules = require('@perfective/eslint-config/rules'); // <.>
+import perfectiveEslintConfig from '@perfective/eslint-config';
+import { simpleImportSortImports } from '@perfective/eslint-config/rules'; // <.>
 
-module.exports = [
-    ...perfectiveEslintConfig.default,
+const eslintConfig = [
+    ...perfectiveEslintConfig,
     {
         files: ['**/*.[jt]s?(x)'],
         rules: {
@@ -136,6 +140,8 @@ module.exports = [
         },
     },
 ];
+
+export default eslintConfig;
 ----
 <1> Framework-specific packages, based on `@perfective/eslint-config`, re-export all the rules.
 So rules should be required from those packages for correct `node_modules` resolution.

package/README.md

@@ -61,9 +61,9 @@ from issues that will be fixed automatically.
 2. Require the configuration in your root `eslint.config.js`.
 
     ```javascript
-    const perfectiveEslintConfig = require('@perfective/eslint-config');
+    import perfectiveEslintConfig from '@perfective/eslint-config';
 
-    module.exports = perfectiveEslintConfig.default;
+    export default perfectiveEslintConfig;
     ```
 
 3. Install optional peer dependencies that add linting rules for the tools you use.
@@ -83,19 +83,23 @@ from issues that will be fixed automatically.
 4. Add optional configurations to your root `eslint.config.js`.
 
     ```javascript
-    const perfectiveEslintConfig = require('@perfective/eslint-config');
-    const perfectiveCypressConfig = require('@perfective/eslint-config/cypress');
-    const perfectiveJestConfig = require('@perfective/eslint-config/jest');
-    const perfectiveJestDomConfig = require('@perfective/eslint-config/jest-dom');
-    const perfectiveRxjsConfig = require('@perfective/eslint-config/rxjs');
-    const perfectiveTestingLibraryConfig = require('@perfective/eslint-config/testing-library');
-
-    module.exports = [
-        ...perfectiveEslintConfig.default,
-        perfectiveCypressConfig.cypressConfig(),
-        perfectiveJestConfig.jestConfig(),
-        perfectiveJestDomConfig.jestDomConfig(),
-        perfectiveRxjsConfig.rxjsConfig(),
-        perfectiveTestingLibraryConfig.testingLibrarysConfig(),
+    import perfectiveEslintConfig from '@perfective/eslint-config';
+
+    // Optional dependencies.
+    import { cypressConfig } from '@perfective/eslint-config/cypress';
+    import { jestConfig } from '@perfective/eslint-config/jest';
+    import { jestDomConfig } from '@perfective/eslint-config/jest-dom';
+    import { rxjsConfig } from '@perfective/eslint-config/rxjs';
+    import { testingLibraryConfig } from '@perfective/eslint-config/testing-library';
+
+    const eslintConfig = [
+        ...perfectiveEslintConfig,
+        cypressConfig(),
+        jestConfig(),
+        jestDomConfig(),
+        rxjsConfig(),
+        testingLibraryConfig(),
     ];
+
+    export default eslintConfig;
     ```

package/config/node.d.ts

@@ -1 +1,8 @@
+/**
+ * Returns true if a given `module` can be resolved in node_modules.
+ *
+ * A module does not have to be required directly by the package.json.
+ * The function returns true,
+ * even if it is installed as a dependency of another dependency but can be loaded by NodeJS.
+ */
 export declare function hasNodeModule(module: string): boolean;

package/config/node.js

@@ -1,11 +1,7 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.hasNodeModule = hasNodeModule;
-function hasNodeModule(module) {
-    try {
-        return Boolean(require.resolve(module));
-    }
-    catch (_a) {
-        return false;
-    }
-}
+export function hasNodeModule(module) {
+  try {
+    return Boolean(require.resolve(module));
+  } catch (_a) {
+    return false;
+  }
+}

package/config/plugin.d.ts

@@ -1,2 +1,11 @@
+/**
+ * If a given rule belongs to an installed ESLint plugin,
+ * returns an object with rule as a key and its config as a value.
+ *
+ * Otherwise, returns an empty object.
+ */
 export declare function optionalRule(rule: string, config: unknown): Record<string, unknown>;
+/**
+ * Returns true if a given ESLint plugin exists.
+ */
 export declare function hasEslintPlugin(plugin: string): boolean;

package/config/plugin.js

@@ -1,30 +1,26 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.optionalRule = optionalRule;
-exports.hasEslintPlugin = hasEslintPlugin;
-const node_1 = require("./node");
-function optionalRule(rule, config) {
-    const plugin = pluginOfRule(rule);
-    if (plugin === null) {
-        return {};
-    }
-    if (hasEslintPlugin(plugin)) {
-        return {
-            [rule]: config,
-        };
-    }
+import { hasNodeModule } from "./node.js";
+export function optionalRule(rule, config) {
+  const plugin = pluginOfRule(rule);
+  if (plugin === null) {
     return {};
+  }
+  if (hasEslintPlugin(plugin)) {
+    return {
+      [rule]: config
+    };
+  }
+  return {};
 }
-function hasEslintPlugin(plugin) {
-    if (plugin.startsWith('@')) {
-        return (0, node_1.hasNodeModule)(`${plugin}/eslint-plugin`);
-    }
-    return (0, node_1.hasNodeModule)(`eslint-plugin-${plugin}`);
+export function hasEslintPlugin(plugin) {
+  if (plugin.startsWith('@')) {
+    return hasNodeModule(`${plugin}/eslint-plugin`);
+  }
+  return hasNodeModule(`eslint-plugin-${plugin}`);
 }
 function pluginOfRule(rule) {
-    const parts = rule.split('/');
-    if (parts.length > 1) {
-        return parts[0];
-    }
-    return null;
-}
+  const parts = rule.split('/');
+  if (parts.length > 1) {
+    return parts[0];
+  }
+  return null;
+}

package/config.js

@@ -1,6 +1 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.optionalRule = exports.hasEslintPlugin = void 0;
-var plugin_1 = require("./config/plugin");
-Object.defineProperty(exports, "hasEslintPlugin", { enumerable: true, get: function () { return plugin_1.hasEslintPlugin; } });
-Object.defineProperty(exports, "optionalRule", { enumerable: true, get: function () { return plugin_1.optionalRule; } });
+export { hasEslintPlugin, optionalRule } from "./config/plugin.js";

package/cypress.d.ts

@@ -1 +1,6 @@
+/**
+ * Configuration for the eslint-plugin-cypress.
+ *
+ * @param files - A list of globs with the Cypress test files.
+ */
 export declare function cypressConfig(files?: string[]): Record<string, unknown>;

package/cypress.js

@@ -1,56 +1,31 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || (function () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.cypressConfig = cypressConfig;
-const tsEslint = __importStar(require("typescript-eslint"));
-const cypress_1 = require("./rules/cypress");
-const no_extraneous_dependencies_1 = require("./rules/import/rules/no-extraneous-dependencies");
-function cypressConfig(files = ['cypress/**/*.[jt]s']) {
-    return {
-        files,
-        languageOptions: Object.assign({ sourceType: 'module', ecmaVersion: 'latest', parser: tsEslint.parser, parserOptions: {
-                ecmaFeatures: {
-                    globalReturn: false,
-                    impliedStrict: true,
-                },
-                projectService: true,
-                warnOnUnsupportedTypeScriptVersion: true,
-            } }, cypress_1.cypressOptionalConfig.languageOptions),
-        plugins: Object.assign({}, cypress_1.cypressOptionalConfig.plugins),
-        rules: Object.assign(Object.assign({}, cypress_1.cypressOptionalConfig.rules), { 'init-declarations': 'off', '@typescript-eslint/init-declarations': 'off', 'import/no-extraneous-dependencies': ['error', (0, no_extraneous_dependencies_1.cypressImportNoExtraneousDependencies)()], 'max-nested-callbacks': ['error', 4], 'new-cap': ['error', {
-                    capIsNewExceptions: ['Given', 'When', 'Then', 'And', 'But', 'Before', 'After'],
-                }] }),
-    };
-}
+import { parser } from 'typescript-eslint';
+import { cypressOptionalConfig } from "./rules/cypress/index.js";
+import { cypressImportNoExtraneousDependencies } from "./rules/import/rules/no-extraneous-dependencies.js";
+export function cypressConfig(files = ['cypress/**/*.[jt]s']) {
+  return {
+    files,
+    languageOptions: Object.assign({
+      sourceType: 'module',
+      ecmaVersion: 'latest',
+      parser,
+      parserOptions: {
+        ecmaFeatures: {
+          globalReturn: false,
+          impliedStrict: true
+        },
+        projectService: true,
+        warnOnUnsupportedTypeScriptVersion: true
+      }
+    }, cypressOptionalConfig.languageOptions),
+    plugins: Object.assign({}, cypressOptionalConfig.plugins),
+    rules: Object.assign(Object.assign({}, cypressOptionalConfig.rules), {
+      'init-declarations': 'off',
+      '@typescript-eslint/init-declarations': 'off',
+      'import/no-extraneous-dependencies': ['error', cypressImportNoExtraneousDependencies()],
+      'max-nested-callbacks': ['error', 4],
+      'new-cap': ['error', {
+        capIsNewExceptions: ['Given', 'When', 'Then', 'And', 'But', 'Before', 'After']
+      }]
+    })
+  };
+}

package/index.d.ts

@@ -25,27 +25,39 @@ declare const _default: ({
     plugins: {
         unicorn: import("eslint").ESLint.Plugin & {
             configs: {
-                recommended: import("eslint").Linter.Config;
-                all: import("eslint").Linter.Config;
+                recommended: import("eslint").Linter.FlatConfig;
+                all: import("eslint").Linter.FlatConfig;
                 "flat/all": import("eslint").Linter.FlatConfig;
                 "flat/recommended": import("eslint").Linter.FlatConfig;
             };
         };
-        '@stylistic/plus': typeof import("@stylistic/eslint-plugin-plus");
-        '@stylistic/js': typeof import("@stylistic/eslint-plugin-js");
+        '@stylistic/plus': {
+            rules: import("@stylistic/eslint-plugin-plus").Rules;
+            configs: {
+                "disable-legacy": import("eslint").Linter.Config;
+            };
+        };
+        '@stylistic/js': {
+            rules: import("@stylistic/eslint-plugin-js").Rules;
+            configs: {
+                "disable-legacy": import("eslint").Linter.Config;
+                "all": import("eslint").Linter.Config;
+                "all-flat": import("eslint").Linter.Config;
+            };
+        };
         'simple-import-sort': import("eslint").ESLint.Plugin;
-        security: typeof import("eslint-plugin-security");
-        promise: typeof import("eslint-plugin-promise");
-        'prefer-arrow': typeof import("eslint-plugin-prefer-arrow");
+        security: import("@typescript-eslint/utils/dist/ts-eslint").FlatConfig.Plugin;
+        promise: import("@typescript-eslint/utils/dist/ts-eslint").FlatConfig.Plugin;
+        'prefer-arrow': import("@typescript-eslint/utils/dist/ts-eslint").FlatConfig.Plugin;
         n: import("eslint").ESLint.Plugin & {
             configs: import("eslint-plugin-n").Configs;
         };
         jsdoc: {
-            rules: Record<string, import("eslint").Rule.RuleModule> | undefined;
+            rules: Record<string, import("@eslint/core").RuleDefinition<import("@eslint/core").RuleDefinitionTypeOptions>> | undefined;
         };
         import: Record<string, unknown>;
-        'eslint-comments': typeof import("eslint-plugin-eslint-comments");
-        'array-func': typeof import("eslint-plugin-array-func");
+        'eslint-comments': import("@typescript-eslint/utils/dist/ts-eslint").FlatConfig.Plugin;
+        'array-func': import("@typescript-eslint/utils/dist/ts-eslint").FlatConfig.Plugin;
     };
     settings: {
         jsdoc: {
@@ -75,6 +87,8 @@ declare const _default: ({
     rules: {
         'unicorn/better-regex': string;
         'unicorn/catch-error-name': string;
+        'unicorn/consistent-assert': string;
+        'unicorn/consistent-date-clone': string;
         'unicorn/consistent-destructuring': string;
         'unicorn/consistent-empty-array-spread': string;
         'unicorn/consistent-existence-index-check': string;
@@ -94,6 +108,7 @@ declare const _default: ({
         'unicorn/import-style': string;
         'unicorn/new-for-builtins': string;
         'unicorn/no-abusive-eslint-disable': string;
+        'unicorn/no-accessor-recursion': string;
         'unicorn/no-anonymous-default-export': string;
         'unicorn/no-array-callback-reference': string;
         'unicorn/no-array-for-each': string;
@@ -110,6 +125,7 @@ declare const _default: ({
         'unicorn/no-for-loop': string;
         'unicorn/no-hex-escape': string;
         'unicorn/no-instanceof-array': string;
+        'unicorn/no-instanceof-builtins': string;
         'unicorn/no-invalid-fetch-options': string;
         'unicorn/no-invalid-remove-event-listener': string;
         'unicorn/no-keyword-prefix': (string | {
@@ -120,6 +136,7 @@ declare const _default: ({
         'unicorn/no-length-as-slice-end': string;
         'unicorn/no-lonely-if': string;
         'unicorn/no-magic-array-flat-depth': string;
+        'unicorn/no-named-default': string;
         'unicorn/no-negated-condition': string;
         'unicorn/no-negation-in-equality-check': string;
         'unicorn/no-nested-ternary': string;
@@ -339,6 +356,7 @@ declare const _default: ({
         '@stylistic/js/no-extra-parens': (string | {
             ignoreJSX: string;
             nestedBinaryExpressions: boolean;
+            nestedConditionalExpressions: boolean;
             enforceForArrowConditionals: boolean;
             ternaryOperandBinaryExpressions: boolean;
         })[];
@@ -1119,7 +1137,14 @@ declare const _default: ({
         };
     };
     plugins: {
-        '@stylistic/ts': typeof import("@stylistic/eslint-plugin-ts");
+        '@stylistic/ts': {
+            rules: import("@stylistic/eslint-plugin-ts").Rules;
+            configs: {
+                "disable-legacy": import("eslint").Linter.Config;
+                "all": import("eslint").Linter.Config;
+                "all-flat": import("eslint").Linter.Config;
+            };
+        };
         '@typescript-eslint': import("@typescript-eslint/utils/dist/ts-eslint").FlatConfig.Plugin;
     };
     settings: {
@@ -1388,6 +1413,7 @@ declare const _default: ({
         '@typescript-eslint/consistent-indexed-object-style': string[];
         '@typescript-eslint/consistent-type-assertions': (string | {
             assertionStyle: string;
+            arrayLiteralTypeAssertions: string;
             objectLiteralTypeAssertions: string;
         })[];
         '@typescript-eslint/consistent-type-definitions': string[];
@@ -1469,6 +1495,7 @@ declare const _default: ({
             checksConditionals: boolean;
             checksVoidReturn: boolean;
         })[];
+        '@typescript-eslint/no-misused-spread': string;
         '@typescript-eslint/no-mixed-enums': string;
         '@typescript-eslint/no-namespace': string;
         '@typescript-eslint/no-non-null-asserted-nullish-coalescing': string;
@@ -1639,7 +1666,14 @@ declare const _default: ({
 } | {
     files: string[];
     plugins: {
-        '@stylistic/jsx': typeof import("@stylistic/eslint-plugin-jsx");
+        '@stylistic/jsx': {
+            rules: import("@stylistic/eslint-plugin-jsx").Rules;
+            configs: {
+                "disable-legacy": import("eslint").Linter.Config;
+                "all": import("eslint").Linter.Config;
+                "all-flat": import("eslint").Linter.Config;
+            };
+        };
     };
     rules: {
         '@stylistic/jsx/jsx-child-element-spacing': string;