@perfective/eslint-config 0.30.0 → 0.31.0

package/index.js

@@ -1,102 +1,5 @@
-import { parser } from 'typescript-eslint';
-import { arrayFuncConfig } from "./rules/array-func/index.js";
-import { eslintConfig } from "./rules/eslint/index.js";
-import { eslintCommentsConfig } from "./rules/eslint-comments/index.js";
-import { importConfig } from "./rules/import/index.js";
-import { jsImportNoExtraneousDependencies } from "./rules/import/rules/no-extraneous-dependencies.js";
-import { jsdocConfig } from "./rules/jsdoc/index.js";
-import { nConfig } from "./rules/n/index.js";
-import { preferArrowConfig } from "./rules/prefer-arrow/index.js";
-import { promiseConfig } from "./rules/promise/index.js";
-import { securityConfig } from "./rules/security/index.js";
-import { simpleImportSortConfig } from "./rules/simple-import-sort/index.js";
-import { stylisticJsConfig } from "./rules/stylistic/js/index.js";
-import { stylisticJsxConfig } from "./rules/stylistic/jsx/index.js";
-import { stylisticPlusConfig } from "./rules/stylistic/plus/index.js";
-import { stylisticTsConfig } from "./rules/stylistic/ts/index.js";
-import { typescriptEslintConfig } from "./rules/typescript-eslint/index.js";
-import { unicornConfig } from "./rules/unicorn/index.js";
-export default [{
-  ignores: ['**/*.d.ts', '**/dist']
-}, {
-  files: ['**/*.[jt]s?(x)'],
-  languageOptions: {
-    sourceType: 'module',
-    ecmaVersion: 'latest',
-    parser,
-    parserOptions: {
-      ecmaFeatures: {
-        globalReturn: false,
-        impliedStrict: true
-      },
-      projectService: {
-        allowDefaultProject: ['?(.)*.?(m|c)js']
-      },
-      warnOnUnsupportedTypeScriptVersion: true
-    }
-  },
-  plugins: Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign({}, arrayFuncConfig.plugins), eslintCommentsConfig.plugins), importConfig.plugins), jsdocConfig.plugins), nConfig.plugins), preferArrowConfig.plugins), promiseConfig.plugins), securityConfig.plugins), simpleImportSortConfig.plugins), stylisticJsConfig.plugins), stylisticPlusConfig.plugins), unicornConfig.plugins),
-  settings: {
-    jsdoc: jsdocConfig.settings
-  },
-  rules: Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign({}, arrayFuncConfig.rules), eslintConfig.rules), eslintCommentsConfig.rules), importConfig.rules), jsdocConfig.rules), nConfig.rules), preferArrowConfig.rules), promiseConfig.rules), securityConfig.rules), simpleImportSortConfig.rules), stylisticJsConfig.rules), stylisticPlusConfig.rules), unicornConfig.rules)
-}, {
-  files: ['**/*.js?(x)'],
-  languageOptions: {
-    sourceType: 'module',
-    ecmaVersion: 'latest',
-    parserOptions: {
-      ecmaFeatures: {
-        globalReturn: false,
-        impliedStrict: true
-      }
-    }
-  },
-  plugins: {},
-  settings: {
-    'import/extensions': ['.js', '.jsx']
-  },
-  rules: {
-    'import/no-commonjs': 'off',
-    'import/no-extraneous-dependencies': ['error', jsImportNoExtraneousDependencies()],
-    'import/unambiguous': 'off',
-    'jsdoc/no-types': 'off',
-    'jsdoc/no-undefined-types': 'off',
-    'jsdoc/require-param': 'error',
-    'jsdoc/require-param-type': 'error',
-    'jsdoc/require-returns': 'error',
-    'jsdoc/require-returns-type': 'error'
-  }
-}, {
-  files: ['**/*.ts?(x)'],
-  languageOptions: {
-    sourceType: 'module',
-    ecmaVersion: 'latest',
-    parser,
-    parserOptions: {
-      ecmaFeatures: {
-        globalReturn: false,
-        impliedStrict: true
-      },
-      projectService: true,
-      warnOnUnsupportedTypeScriptVersion: true
-    }
-  },
-  plugins: Object.assign(Object.assign({}, typescriptEslintConfig.plugins), stylisticTsConfig.plugins),
-  settings: {
-    'import/parsers': {
-      '@typescript-eslint/parser': ['.ts', '.tsx']
-    },
-    'import/resolver': {
-      typescript: {
-        alwaysTryTypes: true,
-        project: './tsconfig.json'
-      }
-    }
-  },
-  rules: Object.assign(Object.assign({}, typescriptEslintConfig.rules), stylisticTsConfig.rules)
-}, {
-  files: ['**/*.[jt]sx'],
-  plugins: Object.assign({}, stylisticJsxConfig.plugins),
-  rules: Object.assign({}, stylisticJsxConfig.rules)
-}].filter(Boolean);
+export { perfectiveEslintConfig } from "./config/perfective-eslint-config.js";
+export { configurationFiles, cypressFiles, javascriptFiles, jestFiles, jsxFiles, tsxFiles, typescriptDeclarationFiles, typescriptFiles } from "./linter/glob.js";
+export { javascriptLanguageOptions, languageOptions, typescriptLanguageOptions } from "./linter/language-options.js";
+export { linterConfig } from "./linter/linter-config.js";
+export { hasEslintPlugin, optionalRule } from "./linter/plugin.js";

package/linter/glob.d.ts

@@ -0,0 +1,59 @@
+/**
+ * Nominal type for globs pattern string.
+ *
+ * @since v0.31.0
+ */
+export type Glob = string;
+/**
+ * A glob pattern for JSX files.
+ *
+ * @since v0.31.0
+ */
+export declare const jsxFiles: Glob;
+/**
+ * A list of glob patterns for JS and JSX files.
+ *
+ * @since v0.31.0
+ */
+export declare const javascriptFiles: Glob[];
+/**
+ * A glob pattern for TSX files.
+ *
+ * @since v0.31.0
+ */
+export declare const tsxFiles: Glob;
+/**
+ * A list of glob patterns for TypeScript source files.
+ *
+ * @since v0.31.0
+ */
+export declare const typescriptFiles: Glob[];
+/**
+ * A glob pattern for TypeScript declaration files.
+ *
+ * @since v0.31.0
+ */
+export declare const typescriptDeclarationFiles: Glob;
+/**
+ * A glob pattern for JavaScript tools configuration files.
+ *
+ * @since v0.31.0
+ */
+export declare const configurationFiles: string[];
+/**
+ * The default glob patterns Jest uses to find test files.
+ *
+ * @see https://jestjs.io/docs/configuration#testmatch-arraystring
+ *
+ * @since v0.31.0
+ */
+export declare const jestFiles: Glob[];
+/**
+ * The default glob pattern Cypress uses to load test files.
+ *
+ * @see https://docs.cypress.io/app/references/configuration#e2e
+ * @see https://docs.cypress.io/guides/core-concepts/writing-and-organizing-tests.html
+ *
+ * @since v0.31.0
+ */
+export declare const cypressFiles: Glob;

package/linter/glob.js

@@ -0,0 +1,8 @@
+export const jsxFiles = '**/*.jsx';
+export const javascriptFiles = ['**/*.{js,cjs,mjs}', jsxFiles];
+export const tsxFiles = '**/*.tsx';
+export const typescriptFiles = ['**/*.{ts,cts,mts}', tsxFiles];
+export const typescriptDeclarationFiles = '**/*.d.{ts,cts,mts}';
+export const configurationFiles = ['**/.*.js', '**/*.config.js', '**/gulpfile.js'];
+export const jestFiles = ['**/__tests__/**/*.[jt]s?(x)', '**/?(*.)+(spec|test).[jt]s?(x)'];
+export const cypressFiles = 'cypress/e2e/**/*.cy.{js,jsx,ts,tsx}';

package/linter/language-options.d.ts

@@ -0,0 +1,25 @@
+import { Linter } from 'eslint';
+/**
+ * Creates ESLint `languageOptions` object for all files.
+ *
+ * - Uses TypeScript ESLint parser.
+ * - Allows parsing JavaScript files even if they are not allowed by TS config.
+ *
+ * @since v0.31.0
+ */
+export declare function languageOptions(): Linter.LanguageOptions;
+/**
+ * Creates ESLint `languageOptions` object for JavaScript files.
+ *
+ * @since v0.31.0
+ */
+export declare function javascriptLanguageOptions(): Linter.LanguageOptions;
+/**
+ * Creates ESLint `languageOptions` object for TypeScript files.
+ *
+ * - Uses TypeScript ESLint parser.
+ * - Does not allow JavaScript files.
+ *
+ * @since v0.31.0
+ */
+export declare function typescriptLanguageOptions(): Linter.LanguageOptions;

package/linter/language-options.js

@@ -0,0 +1,45 @@
+import { parser as typescriptEslintParser } from 'typescript-eslint';
+export function languageOptions() {
+  return {
+    sourceType: 'module',
+    ecmaVersion: 'latest',
+    parser: typescriptEslintParser,
+    parserOptions: {
+      ecmaFeatures: {
+        globalReturn: false,
+        impliedStrict: true
+      },
+      projectService: {
+        allowDefaultProject: ['?(.)*.?(m|c)js']
+      },
+      warnOnUnsupportedTypeScriptVersion: true
+    }
+  };
+}
+export function javascriptLanguageOptions() {
+  return {
+    sourceType: 'module',
+    ecmaVersion: 'latest',
+    parserOptions: {
+      ecmaFeatures: {
+        globalReturn: false,
+        impliedStrict: true
+      }
+    }
+  };
+}
+export function typescriptLanguageOptions() {
+  return {
+    sourceType: 'module',
+    ecmaVersion: 'latest',
+    parser: typescriptEslintParser,
+    parserOptions: {
+      ecmaFeatures: {
+        globalReturn: false,
+        impliedStrict: true
+      },
+      projectService: true,
+      warnOnUnsupportedTypeScriptVersion: true
+    }
+  };
+}

package/linter/linter-config.d.ts

@@ -0,0 +1,13 @@
+import { Linter } from 'eslint';
+/**
+ * An ESLint flat config or a function that returns one.
+ *
+ * @since v0.31.0
+ */
+export type LinterConfig = Linter.Config | (() => Linter.Config);
+/**
+ * A function to instantiate ESLint flat config.
+ *
+ * @since v0.31.0
+ */
+export declare function linterConfig(config: LinterConfig): Linter.Config;

package/linter/linter-config.js

@@ -0,0 +1,6 @@
+export function linterConfig(config) {
+  if (typeof config === 'function') {
+    return config();
+  }
+  return config;
+}

package/{config → linter}/node.d.ts

@@ -3,6 +3,8 @@
  *
  * 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.
+ * even if it is installed as a dependency of another dependency but can be loaded by Node.js.
+ *
+ * @protected
  */
 export declare function hasNodeModule(module: string): boolean;

package/{config → linter}/plugin.d.ts

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

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@perfective/eslint-config",
-    "version": "0.30.0",
+    "version": "0.31.0",
     "description": "ESLint shareable rules configuration",
     "keywords": ["code quality", "code standard", "code style", "eslint", "eslint config", "lint", "perfective", "tslint", "tslint config", "typescript"],
     "author": "Andrey Mikheychik <a.mikheychik@gmail.com>",
@@ -12,30 +12,29 @@
     "type": "module",
     "license": "MIT",
     "peerDependencies": {
-        "@smarttools/eslint-plugin-rxjs": "1.0.14",
+        "@eslint-community/eslint-plugin-eslint-comments": "^4.5.0",
         "@stylistic/eslint-plugin": "^4.2.0",
         "@stylistic/eslint-plugin-js": "^4.2.0",
         "@stylistic/eslint-plugin-jsx": "^4.2.0",
         "@stylistic/eslint-plugin-plus": "^4.2.0",
         "@stylistic/eslint-plugin-ts": "^4.2.0",
-        "@typescript-eslint/utils": "^8.25.0",
-        "eslint": "^9.22.0",
-        "eslint-import-resolver-typescript": "^3.8.3",
+        "eslint": "^9.25.1",
+        "eslint-import-resolver-typescript": "^3.10.1",
         "eslint-plugin-array-func": "^5.0.2",
-        "eslint-plugin-cypress": "^4.2.0",
-        "eslint-plugin-eslint-comments": "^3.2.0",
+        "eslint-plugin-cypress": "^4.3.0",
         "eslint-plugin-import": "^2.31.0",
         "eslint-plugin-jest": "^28.11.0",
         "eslint-plugin-jest-dom": "^5.5.0",
-        "eslint-plugin-jsdoc": "^50.6.3",
-        "eslint-plugin-n": "^17.16.2",
+        "eslint-plugin-jsdoc": "^50.6.11",
+        "eslint-plugin-n": "^17.17.0",
         "eslint-plugin-prefer-arrow": "^1.2.3",
         "eslint-plugin-promise": "^7.2.1",
+        "eslint-plugin-rxjs-x": "~0.7.2",
         "eslint-plugin-security": "^3.0.1",
         "eslint-plugin-simple-import-sort": "^12.1.1",
         "eslint-plugin-testing-library": "^7.1.1",
-        "eslint-plugin-unicorn": "^57.0.0",
-        "typescript-eslint": "^8.26.0"
+        "eslint-plugin-unicorn": "^59.0.0",
+        "typescript-eslint": "^8.31.1"
     },
     "peerDependenciesMeta": {
         "eslint-plugin-cypress": {
@@ -54,7 +53,7 @@
             "optional": true
         }
     },
-    "main": "./index.js",
+    "main": "./index.cjs",
     "module": "./index.js",
     "types": "./index.d.ts",
     "directories": {
@@ -64,43 +63,43 @@
     "exports": {
         ".": {
             "import": "./index.js",
-            "require": "./index.js",
             "types": "./index.d.ts"
         },
-        "./config": {
-            "import": "./config.js",
-            "require": "./config.js",
-            "types": "./config.d.ts"
-        },
-        "./rules": {
-            "import": "./rules.js",
-            "require": "./rules.js",
-            "types": "./rules.d.ts"
-        },
         "./cypress": {
-            "import": "./cypress.js",
-            "require": "./cypress.js",
-            "types": "./cypress.d.ts"
+            "import": "./config/cypress/index.js",
+            "types": "./config/cypress/index.d.ts"
+        },
+        "./import": {
+            "import": "./config/import/index.js",
+            "types": "./config/import/index.d.ts"
         },
         "./jest": {
-            "import": "./jest.js",
-            "require": "./jest.js",
-            "types": "./jest.d.ts"
+            "import": "./config/jest/index.js",
+            "types": "./config/jest/index.d.ts"
         },
         "./jest-dom": {
-            "import": "./jest-dom.js",
-            "require": "./jest-dom.js",
-            "types": "./jest-dom.d.ts"
+            "import": "./config/jest-dom/index.js",
+            "types": "./config/jest-dom/index.d.ts"
         },
         "./rxjs": {
-            "import": "./rxjs.js",
-            "require": "./rxjs.js",
-            "types": "./rxjs.d.ts"
+            "import": "./config/rxjs/index.js",
+            "types": "./config/rxjs/index.d.ts"
+        },
+        "./simple-import-sort": {
+            "import": "./config/simple-import-sort/index.js",
+            "types": "./config/simple-import-sort/index.d.ts"
         },
         "./testing-library": {
-            "import": "./testing-library.js",
-            "require": "./testing-library.js",
-            "types": "./testing-library.d.ts"
+            "import": "./config/testing-library/index.js",
+            "types": "./config/testing-library/index.d.ts"
+        },
+        "./typescript-eslint": {
+            "import": "./config/typescript-eslint/index.js",
+            "types": "./config/typescript-eslint/index.d.ts"
+        },
+        "./unicorn": {
+            "import": "./config/unicorn/index.js",
+            "types": "./config/unicorn/index.d.ts"
         }
     },
     "scripts": {}

package/config.d.ts

@@ -1 +0,0 @@
-export { hasEslintPlugin, optionalRule, } from './config/plugin';

package/config.js

@@ -1 +0,0 @@
-export { hasEslintPlugin, optionalRule } from "./config/plugin.js";

package/cypress.d.ts

@@ -1,6 +0,0 @@
-/**
- * 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,31 +0,0 @@
-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/jest-dom.d.ts

@@ -1 +0,0 @@
-export declare function jestDomConfig(files?: string[]): Record<string, unknown>;

package/jest-dom.js

@@ -1,8 +0,0 @@
-import { jestDomConfig as jestDomPluginConfig } from "./rules/jest-dom/index.js";
-export function jestDomConfig(files = ['**/*.@(spec|test).[jt]s?(x)']) {
-  return {
-    files,
-    plugins: jestDomPluginConfig.plugins,
-    rules: jestDomPluginConfig.rules
-  };
-}

package/jest.d.ts

@@ -1,7 +0,0 @@
-/**
- * Configuration for the Jest plugin.
- *
- * @param files - A list of globs with the Jest test files.
- * Default value is extensions supported by Jest (/\.(spec|test)\.[jt]sx?$/).
- */
-export declare function jestConfig(files?: string[]): Record<string, unknown>;

package/jest.js

@@ -1,29 +0,0 @@
-import { jestImportNoExtraneousDependencies } from "./rules/import/rules/no-extraneous-dependencies.js";
-import { jestConfig as jestPluginConfig } from "./rules/jest/index.js";
-export function jestConfig(files = ['**/*.@(spec|test).[jt]s?(x)']) {
-  return {
-    files,
-    plugins: jestPluginConfig.plugins,
-    rules: Object.assign(Object.assign({}, jestPluginConfig.rules), {
-      '@typescript-eslint/ban-ts-comment': ['error', {
-        'ts-expect-error': 'allow-with-description',
-        'ts-ignore': true,
-        'ts-nocheck': true,
-        'ts-check': false
-      }],
-      '@typescript-eslint/init-declarations': 'off',
-      '@typescript-eslint/unbound-method': 'off',
-      'import/no-extraneous-dependencies': ['error', jestImportNoExtraneousDependencies()],
-      'import/no-unassigned-import': ['error', {
-        allow: ['@testing-library/jest-dom', '@testing-library/jest-dom/extend-expect']
-      }],
-      'max-nested-callbacks': ['error', 6],
-      'n/no-unpublished-import': ['error', {
-        allowModules: ['@jest/globals']
-      }],
-      'prefer-arrow/prefer-arrow-functions': 'off',
-      'promise/always-return': 'off',
-      '@smarttools/rxjs/no-topromise': 'off'
-    })
-  };
-}

package/rules/array-func/index.d.ts

@@ -1,13 +0,0 @@
-export declare const arrayFuncConfig: {
-    plugins: {
-        'array-func': import("@typescript-eslint/utils/dist/ts-eslint").FlatConfig.Plugin;
-    };
-    rules: {
-        'array-func/from-map': string;
-        'array-func/no-unnecessary-this-arg': string;
-        'array-func/prefer-array-from': string;
-        'array-func/avoid-reverse': string;
-        'array-func/prefer-flat-map': string;
-        'array-func/prefer-flat': string;
-    };
-};

package/rules/array-func/index.js

@@ -1,14 +0,0 @@
-import eslintPluginArrayFunc from 'eslint-plugin-array-func';
-export const arrayFuncConfig = {
-  plugins: {
-    'array-func': eslintPluginArrayFunc
-  },
-  rules: {
-    'array-func/from-map': 'warn',
-    'array-func/no-unnecessary-this-arg': 'error',
-    'array-func/prefer-array-from': 'warn',
-    'array-func/avoid-reverse': 'warn',
-    'array-func/prefer-flat-map': 'off',
-    'array-func/prefer-flat': 'off'
-  }
-};

package/rules/cypress/index.d.ts

@@ -1,29 +0,0 @@
-export declare const cypressOptionalConfig: {
-    plugins: {
-        cypress: import("@typescript-eslint/utils/dist/ts-eslint").FlatConfig.Plugin & {
-            configs: {
-                globals: {
-                    languageOptions: {
-                        globals: import("@typescript-eslint/utils/dist/ts-eslint").TSESLint.FlatConfig.GlobalsConfig;
-                    };
-                };
-            };
-        };
-    };
-    languageOptions: {
-        globals: import("@typescript-eslint/utils/dist/ts-eslint").SharedConfig.GlobalsConfig;
-    };
-    rules: {
-        'cypress/assertion-before-screenshot': string;
-        'cypress/no-assigning-return-values': string;
-        'cypress/no-async-before': string;
-        'cypress/no-async-tests': string;
-        'cypress/no-debug': string;
-        'cypress/no-force': string;
-        'cypress/no-pause': string;
-        'cypress/no-unnecessary-waiting': string;
-        'cypress/no-xpath': string;
-        'cypress/require-data-selectors': string;
-        'cypress/unsafe-to-chain-command': string;
-    };
-};

package/rules/cypress/index.js

@@ -1,23 +0,0 @@
-var _a;
-import eslintPluginCypress from 'eslint-plugin-cypress/flat';
-export const cypressOptionalConfig = {
-  plugins: {
-    cypress: eslintPluginCypress
-  },
-  languageOptions: {
-    globals: (_a = eslintPluginCypress.configs.globals.languageOptions) === null || _a === void 0 ? void 0 : _a.globals
-  },
-  rules: {
-    'cypress/assertion-before-screenshot': 'error',
-    'cypress/no-assigning-return-values': 'error',
-    'cypress/no-async-before': 'error',
-    'cypress/no-async-tests': 'error',
-    'cypress/no-debug': 'error',
-    'cypress/no-force': 'error',
-    'cypress/no-pause': 'error',
-    'cypress/no-unnecessary-waiting': 'error',
-    'cypress/no-xpath': 'error',
-    'cypress/require-data-selectors': 'error',
-    'cypress/unsafe-to-chain-command': 'error'
-  }
-};