@dr.pogodin/eslint-configs 0.1.4 → 0.2.0

package/README.md

@@ -21,9 +21,11 @@ This project is invisioned as a replacement for AirBnB ESLint configurations
 - [Getting Started]
 - [Provided Configs]
   - [`configs.javascript`]
+  - [`configs.javascriptNoPerf`]
   - [`configs.jest`]
   - [`configs.react`]
   - [`configs.typescript`]
+  - [`configs.typescriptNoPerf`]
 
 ## Getting Started
 [Getting Started]: #getting-started
@@ -116,6 +118,18 @@ them the following rule sets:
   the `recommended` rule set, with minor overrides, and many additional rules
   enabled.
 
+- [Perfectionist] — the recommended rule set, with minor overrides,
+  such as the custom alphabet that places uppercase characters before lowercase
+  ones, and allowance to use empty lines to separate entities into different
+  sorting groups.
+
+### `configs.javascriptNoPerf`
+[`configs.javascriptNoPerf`]: #configsjavascriptnoperf
+
+The same as [`configs.javascript`] above, but without [Perfectionist] rules.
+Essentially, it is equivalent to [`configs.javascript`] from this library prior
+to its [v0.2.0](https://github.com/birdofpreyru/eslint-configs/releases/tag/v0.2.0) release.
+
 ### `configs.jest`
 [`configs.jest`]: #configsjest
 
@@ -162,6 +176,14 @@ and it applies to them the following rule sets:
   the `recommendedTypeChecked` and `stylisticTypeChecked` rule sets, with minor
   overrides, and many additional rules enabled.
 
+### `configs.typescriptNoPerf`
+[`configs.typescriptNoPerf`]: #configstypescriptnoperf
+
+The same as [`configs.typescript`] above, but without [Perfectionist] rules.
+Essentially, it is equivalent to [`configs.typescript`] from this library prior
+to its [v0.2.0](https://github.com/birdofpreyru/eslint-configs/releases/tag/v0.2.0) release.
+
 [Babel]: https://babeljs.io
 [ESLint]: https://eslint.org
-[eslint-config-airbnb]: https://www.npmjs.com/package/eslint-config-airbnb
+[eslint-config-airbnb]: https://www.npmjs.com/package/eslint-config-airbnb
+[Perfectionist]: https://perfectionist.dev

package/config/index.js

@@ -1,13 +1,15 @@
-import javascript from './javascript.js';
+import javascript, { javascriptNoPerf } from './javascript.js';
 import jest from './jest.js';
 import react from './react.js';
-import typescript from './typescript.js';
+import typescript, { typescriptNoPerf } from './typescript.js';
 
 export default {
   configs: {
     javascript,
+    javascriptNoPerf,
     jest,
     react,
     typescript,
+    typescriptNoPerf,
   },
 };

package/config/javascript.js

@@ -2,32 +2,22 @@
 
 import { defineConfig } from 'eslint/config';
 import importPlugin from 'eslint-plugin-import';
+import perfectionist from 'eslint-plugin-perfectionist';
+import { Alphabet } from 'eslint-plugin-perfectionist/alphabet';
 
 import babelParser from '@babel/eslint-parser';
 import babelPlugin from '@babel/eslint-plugin';
 import js from '@eslint/js';
 import stylisticPlugin from '@stylistic/eslint-plugin';
 
-export default defineConfig([{
-  extends: [
+function newConfig({ noPerf } = {}) {
+  const extentions = [
     'js/recommended',
     '@stylistic/recommended',
     importPlugin.flatConfigs.recommended,
-  ],
-  languageOptions: {
-    parser: babelParser,
-  },
-  linterOptions: {
-    reportUnusedDisableDirectives: 'error',
-    reportUnusedInlineConfigs: 'error',
-  },
-  name: 'dr.pogodin/javascript',
-  plugins: {
-    '@babel': babelPlugin,
-    '@stylistic': stylisticPlugin,
-    js,
-  },
-  rules: {
+  ];
+
+  const rules = {
     // These rules are provided by "@babel/eslint-plugin", and they require
     // to disable (to not enable) their counterparts from ESLint core.
     '@babel/new-cap': 'error',
@@ -72,9 +62,6 @@ export default defineConfig([{
     'import/no-unused-modules': 'error',
     'import/no-useless-path-segments': 'error',
     'import/no-webpack-loader-syntax': 'error',
-    'import/order': ['error', {
-      groups: ['builtin', 'external', 'internal', 'parent', 'sibling', 'index'],
-    }],
 
     // These rules are provided by "@stylistic/eslint-plugin",
     // and (re-)configured for our taste, somewhat differently from
@@ -265,28 +252,71 @@ export default defineConfig([{
     'require-atomic-updates': 'error',
     'require-await': 'error',
     'require-yield': 'error',
-
-    // TODO: Disabled for now, as there is one thing I don't like about it:
-    // in TypeScript it sorts type imports together with other imported members,
-    // while I'd prefer to have all type member imports first, followed by other
-    // imported members after.
-    /*
-    'sort-imports': ['error', {
-      ignoreDeclarationSort: true,
-    }],
-    */
-
-    'sort-keys': ['error', 'asc', {
-      allowLineSeparatedGroups: true,
-    }],
     'symbol-description': 'error',
     'unicode-bom': 'error',
     yoda: 'error',
-  },
-  settings: {
+  };
+
+  const settings = {
     'import/resolver': {
       node: true,
       typescript: true,
     },
-  },
-}]);
+  };
+
+  if (noPerf) {
+    // Without Perfectionist. These rules are similar to those Perfectionist
+    // provides, but they are provided by other plugins, and we used them in
+    // older config versions, thus we keep enabling them for the legacy,
+    // "no Perfectionist" config variant.
+    rules['import/order'] = ['error', {
+      groups: ['builtin', 'external', 'internal', 'parent', 'sibling', 'index'],
+    }];
+    rules['sort-keys'] = ['error', 'asc', {
+      allowLineSeparatedGroups: true,
+    }];
+  } else {
+    // With Perfectionist.
+    // eslint-disable-next-line import/no-named-as-default-member
+    extentions.push(perfectionist.configs['recommended-custom']);
+
+    // TODO: For now it is disabled because of the following Perfectionist bug:
+    // https://github.com/azat-io/eslint-plugin-perfectionist/issues/688
+    // and we'll keep using "import/order" rule here until the issue is addressed.
+    rules['perfectionist/sort-imports'] = 'off';
+    rules['import/order'] = ['error', {
+      groups: ['builtin', 'external', 'internal', 'parent', 'sibling', 'index'],
+    }];
+
+    settings.perfectionist = {
+      alphabet: Alphabet.generateRecommendedAlphabet()
+        .placeAllWithCaseBeforeAllWithOtherCase('uppercase')
+        .getCharacters(),
+      ignoreCase: false,
+      partitionByNewLine: true,
+    };
+  }
+
+  return defineConfig([{
+    extends: extentions,
+    languageOptions: {
+      parser: babelParser,
+    },
+    linterOptions: {
+      reportUnusedDisableDirectives: 'error',
+      reportUnusedInlineConfigs: 'error',
+    },
+    name: 'dr.pogodin/javascript',
+    plugins: {
+      '@babel': babelPlugin,
+      '@stylistic': stylisticPlugin,
+      js,
+    },
+    rules,
+    settings,
+  }]);
+}
+
+export const javascriptNoPerf = newConfig({ noPerf: true });
+
+export default newConfig();

package/config/react.js

@@ -29,6 +29,9 @@ export default defineConfig([{
 
   rules: {
     // Rules provided by "eslint-plugin-perfectionist"
+    // NOTE: Not necessary when default JS config is used, which already
+    // includes it... but we keep it around to avoid any changes for consumers
+    // who may include this config without our default JS/TS one.
     'perfectionist/sort-jsx-props': ['error', {
       type: 'natural',
     }],

package/config/typescript.js

@@ -1,101 +1,120 @@
+import { defineConfig } from 'eslint/config';
 import tsEsLint from 'typescript-eslint';
 
-import jsConfig from './javascript.js';
-
-export default tsEsLint.config(
-  {
-    name: 'dr.pogodin/typescript',
-
-    extends: [
-      jsConfig,
-      tsEsLint.configs.recommendedTypeChecked,
-      tsEsLint.configs.stylisticTypeChecked,
-    ],
-    files: ['**/*.ts', '**/*.tsx'],
-    languageOptions: {
-      parserOptions: {
-        projectService: true,
+import jsConfig, { javascriptNoPerf } from './javascript.js';
+
+function newConfig({ noPerf } = {}) {
+  let extentions = [
+    jsConfig,
+    tsEsLint.configs.recommendedTypeChecked,
+    tsEsLint.configs.stylisticTypeChecked,
+  ];
+
+  const rules = {
+    // TypeScript takes care of the same, in a better way.
+    '@babel/new-cap': 'off',
+    '@babel/no-undef': 'off',
+
+    // It does not support type imports, and TypeScript itself does necessary
+    // checks for imports anyway.
+    'import/named': 'off',
+
+    '@typescript-eslint/array-type': ['error', {
+      default: 'array-simple',
+    }],
+    '@typescript-eslint/class-methods-use-this': 'error',
+    '@typescript-eslint/consistent-return': 'error',
+    '@typescript-eslint/consistent-type-definitions': ['error', 'type'],
+    '@typescript-eslint/consistent-type-exports': 'error',
+    '@typescript-eslint/consistent-type-imports': 'error',
+    '@typescript-eslint/default-param-last': 'error',
+    '@typescript-eslint/explicit-module-boundary-types': 'error',
+    '@typescript-eslint/no-confusing-void-expression': 'error',
+    '@typescript-eslint/no-deprecated': 'warn',
+    '@typescript-eslint/no-dupe-class-members': 'error',
+    '@typescript-eslint/no-empty-interface': 'error',
+    '@typescript-eslint/no-extraneous-class': 'error',
+    '@typescript-eslint/no-import-type-side-effects': 'error',
+    '@typescript-eslint/no-inferrable-types': 'off',
+    '@typescript-eslint/no-invalid-this': 'error',
+    '@typescript-eslint/no-invalid-void-type': 'error',
+    '@typescript-eslint/no-loop-func': 'error',
+    '@typescript-eslint/no-loss-of-precision': 'error',
+    '@typescript-eslint/no-meaningless-void-operator': 'error',
+    '@typescript-eslint/no-misused-spread': 'error',
+    '@typescript-eslint/no-mixed-enums': 'error',
+    '@typescript-eslint/no-non-null-asserted-nullish-coalescing': 'error',
+    '@typescript-eslint/no-redeclare': 'error',
+    '@typescript-eslint/no-unnecessary-type-conversion': 'error',
+    '@typescript-eslint/no-useless-default-assignment': 'error',
+
+    // NOTE: The core rule variant reports incorrect errors on TypeScript
+    // code, thus disabled.
+    '@typescript-eslint/no-shadow': 'error',
+    'no-shadow': 'off',
+
+    '@typescript-eslint/no-unnecessary-boolean-literal-compare': 'error',
+    '@typescript-eslint/no-unnecessary-condition': 'error',
+    '@typescript-eslint/no-unnecessary-parameter-property-assignment': 'error',
+    '@typescript-eslint/no-unnecessary-qualifier': 'error',
+    '@typescript-eslint/no-unnecessary-template-expression': 'error',
+    '@typescript-eslint/no-unnecessary-type-arguments': 'error',
+
+    // NOTE: Disables the base rule as it can report incorrect errors.
+    '@typescript-eslint/no-unused-private-class-members': 'error',
+    'no-unused-private-class-members': 'off',
+
+    '@typescript-eslint/no-use-before-define': 'error',
+    '@typescript-eslint/no-useless-constructor': 'error',
+    '@typescript-eslint/no-useless-empty-export': 'error',
+    '@typescript-eslint/parameter-properties': ['error', {
+      prefer: 'parameter-property',
+    }],
+
+    // NOTE: The core variant of this rule, disabled below, does not work
+    // correctly for TypeScript code in some edge cases.
+    '@typescript-eslint/prefer-destructuring': 'error',
+    'prefer-destructuring': 'off',
+
+    '@typescript-eslint/prefer-enum-initializers': 'error',
+    '@typescript-eslint/prefer-literal-enum-member': 'error',
+    '@typescript-eslint/prefer-reduce-type-parameter': 'error',
+    '@typescript-eslint/prefer-regexp-exec': 'off',
+    '@typescript-eslint/prefer-return-this-type': 'error',
+    '@typescript-eslint/promise-function-async': 'error',
+    '@typescript-eslint/related-getter-setter-pairs': 'error',
+    '@typescript-eslint/require-array-sort-compare': 'error',
+    '@typescript-eslint/strict-void-return': 'error',
+    '@typescript-eslint/switch-exhaustiveness-check': 'error',
+    '@typescript-eslint/typedef': 'error',
+    '@typescript-eslint/unified-signatures': 'error',
+    '@typescript-eslint/use-unknown-in-catch-callback-variable': 'error',
+  };
+
+  if (noPerf) {
+    extentions = [javascriptNoPerf, ...extentions];
+  } else {
+    extentions = [jsConfig, ...extentions];
+
+    rules['adjacent-overload-signatures'] = 'off';
+  }
+
+  return defineConfig(
+    {
+      name: 'dr.pogodin/typescript',
+
+      extends: extentions,
+      files: ['**/*.ts', '**/*.tsx'],
+      languageOptions: {
+        parserOptions: {
+          projectService: true,
+        },
       },
+      rules,
     },
-    rules: {
-      // TypeScript takes care of the same, in a better way.
-      '@babel/new-cap': 'off',
-      '@babel/no-undef': 'off',
-
-      // It does not support type imports, and TypeScript itself does necessary
-      // checks for imports anyway.
-      'import/named': 'off',
-
-      '@typescript-eslint/array-type': ['error', {
-        default: 'array-simple',
-      }],
-      '@typescript-eslint/class-methods-use-this': 'error',
-      '@typescript-eslint/consistent-return': 'error',
-      '@typescript-eslint/consistent-type-definitions': ['error', 'type'],
-      '@typescript-eslint/consistent-type-exports': 'error',
-      '@typescript-eslint/consistent-type-imports': 'error',
-      '@typescript-eslint/default-param-last': 'error',
-      '@typescript-eslint/explicit-module-boundary-types': 'error',
-      '@typescript-eslint/no-confusing-void-expression': 'error',
-      '@typescript-eslint/no-deprecated': 'warn',
-      '@typescript-eslint/no-dupe-class-members': 'error',
-      '@typescript-eslint/no-empty-interface': 'error',
-      '@typescript-eslint/no-extraneous-class': 'error',
-      '@typescript-eslint/no-import-type-side-effects': 'error',
-      '@typescript-eslint/no-inferrable-types': 'off',
-      '@typescript-eslint/no-invalid-this': 'error',
-      '@typescript-eslint/no-invalid-void-type': 'error',
-      '@typescript-eslint/no-loop-func': 'error',
-      '@typescript-eslint/no-loss-of-precision': 'error',
-      '@typescript-eslint/no-meaningless-void-operator': 'error',
-      '@typescript-eslint/no-misused-spread': 'error',
-      '@typescript-eslint/no-mixed-enums': 'error',
-      '@typescript-eslint/no-non-null-asserted-nullish-coalescing': 'error',
-      '@typescript-eslint/no-redeclare': 'error',
-      '@typescript-eslint/no-unnecessary-type-conversion': 'error',
-      '@typescript-eslint/no-useless-default-assignment': 'error',
-
-      // NOTE: The core rule variant reports incorrect errors on TypeScript
-      // code, thus disabled.
-      '@typescript-eslint/no-shadow': 'error',
-      'no-shadow': 'off',
-
-      '@typescript-eslint/no-unnecessary-boolean-literal-compare': 'error',
-      '@typescript-eslint/no-unnecessary-condition': 'error',
-      '@typescript-eslint/no-unnecessary-parameter-property-assignment': 'error',
-      '@typescript-eslint/no-unnecessary-qualifier': 'error',
-      '@typescript-eslint/no-unnecessary-template-expression': 'error',
-      '@typescript-eslint/no-unnecessary-type-arguments': 'error',
-
-      // NOTE: Disables the base rule as it can report incorrect errors.
-      '@typescript-eslint/no-unused-private-class-members': 'error',
-      'no-unused-private-class-members': 'off',
-
-      '@typescript-eslint/no-use-before-define': 'error',
-      '@typescript-eslint/no-useless-constructor': 'error',
-      '@typescript-eslint/no-useless-empty-export': 'error',
-      '@typescript-eslint/parameter-properties': ['error', {
-        prefer: 'parameter-property',
-      }],
-
-      // NOTE: The core variant of this rule, disabled below, does not work
-      // correctly for TypeScript code in some edge cases.
-      '@typescript-eslint/prefer-destructuring': 'error',
-      'prefer-destructuring': 'off',
-
-      '@typescript-eslint/prefer-enum-initializers': 'error',
-      '@typescript-eslint/prefer-literal-enum-member': 'error',
-      '@typescript-eslint/prefer-reduce-type-parameter': 'error',
-      '@typescript-eslint/prefer-regexp-exec': 'off',
-      '@typescript-eslint/prefer-return-this-type': 'error',
-      '@typescript-eslint/promise-function-async': 'error',
-      '@typescript-eslint/related-getter-setter-pairs': 'error',
-      '@typescript-eslint/require-array-sort-compare': 'error',
-      '@typescript-eslint/strict-void-return': 'error',
-      '@typescript-eslint/switch-exhaustiveness-check': 'error',
-      '@typescript-eslint/typedef': 'error',
-      '@typescript-eslint/unified-signatures': 'error',
-      '@typescript-eslint/use-unknown-in-catch-callback-variable': 'error',
-    },
-  },
-);
+  );
+}
+
+export const typescriptNoPerf = newConfig({ noPerf: true });
+
+export default newConfig();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dr.pogodin/eslint-configs",
-  "version": "0.1.4",
+  "version": "0.2.0",
   "description": "ESLint configurations for TypeScript and/or React projects",
   "type": "module",
   "main": "./config/index.js",
@@ -40,7 +40,7 @@
     "eslint-plugin-import": "^2.32.0",
     "eslint-plugin-jest": "^29.12.1",
     "eslint-plugin-jsx-a11y": "^6.10.2",
-    "eslint-plugin-perfectionist": "^5.3.1",
+    "eslint-plugin-perfectionist": "^5.4.0",
     "eslint-plugin-react": "^7.37.4",
     "eslint-plugin-react-hooks": "^6.1.1",
     "typescript": "^5.9.3",