@perfective/eslint-config 0.20.0 → 0.21.0-alpha

package/README.adoc

@@ -7,12 +7,12 @@ These rules are primarily configured for TypeScript projects.
 
 In addition to the core https://eslint.org/docs/latest/rules/[ESLint rules]
 and the `link:https://typescript-eslint.io/rules/[@typescript-eslint]` plugin rules,
-`@perfective/eslint-config` configures:
+`@perfective/eslint-config` includes configurations for the ESLint plugins:
 
 * `link:https://github.com/freaktechnik/eslint-plugin-array-func[eslint-plugin-array-func]`;
-* `link:https://github.com/cypress-io/eslint-plugin-cypress[eslint-plugin-cypress]`;
+* `link:https://github.com/cypress-io/eslint-plugin-cypress[eslint-plugin-cypress]` _(optional)_;
 * `link:https://github.com/gund/eslint-plugin-deprecation[eslint-plugin-deprecation]`;
-* `link:https://mysticatea.github.io/eslint-plugin-eslint-comments/]`;
+* `link:https://mysticatea.github.io/eslint-plugin-eslint-comments/[eslint-plugin-eslint-comments]`;
 * `link:https://github.com/import-js/eslint-plugin-import[eslint-plugin-import]`;
 * `link:https://github.com/jest-community/eslint-plugin-jest[eslint-plugin-jest]`;
 * `link:https://github.com/testing-library/eslint-plugin-jest-dom[eslint-plugin-jest-dom]`;
@@ -48,7 +48,6 @@ npm install --save-dev \
     eslint \
     eslint-import-resolver-typescript \
     eslint-plugin-array-func \
-    eslint-plugin-cypress \
     eslint-plugin-deprecation \
     eslint-plugin-eslint-comments \
     eslint-plugin-import \
@@ -67,6 +66,20 @@ npm install --save-dev \
     tslint
 ----
 +
+. Install optional peer dependencies that add linting rules for the tools you use.
++
+[source,bash]
+----
+npm install --save-dev \
+    eslint-plugin-cypress
+----
++
+[NOTE]
+====
+The `@perfective/eslint-config` automatically includes rules for these plugins,
+if the dependency is installed.
+====
++
 . Require the configuration in your root `.eslintrc.js`.
 +
 [source,javascript]

package/README.md

@@ -6,10 +6,11 @@ that is used for the development of the `@perfective` packages.
 These rules are primarily configured for TypeScript projects.
 
 In addition to the core [ESLint rules](https://eslint.org/docs/latest/rules/)
-and the [`@typescript-eslint`](https://typescript-eslint.io/rules/) plugin rules, `@perfective/eslint-config` configures:
+and the [`@typescript-eslint`](https://typescript-eslint.io/rules/) plugin rules,
+`@perfective/eslint-config` includes configurations for the ESLint plugins:
 
 -   [`eslint-plugin-array-func`](https://github.com/freaktechnik/eslint-plugin-array-func);
--   [`eslint-plugin-cypress`](https://github.com/cypress-io/eslint-plugin-cypress);
+-   [`eslint-plugin-cypress`](https://github.com/cypress-io/eslint-plugin-cypress) _(optional)_;
 -   [`eslint-plugin-deprecation`](https://github.com/gund/eslint-plugin-deprecation);
 -   [`eslint-plugin-eslint-comments`](https://mysticatea.github.io/eslint-plugin-eslint-comments/);
 -   [`eslint-plugin-import`](https://github.com/import-js/eslint-plugin-import);
@@ -33,44 +34,53 @@ from issues that will be fixed automatically.
 
 ## Setup
 
-Require `@perfective/eslint-config` and its peer dependencies as dev dependencies.
+1. Require `@perfective/eslint-config` and its peer dependencies as dev dependencies.
 
-```bash
-npm install --save-dev \
-    @perfective/eslint-config \
-    @babel/eslint-parser \
-    @typescript-eslint/eslint-plugin \
-    @typescript-eslint/eslint-plugin-tslint \
-    @typescript-eslint/parser \
-    eslint \
-    eslint-import-resolver-typescript \
-    eslint-plugin-array-func \
-    eslint-plugin-cypress \
-    eslint-plugin-deprecation \
-    eslint-plugin-eslint-comments \
-    eslint-plugin-import \
-    eslint-plugin-jest \
-    eslint-plugin-jest-dom \
-    eslint-plugin-jest-formatting \
-    eslint-plugin-jsdoc \
-    eslint-plugin-node \
-    eslint-plugin-prefer-arrow \
-    eslint-plugin-promise \
-    eslint-plugin-rxjs \
-    eslint-plugin-simple-import-sort \
-    eslint-plugin-sonarjs \
-    eslint-plugin-testing-library \
-    eslint-plugin-unicorn \
-    tslint
-```
+    ```bash
+    npm install --save-dev \
+        @perfective/eslint-config \
+        @babel/eslint-parser \
+        @typescript-eslint/eslint-plugin \
+        @typescript-eslint/eslint-plugin-tslint \
+        @typescript-eslint/parser \
+        eslint \
+        eslint-import-resolver-typescript \
+        eslint-plugin-array-func \
+        eslint-plugin-deprecation \
+        eslint-plugin-eslint-comments \
+        eslint-plugin-import \
+        eslint-plugin-jest \
+        eslint-plugin-jest-dom \
+        eslint-plugin-jest-formatting \
+        eslint-plugin-jsdoc \
+        eslint-plugin-node \
+        eslint-plugin-prefer-arrow \
+        eslint-plugin-promise \
+        eslint-plugin-rxjs \
+        eslint-plugin-simple-import-sort \
+        eslint-plugin-sonarjs \
+        eslint-plugin-testing-library \
+        eslint-plugin-unicorn \
+        tslint
+    ```
 
-Require the configuration in your root `.eslintrc.js`.
+2. Install optional peer dependencies that add linting rules for the tools you use.
 
-```javascript
-module.exports = {
-    extends: ['@perfective/eslint-config'],
-};
-```
+    ```bash
+    npm install --save-dev \
+        eslint-plugin-cypress
+    ```
+
+    The `@perfective/eslint-config` automatically includes rules for these plugins,
+    if the dependency is installed.
+
+3. Require the configuration in your root `.eslintrc.js`.
+
+    ```javascript
+    module.exports = {
+        extends: ['@perfective/eslint-config'],
+    };
+    ```
 
 ## TSLint
 

package/config/node.js

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

package/config/plugin.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.hasEslintPlugin = exports.optionalOverrides = exports.optionalConfig = void 0;
+const node_1 = require("./node");
+function optionalConfig(plugin, rules) {
+    if (hasEslintPlugin(plugin)) {
+        return {
+            plugins: [plugin],
+            rules,
+        };
+    }
+    return {};
+}
+exports.optionalConfig = optionalConfig;
+function optionalOverrides(plugin, overrides) {
+    if (hasEslintPlugin(plugin)) {
+        return overrides;
+    }
+    return null;
+}
+exports.optionalOverrides = optionalOverrides;
+function hasEslintPlugin(plugin) {
+    if (plugin.startsWith('@')) {
+        return (0, node_1.hasNodeModule)(`${plugin}/eslint-plugin`);
+    }
+    return (0, node_1.hasNodeModule)(`eslint-plugin-${plugin}`);
+}
+exports.hasEslintPlugin = hasEslintPlugin;

package/index.js

@@ -1,4 +1,5 @@
 "use strict";
+const plugin_1 = require("./config/plugin");
 const no_extraneous_dependencies_1 = require("./rules/import/rules/no-extraneous-dependencies");
 module.exports = {
     env: {
@@ -113,7 +114,7 @@ module.exports = {
                 'rxjs/no-topromise': 'off',
             },
         },
-        {
+        (0, plugin_1.optionalOverrides)('cypress', {
             files: ['cypress/**/*.[jt]s'],
             env: {
                 'cypress/globals': true,
@@ -130,6 +131,6 @@ module.exports = {
                         capIsNewExceptions: ['Given', 'When', 'Then', 'And', 'But', 'Before', 'After'],
                     }],
             },
-        },
-    ],
+        }),
+    ].filter(Boolean),
 };

package/package.json

@@ -1,8 +1,8 @@
 {
     "name": "@perfective/eslint-config",
-    "version": "0.20.0",
+    "version": "0.21.0-alpha",
     "description": "ESLint shareable rules configuration",
-    "keywords": ["code quality", "code standard", "code style", "eslint", "eslint-config", "lint", "perfective", "tslint", "tslint-config", "typescript"],
+    "keywords": ["code quality", "code standard", "code style", "eslint", "eslint config", "lint", "perfective", "tslint", "tslint config", "typescript"],
     "author": "Andrey Mikheychik <a.mikheychik@gmail.com>",
     "homepage": "https://github.com/perfective/eslint-config",
     "repository": {
@@ -11,31 +11,36 @@
     },
     "license": "MIT",
     "peerDependencies": {
-        "@babel/eslint-parser": "^7.19.1",
-        "@typescript-eslint/eslint-plugin": "^5.53.0",
-        "@typescript-eslint/eslint-plugin-tslint": "^5.53.0",
-        "@typescript-eslint/parser": "^5.53.0",
-        "eslint": "^8.34.0",
+        "@babel/eslint-parser": "^7.21.3",
+        "@typescript-eslint/eslint-plugin": "^5.57.0",
+        "@typescript-eslint/eslint-plugin-tslint": "^5.57.0",
+        "@typescript-eslint/parser": "^5.57.0",
+        "eslint": "^8.37.0",
         "eslint-import-resolver-typescript": "^3.5.3",
         "eslint-plugin-array-func": "^3.1.8",
-        "eslint-plugin-cypress": "^2.12.1",
+        "eslint-plugin-cypress": "^2.13.1",
         "eslint-plugin-deprecation": "^1.3.3",
         "eslint-plugin-eslint-comments": "^3.2.0",
         "eslint-plugin-import": "^2.27.5",
         "eslint-plugin-jest": "^27.2.1",
         "eslint-plugin-jest-dom": "^4.0.3",
         "eslint-plugin-jest-formatting": "^3.1.0",
-        "eslint-plugin-jsdoc": "^40.0.0",
+        "eslint-plugin-jsdoc": "^40.1.0",
         "eslint-plugin-node": "^11.1.0",
         "eslint-plugin-prefer-arrow": "^1.2.3",
         "eslint-plugin-promise": "^6.1.1",
-        "eslint-plugin-rxjs": "^5.0.2",
+        "eslint-plugin-rxjs": "^5.0.3",
         "eslint-plugin-simple-import-sort": "^10.0.0",
-        "eslint-plugin-sonarjs": "^0.18.0",
+        "eslint-plugin-sonarjs": "^0.19.0",
         "eslint-plugin-testing-library": "^5.10.2",
-        "eslint-plugin-unicorn": "^45.0.2",
+        "eslint-plugin-unicorn": "^46.0.0",
         "tslint": "^6.1.3"
     },
+    "peerDependenciesMeta": {
+        "eslint-plugin-cypress": {
+            "optional": true
+        }
+    },
     "main": "./index.js",
     "directories": {
         "lib": "./"

package/rules/cypress/index.js

@@ -1,15 +1,11 @@
 "use strict";
-module.exports = {
-    plugins: [
-        'cypress',
-    ],
-    rules: {
-        'cypress/assertion-before-screenshot': 'error',
-        'cypress/no-assigning-return-values': 'error',
-        'cypress/no-async-tests': 'error',
-        'cypress/no-force': 'error',
-        'cypress/no-pause': 'error',
-        'cypress/no-unnecessary-waiting': 'error',
-        'cypress/require-data-selectors': 'error',
-    },
-};
+const plugin_1 = require("../../config/plugin");
+module.exports = (0, plugin_1.optionalConfig)('cypress', {
+    'cypress/assertion-before-screenshot': 'error',
+    'cypress/no-assigning-return-values': 'error',
+    'cypress/no-async-tests': 'error',
+    'cypress/no-force': 'error',
+    'cypress/no-pause': 'error',
+    'cypress/no-unnecessary-waiting': 'error',
+    'cypress/require-data-selectors': 'error',
+});

package/rules/eslint/layout-formatting.js

@@ -67,6 +67,7 @@ module.exports = {
                 allowArrayEnd: false,
                 allowClassStart: true,
                 allowClassEnd: false,
+                afterHashbangComment: true,
             }],
         'lines-between-class-members': ['warn', 'always', {
                 exceptAfterSingleLine: true,

package/rules/eslint/suggestions.js

@@ -44,7 +44,9 @@ module.exports = {
         'max-statements': ['off', {
                 max: 10,
             }],
-        'multiline-comment-style': ['warn', 'separate-lines'],
+        'multiline-comment-style': ['warn', 'separate-lines', {
+                checkJSDoc: false,
+            }],
         'new-cap': ['error', {
                 newIsCap: true,
                 capIsNew: true,

package/rules/typescript-eslint/extension-rules.js

@@ -51,6 +51,25 @@ module.exports = {
                 before: true,
                 after: true,
             }],
+        'lines-around-comment': 'off',
+        '@typescript-eslint/lines-around-comment': ['warn', {
+                beforeBlockComment: true,
+                afterBlockComment: false,
+                beforeLineComment: false,
+                afterLineComment: false,
+                allowBlockStart: false,
+                allowBlockEnd: false,
+                allowObjectStart: false,
+                allowObjectEnd: false,
+                allowArrayStart: false,
+                allowArrayEnd: false,
+                allowClassStart: true,
+                allowClassEnd: false,
+                allowInterfaceStart: true,
+                allowInterfaceEnd: true,
+                allowTypeStart: true,
+                allowTypeEnd: true,
+            }],
         'lines-between-class-members': 'off',
         '@typescript-eslint/lines-between-class-members': ['warn', 'always', {
                 exceptAfterSingleLine: true,

package/rules/typescript-eslint/supported-rules.js

@@ -125,6 +125,10 @@ module.exports = {
                 ignoreVoidOperator: false,
             }],
         '@typescript-eslint/no-duplicate-enum-values': 'error',
+        '@typescript-eslint/no-duplicate-type-constituents': ['error', {
+                ignoreIntersections: false,
+                ignoreUnions: false,
+            }],
         '@typescript-eslint/no-dynamic-delete': 'warn',
         '@typescript-eslint/no-empty-interface': ['off', {
                 allowSingleExtends: true,
@@ -226,6 +230,7 @@ module.exports = {
                 allowNullish: false,
                 allowNumber: false,
                 allowRegExp: false,
+                allowNever: false,
             }],
         '@typescript-eslint/sort-type-union-intersection-members': ['off', {
                 checkIntersections: true,