@croct/eslint-plugin 0.8.1 → 0.8.3

package/README.md

@@ -30,50 +30,86 @@ Webpack or Browserify:
 npm i -D @croct/eslint-plugin
 ```
 
-Then, add the following to your `.eslintrc.js` file:
+This plugin uses ESLint's [flat config format](https://eslint.org/docs/latest/use/configure/configuration-files) (ESLint v9+).
+
+### JavaScript
+
+For JavaScript projects, create an `eslint.config.mjs` file:
 
 ```js
-// Workaround for https://github.com/eslint/eslint/issues/3458
-require("@rushstack/eslint-patch/modern-module-resolution");
+import { defineConfig } from 'eslint/config';
+import croct from '@croct/eslint-plugin';
 
-module.exports = {
-   "plugins": ["@croct"]
-}
+export default defineConfig(
+    croct.configs.javascript,
+);
 ```
 
-Note the `require` call at the top of the file. This is a workaround to avoid adding the transitive dependencies of 
-the plugin to the project, which is [currently not supported by the ESLint plugin system](https://github.com/eslint/eslint/issues/3458).
-
 ### TypeScript
 
-For TypeScript projects, you need first to install the TypeScript parser:
+For TypeScript projects, create an `eslint.config.mjs` file:
 
-```sh
-npm i -D @typescript-eslint/parser
+```js
+import { defineConfig } from 'eslint/config';
+import croct from '@croct/eslint-plugin';
+
+export default defineConfig(
+    croct.configs.typescript,
+);
+```
+
+The TypeScript config includes the JavaScript preset, so there's no need to include both.
+
+### React
+
+For React projects, create an `eslint.config.mjs` file:
+
+```js
+import { defineConfig } from 'eslint/config';
+import croct from '@croct/eslint-plugin';
+
+export default defineConfig(
+    croct.configs.react,
+);
 ```
 
-Then, add the following to your `.eslintrc.js` file:
+The React config includes the JavaScript preset, so there's no need to include both.
+
+### Cypress
+
+For Cypress projects, create an `eslint.config.mjs` file:
+
+```js
+import { defineConfig } from 'eslint/config';
+import croct from '@croct/eslint-plugin';
+
+export default defineConfig(
+    croct.configs.cypress,
+);
+```
+
+The Cypress config includes the JavaScript preset, so there's no need to include both.
+
+### Custom rules
+
+You can add custom rules or override existing ones:
 
 ```js
-// Workaround for https://github.com/eslint/eslint/issues/3458
-require("@rushstack/eslint-patch/modern-module-resolution");
-
-module.exports = {
-    "parser": "@typescript-eslint/parser",
-    "plugins": [
-      "@croct"
-    ],
-    "extends": [
-      "plugin:@croct/typescript"
-    ],
-    "parserOptions": {
-      "extends": "./tsconfig.json",
-      "project": ["./tsconfig.json"]
+import { defineConfig } from 'eslint/config';
+import croct from '@croct/eslint-plugin';
+
+export default defineConfig(
+    croct.configs.typescript,
+    {
+        files: ['src/**/*.ts'],
+        rules: {
+            '@typescript-eslint/explicit-function-return-type': 'off',
+        },
     },
-}
+);
 ```
 
-For the list for available presets and rules, see the [reference documentation](docs/README.md). 
+For the list of available presets and rules, see the [reference documentation](docs/README.md). 
 
 ## Basic usage
 

package/configs/javascript.js

@@ -71,7 +71,6 @@ const baseRules = {
     'no-fallthrough': 'error',
     '@stylistic/no-floating-decimal': 'error',
     'no-global-assign': ['error', { exceptions: [] }],
-    'no-native-reassign': 'off',
     'no-implicit-coercion': ['off', {
             boolean: false,
             number: true,
@@ -159,7 +158,6 @@ const baseRules = {
             message: 'Use the exponentiation operator (**) instead.',
         }],
     'no-return-assign': ['error', 'always'],
-    'no-return-await': 'error',
     'no-script-url': 'error',
     'no-self-assign': ['error', {
             props: true,
@@ -240,10 +238,8 @@ const baseRules = {
     'no-unsafe-optional-chaining': ['error', { disallowArithmeticOperators: true }],
     'no-unused-private-class-members': 'off',
     'no-useless-backreference': 'error',
-    'no-negated-in-lhs': 'off',
     'require-atomic-updates': 'off',
     'use-isnan': 'error',
-    'valid-jsdoc': 'off',
     'valid-typeof': ['error', { requireStringLiterals: true }],
     // Style (from airbnb-base, with customizations)
     '@stylistic/array-bracket-newline': ['error', 'consistent'],
@@ -264,13 +260,7 @@ const baseRules = {
                 ignoreConsecutiveComments: true,
             },
         }],
-    '@stylistic/comma-dangle': ['error', {
-            arrays: 'always-multiline',
-            objects: 'always-multiline',
-            imports: 'always-multiline',
-            exports: 'always-multiline',
-            functions: 'always-multiline',
-        }],
+    '@stylistic/comma-dangle': ['error', 'always-multiline'],
     '@stylistic/comma-spacing': ['error', { before: false, after: true }],
     '@stylistic/comma-style': ['error', 'last', {
             exceptions: {
@@ -291,7 +281,7 @@ const baseRules = {
     'consistent-this': 'off',
     '@stylistic/eol-last': ['error', 'always'],
     '@stylistic/function-call-argument-newline': ['error', 'consistent'],
-    'func-call-spacing': ['error', 'never'],
+    '@stylistic/function-call-spacing': ['error', 'never'],
     'func-name-matching': ['off', 'always', {
             includeCommonJSModuleExports: false,
             considerPropertyDescriptor: true,
@@ -346,7 +336,7 @@ const baseRules = {
             ignoreComments: false,
         },
     ],
-    'jsx-quotes': ['error', 'prefer-double'],
+    '@stylistic/jsx-quotes': ['error', 'prefer-double'],
     '@stylistic/key-spacing': ['error', { beforeColon: false, afterColon: true }],
     '@stylistic/keyword-spacing': ['error', {
             before: true,
@@ -365,12 +355,8 @@ const baseRules = {
     '@stylistic/linebreak-style': ['error', 'unix'],
     '@stylistic/lines-between-class-members': ['error', 'always', { exceptAfterSingleLine: false }],
     '@stylistic/lines-around-comment': 'off',
-    'lines-around-directive': ['error', {
-            before: 'always',
-            after: 'always',
-        }],
     'max-depth': ['off', 4],
-    'max-len': [
+    '@stylistic/max-len': [
         'error',
         {
             code: 120,
@@ -395,7 +381,7 @@ const baseRules = {
     'max-nested-callbacks': 'off',
     'max-params': ['off', 3],
     'max-statements': ['off', 10],
-    'max-statements-per-line': ['off', { max: 1 }],
+    '@stylistic/max-statements-per-line': ['off', { max: 1 }],
     '@stylistic/multiline-comment-style': ['off', 'starred-block'],
     '@stylistic/multiline-ternary': ['error', 'always-multiline'],
     'new-cap': ['error', {
@@ -405,15 +391,13 @@ const baseRules = {
             capIsNewExceptions: ['Immutable.Map', 'Immutable.Set', 'Immutable.List'],
         }],
     '@stylistic/new-parens': 'error',
-    'newline-after-var': 'off',
-    'newline-before-return': 'off',
     '@stylistic/newline-per-chained-call': 'off',
     'no-array-constructor': 'error',
     'no-bitwise': 'off',
     'no-continue': 'off',
     'no-inline-comments': 'off',
     'no-lonely-if': 'error',
-    'no-mixed-operators': ['error', {
+    '@stylistic/no-mixed-operators': ['error', {
             groups: [
                 ['%', '**'],
                 ['%', '+'],
@@ -427,7 +411,7 @@ const baseRules = {
             ],
             allowSamePrecedence: false,
         }],
-    'no-mixed-spaces-and-tabs': 'error',
+    '@stylistic/no-mixed-spaces-and-tabs': 'error',
     'no-multi-assign': ['error'],
     '@stylistic/no-multiple-empty-lines': [
         'error',
@@ -439,7 +423,6 @@ const baseRules = {
     ],
     'no-negated-condition': 'off',
     'no-nested-ternary': 'error',
-    'no-new-object': 'error',
     'no-plusplus': 'off',
     'no-restricted-syntax': [
         'error',
@@ -447,8 +430,7 @@ const baseRules = {
         'LabeledStatement',
         'WithStatement',
     ],
-    'no-spaced-func': 'error',
-    'no-tabs': 'error',
+    '@stylistic/no-tabs': 'error',
     'no-ternary': 'off',
     '@stylistic/no-trailing-spaces': ['error', {
             skipBlankLines: false,
@@ -472,7 +454,7 @@ const baseRules = {
     'one-var': ['error', 'never'],
     '@stylistic/one-var-declaration-per-line': ['error', 'always'],
     'operator-assignment': ['error', 'always'],
-    '@stylistic/operator-linebreak': ['error', 'before', { overrides: { '=': 'none' } }],
+    '@stylistic/operator-linebreak': ['error', 'before', { overrides: { '=': 'ignore' } }],
     '@stylistic/padded-blocks': ['error', {
             blocks: 'never',
             classes: 'never',
@@ -547,9 +529,8 @@ const baseRules = {
     ],
     'prefer-exponentiation-operator': 'error',
     'prefer-object-spread': 'error',
-    '@stylistic/quote-props': ['error', 'as-needed', { keywords: false, unnecessary: true, numbers: false }],
+    '@stylistic/quote-props': ['error', 'as-needed', { keywords: false, unnecessary: true, numbers: true }],
     '@stylistic/quotes': ['error', 'single', { avoidEscape: true }],
-    'require-jsdoc': 'off',
     '@stylistic/semi': ['error', 'always'],
     '@stylistic/semi-spacing': ['error', { before: false, after: true }],
     '@stylistic/semi-style': ['error', 'last'],
@@ -640,7 +621,6 @@ const baseRules = {
             enforceForRenamedProperties: false,
         }],
     'prefer-numeric-literals': 'error',
-    'prefer-reflect': 'off',
     'prefer-rest-params': 'error',
     'prefer-spread': 'error',
     'prefer-template': 'error',
@@ -657,7 +637,6 @@ const baseRules = {
     '@stylistic/yield-star-spacing': ['error', 'after'],
     // Variables (from airbnb-base)
     'init-declarations': 'off',
-    'no-catch-shadow': 'off',
     'no-delete-var': 'error',
     'no-label-var': 'error',
     'no-restricted-globals': [
@@ -749,21 +728,8 @@ const baseRules = {
     ],
     // Strict (from airbnb-base)
     strict: ['error', 'never'],
-    // Node (from airbnb-base)
-    'callback-return': 'off',
-    'global-require': 'error',
-    'handle-callback-err': 'off',
-    'no-buffer-constructor': 'error',
-    'no-mixed-requires': ['off', false],
-    'no-new-require': 'error',
-    'no-path-concat': 'error',
-    'no-process-env': 'off',
-    'no-process-exit': 'off',
-    'no-restricted-modules': 'off',
-    'no-sync': 'off',
     // Import rules (from airbnb-base)
     'import-x/no-unresolved': 'off',
-    'import-x/named': 'error',
     'import-x/default': 'off',
     'import-x/namespace': 'off',
     'import-x/export': 'error',
@@ -776,7 +742,6 @@ const baseRules = {
     'import-x/no-amd': 'error',
     'import-x/no-nodejs-modules': 'off',
     'import-x/first': 'error',
-    'import-x/imports-first': 'off',
     'import-x/no-duplicates': 'error',
     'import-x/no-namespace': 'off',
     'import-x/extensions': [
@@ -898,15 +863,5 @@ function createJavaScriptConfig(plugin) {
                 ...baseRules,
             },
         },
-        {
-            name: '@croct/javascript/tests',
-            files: [
-                'src/**/*.test.js',
-                'test/**/*.js',
-            ],
-            rules: {
-                'no-new-object': 'off',
-            },
-        },
     ];
 }

package/configs/typescript.js

@@ -29,12 +29,11 @@ const baseRules = {
             ignoreTypeValueShadow: true,
             ignoreFunctionTypeParameterNameValueShadow: true,
         }],
-    '@typescript-eslint/no-empty-interface': 'off',
     '@typescript-eslint/explicit-member-accessibility': [
         'error',
     ],
     '@typescript-eslint/explicit-module-boundary-types': 'off',
-    '@typescript-eslint/explicit-function-return-type': ['error'],
+    '@typescript-eslint/explicit-function-return-type': ['error', { allowExpressions: true }],
     '@typescript-eslint/no-explicit-any': 'off',
     'no-use-before-define': 'off',
     '@typescript-eslint/no-use-before-define': 'off',
@@ -75,6 +74,23 @@ const baseRules = {
         }],
     'no-undef': 'off',
     '@typescript-eslint/no-namespace': 'off',
+    '@typescript-eslint/restrict-template-expressions': 'off',
+    '@typescript-eslint/consistent-type-imports': 'error',
+    // Disable rules that turn `any` into `unknown`, places where `unknown` is the preferred type
+    // have that type already.
+    '@typescript-eslint/no-unsafe-argument': 'off',
+    '@typescript-eslint/no-unsafe-assignment': 'off',
+    '@typescript-eslint/no-unsafe-call': 'off',
+    '@typescript-eslint/no-unsafe-enum-comparison': 'off',
+    '@typescript-eslint/no-unsafe-member-access': 'off',
+    '@typescript-eslint/no-unsafe-return': 'off',
+    '@typescript-eslint/no-unsafe-unary-minus': 'off',
+    // Breaks with overloaded functions that implement both callback and Promise signatures
+    '@typescript-eslint/no-misused-promises': 'off',
+    // Doesn't detect classes that implement `toString` method
+    '@typescript-eslint/no-base-to-string': 'off',
+    // Conflict with TS promise ignore explicitly (void Promise)
+    'no-void': 'off',
 };
 // Factory function to create TypeScript config with the plugin reference
 function createTypescriptConfig(plugin, javascriptConfig) {
@@ -99,13 +115,11 @@ function createTypescriptConfig(plugin, javascriptConfig) {
             rules: baseRules,
         },
         {
-            name: '@croct/typescript/tests',
-            files: [
-                'src/**/*.test.ts',
-                'test/**/*.ts',
-            ],
+            name: '@croct/typescript-test-files',
+            files: ['**/*.test.ts', '**/*.test.tsx'],
             rules: {
-                'no-new-object': 'off',
+                // Prevent false warnings when checking mocked interfaces
+                '@typescript-eslint/unbound-method': 'off',
             },
         },
     ];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@croct/eslint-plugin",
-  "version": "0.8.1",
+  "version": "0.8.3",
   "description": "ESLint rules and presets applied to all Croct JavaScript projects.",
   "license": "MIT",
   "author": {
@@ -53,7 +53,7 @@
     "typescript-eslint": "^8.53.0"
   },
   "devDependencies": {
-    "@types/jest": "^29.5.14",
+    "@types/jest": "^30.0.0",
     "@types/semver": "^7.5.8",
     "@typescript-eslint/parser": "^8.53.0",
     "@typescript-eslint/rule-tester": "^8.53.0",
@@ -62,7 +62,7 @@
     "eslint": "^9.28.0",
     "eslint-plugin-eslint-plugin": "^6.4.0",
     "eslint-plugin-self": "^1.2.1",
-    "jest": "^29.7.0",
+    "jest": "^30.0.0",
     "ts-jest": "^29.3.4",
     "typescript": "~5.9.0"
   },