@perfective/eslint-config 0.28.0 → 0.29.1

package/README.adoc

@@ -61,35 +61,52 @@ npm install --save-dev \
     typescript-eslint
 ----
 +
+. Require the configuration in your root `eslint.config.js`.
++
+[source,javascript]
+----
+const perfectiveEslintConfig = require('@perfective/eslint-config');
+
+module.exports = perfectiveEslintConfig.default;
+----
++
+. `*.d.ts` files and `dist` directories are ignored by the configuration.
+`node_modules` and dot-files are ignored by the `eslint`.
+If more directories or file types need to be ignored, see the
+`link:https://eslint.org/docs/user-guide/configuring/ignoring-code#the-eslintignore-file[.eslintignore]` file docs.
++
 . Install optional peer dependencies that add linting rules for the tools you use.
 +
 [source,bash]
 ----
 npm install --save-dev \
+    @smarttools/eslint-plugin-rxjs \
     eslint-plugin-cypress \
     eslint-plugin-jest \
     eslint-plugin-jest-dom \
-    eslint-plugin-rxjs \
     eslint-plugin-testing-library
 ----
 +
-The `@perfective/eslint-config` automatically includes rules for these plugins,
-if the dependency is installed.
-+
-. Require the configuration in your root `eslint.config.js`.
+. Add optional configurations to your root `eslint.config.js`.
 +
 [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;
+module.exports = [
+    ...perfectiveEslintConfig.default,
+    perfectiveCypressConfig.cypressConfig(),
+    perfectiveJestConfig.jestConfig(),
+    perfectiveJestDomConfig.jestDomConfig(),
+    perfectiveRxjsConfig.rxjsConfig(),
+    perfectiveTestingLibraryConfig.testingLibrarysConfig(),
+];
 ----
-+
-. `*.d.ts` files and `dist` directories are ignored by the configuration.
-`node_modules` and dot-files are ignored by the `eslint`.
-If more directories or file types need to be ignored, see the
-`link:https://eslint.org/docs/user-guide/configuring/ignoring-code#the-eslintignore-file[.eslintignore]` file docs.
-
 
 == Rules Configuration Extension Functions
 
@@ -135,22 +152,3 @@ for the `simple-import-sort/imports` rule.
 * `unicornPreventAbbreviations(replacements, options)`
 — extends and overrides the list of `replacements`
 and `options` for the `unicorn/prevent-abbreviation` rule.
-
-
-== Internals
-
-The rules for each plugin are described in the `./src/rules/{plugin}` subdirectories,
-where the `{plugin}` is the name of the plugin (after the `eslint-plugin-` prefix).
-Each configuration is exported from the `./index.ts` file
-and is organized as a partial ESLint config.
-It should contain the plugin name and the list of the rules, sorted alphabetically.
-When a plugin's documentation groups rules,
-each group is configured in a separate file
-and then extended in the `./index.ts` file.
-
-The final configuration extends each plugin configuration on a file-type basis.
-
-
-== Roadmap
-
-* Add the `@perfective/eslint-plugin` with the rules for working with the `@perfective` packages.

package/README.md

@@ -59,24 +59,44 @@ from issues that will be fixed automatically.
         typescript-eslint
     ```
 
-2. Install optional peer dependencies that add linting rules for the tools you use.
+2. Require the configuration in your root `eslint.config.js`.
+
+    ```javascript
+    const perfectiveEslintConfig = require('@perfective/eslint-config');
+
+    module.exports = perfectiveEslintConfig.default;
+    ```
+
+3. Install optional peer dependencies that add linting rules for the tools you use.
 
     ```bash
     npm install --save-dev \
+        @smarttools/eslint-plugin-rxjs \
         eslint-plugin-cypress \
         eslint-plugin-jest \
         eslint-plugin-jest-dom \
-        eslint-plugin-rxjs \
         eslint-plugin-testing-library
     ```
 
     The `@perfective/eslint-config` automatically includes rules for these plugins,
     if the dependency is installed.
 
-3. Require the configuration in your root `eslint.config.js`.
+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;
+    module.exports = [
+        ...perfectiveEslintConfig.default,
+        perfectiveCypressConfig.cypressConfig(),
+        perfectiveJestConfig.jestConfig(),
+        perfectiveJestDomConfig.jestDomConfig(),
+        perfectiveRxjsConfig.rxjsConfig(),
+        perfectiveTestingLibraryConfig.testingLibrarysConfig(),
+    ];
     ```

package/config/plugin.d.ts

@@ -1,5 +1,2 @@
-export declare function optionalConfig(plugin: string, rules: Record<string, unknown>): Record<string, unknown>;
-export declare function optionalOverrides(plugin: string, overrides: Record<string, unknown>): Record<string, unknown> | null;
-export declare function optionalRules(plugin: string): string | null;
 export declare function optionalRule(rule: string, config: unknown): Record<string, unknown>;
 export declare function hasEslintPlugin(plugin: string): boolean;

package/config/plugin.js

@@ -1,32 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.optionalConfig = optionalConfig;
-exports.optionalOverrides = optionalOverrides;
-exports.optionalRules = optionalRules;
 exports.optionalRule = optionalRule;
 exports.hasEslintPlugin = hasEslintPlugin;
 const node_1 = require("./node");
-function optionalConfig(plugin, rules) {
-    if (hasEslintPlugin(plugin)) {
-        return {
-            plugins: [plugin],
-            rules,
-        };
-    }
-    return {};
-}
-function optionalOverrides(plugin, overrides) {
-    if (hasEslintPlugin(plugin)) {
-        return overrides;
-    }
-    return null;
-}
-function optionalRules(plugin) {
-    if (hasEslintPlugin(plugin)) {
-        return `./rules/${plugin.replace(/^@/u, '')}`;
-    }
-    return null;
-}
 function optionalRule(rule, config) {
     const plugin = pluginOfRule(rule);
     if (plugin === null) {

package/config.d.ts

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

package/config.js

@@ -1,9 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.optionalRules = exports.optionalRule = exports.optionalOverrides = exports.optionalConfig = exports.hasEslintPlugin = void 0;
+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, "optionalConfig", { enumerable: true, get: function () { return plugin_1.optionalConfig; } });
-Object.defineProperty(exports, "optionalOverrides", { enumerable: true, get: function () { return plugin_1.optionalOverrides; } });
 Object.defineProperty(exports, "optionalRule", { enumerable: true, get: function () { return plugin_1.optionalRule; } });
-Object.defineProperty(exports, "optionalRules", { enumerable: true, get: function () { return plugin_1.optionalRules; } });

package/cypress.d.ts

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

package/cypress.js

@@ -0,0 +1,58 @@
+"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(Object.assign({}, cypress_1.cypressOptionalConfig.languageOptions), { parser: tsEslint.parser, parserOptions: {
+                ecmaVersion: 6,
+                ecmaFeatures: {
+                    globalReturn: false,
+                    impliedStrict: true,
+                },
+                sourceType: 'module',
+                project: './tsconfig.json',
+                warnOnUnsupportedTypeScriptVersion: true,
+            } }),
+        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'],
+                }] }),
+    };
+}