@mrpalmer/eslint-config 2.1.0 → 2.2.0

package/.turbo/turbo-build.log

@@ -0,0 +1,8 @@
+
+> @mrpalmer/eslint-config@2.2.0 prebuild
+> rm -rf types
+
+
+> @mrpalmer/eslint-config@2.2.0 build
+> tsc
+

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @mrpalmer/eslint-config
 
+## 2.2.0
+
+### Minor Changes
+
+- afbdd32: Replace `eslint-plugin-react` with `@eslint-react/eslint-plugin`
+
+### Patch Changes
+
+- 1e43272: Update ESLint plugins
+- 32711bf: Fix order of configs in "all"
+- df14ce7: Export TypeScript types
+- Updated dependencies [96a657e]
+  - @mrpalmer/eslint-plugin@1.0.1
+
 ## 2.1.0
 
 ### Minor Changes

package/configs/base.js

@@ -227,6 +227,7 @@ export default config(
       'import-x/no-webpack-loader-syntax': 'error',
       'import-x/order': 'off',
       'import-x/prefer-default-export': 'off',
+      'import-x/prefer-namespace-import': 'off',
       'import-x/unambiguous': 'off',
     },
     settings: {

package/configs/jest.js

@@ -36,7 +36,9 @@ export default tseslint.config(
     name: 'mrpalmer/jest',
 
     rules: {
-      'react/display-name': 'off', // we don't need a display name in test files
+      // we don't need a display name in test files
+      '@eslint-react/no-missing-component-display-name': 'off',
+      '@eslint-react/no-missing-context-display-name': 'off',
 
       'jest/consistent-test-it': 'off',
       'jest/max-expects': 'off',
@@ -61,6 +63,7 @@ export default tseslint.config(
       'jest/prefer-called-with': 'error',
       'jest/prefer-comparison-matcher': 'warn',
       'jest/prefer-each': 'warn',
+      'jest/prefer-ending-with-an-expect': 'warn',
       'jest/prefer-equality-matcher': 'warn',
       'jest/prefer-expect-assertions': 'off',
       'jest/prefer-expect-resolves': 'off',
@@ -82,6 +85,7 @@ export default tseslint.config(
       ...(hasTestingLibrary
         ? {
             'testing-library/consistent-data-testid': 'off',
+            'testing-library/no-test-id-queries': 'warn',
             'testing-library/prefer-explicit-assert': 'warn',
             'testing-library/prefer-implicit-assert': 'off',
             'testing-library/prefer-query-matchers': 'off',

package/configs/react.js

@@ -1,8 +1,9 @@
+import pluginReact from '@eslint-react/eslint-plugin'
 import pluginJsxA11y from 'eslint-plugin-jsx-a11y'
-import pluginReact from 'eslint-plugin-react'
 import pluginReactHooks from 'eslint-plugin-react-hooks'
 import globals from 'globals'
 import tseslint from 'typescript-eslint'
+import * as deprecated from '../utils/deprecated.js'
 import {
   getAllDependencies,
   getMinimumSupportedVersion,
@@ -13,19 +14,18 @@ const oldestSupportedReactVersion = '16.5.2'
 const allDeps = getAllDependencies()
 const minimumSupportedReactVersion =
   getMinimumSupportedVersion(allDeps, 'react') ?? oldestSupportedReactVersion
-const hasPropTypes = Object.hasOwn(allDeps, 'prop-types')
 
-// jsx-a11y/label-has-for is deprecated but still defined in the recommended config
-delete pluginJsxA11y.flatConfigs.recommended.rules['jsx-a11y/label-has-for']
+const jsxA11yRecommended = deprecated.remove(
+  pluginJsxA11y.flatConfigs.recommended,
+  // jsx-a11y/label-has-for is deprecated but still defined in the recommended config
+  ['jsx-a11y/label-has-for']
+)
 
 export default tseslint.config(
   {
     extends: [
-      {
-        name: 'react/recommended',
-        ...pluginReact.configs.flat.recommended,
-      },
-      pluginJsxA11y.flatConfigs.recommended,
+      pluginReact.configs.recommended,
+      jsxA11yRecommended,
       {
         name: 'react-hooks/recommended',
         plugins: {
@@ -42,113 +42,75 @@ export default tseslint.config(
     },
     name: 'mrpalmer/react',
     rules: {
-      'react/boolean-prop-naming': 'off',
-      'react/button-has-type': 'off',
-      'react/checked-requires-onchange-or-readonly': 'error',
-      'react/default-props-match-prop-types': hasPropTypes ? 'error' : 'off',
-      'react/destructuring-assignment': 'off',
-      'react/forbid-component-props': 'off',
-      'react/forbid-dom-props': 'off',
-      'react/forbid-elements': 'off',
-      'react/forbid-foreign-prop-types': hasPropTypes ? 'error' : 'off',
-      'react/forbid-prop-types': 'off',
-      'react/forward-ref-uses-ref': 'error',
-      'react/function-component-definition': 'off',
-      'react/hook-use-state': 'off',
-      'react/iframe-missing-sandbox': 'warn',
-      'react/jsx-boolean-value': 'off',
-      'react/jsx-child-element-spacing': 'warn',
-      'react/jsx-closing-bracket-location': 'off',
-      'react/jsx-closing-tag-location': 'off',
-      'react/jsx-curly-brace-presence': [
-        'warn',
-        { children: 'ignore', propElementValues: 'always', props: 'never' },
-      ],
-      'react/jsx-curly-newline': 'off',
-      'react/jsx-curly-spacing': 'off',
-      'react/jsx-equals-spacing': 'off',
-      'react/jsx-filename-extension': ['error', { extensions: ['.js'] }],
-      'react/jsx-first-prop-new-line': 'off',
-      'react/jsx-fragments': 'off',
-      'react/jsx-handler-names': 'off',
-      'react/jsx-indent': 'off',
-      'react/jsx-indent-props': 'off',
-      'react/jsx-max-depth': 'off',
-      'react/jsx-max-props-per-line': 'off',
-      'react/jsx-newline': 'off',
-      'react/jsx-no-bind': 'off',
-      'react/jsx-no-constructed-context-values': 'off',
-      'react/jsx-no-leaked-render': 'off',
-      'react/jsx-no-literals': 'off',
-      'react/jsx-no-script-url': 'error',
-      'react/jsx-no-useless-fragment': 'warn',
-      'react/jsx-one-expression-per-line': 'off',
-      'react/jsx-pascal-case': 'error',
-      'react/jsx-props-no-multi-spaces': 'off',
-      'react/jsx-props-no-spread-multi': 'warn',
-      'react/jsx-props-no-spreading': 'off',
-      'react/jsx-sort-props': 'off',
-      'react/jsx-tag-spacing': 'off',
-      'react/jsx-wrap-multilines': 'off',
-      'react/no-access-state-in-setstate': 'error',
-      'react/no-adjacent-inline-elements': 'off',
-      'react/no-array-index-key': 'off', // sometimes you don't care about the issues, or they don't apply
-      'react/no-arrow-function-lifecycle': 'error',
-      'react/no-danger': 'off',
-      'react/no-did-mount-set-state': 'error',
-      'react/no-did-update-set-state': 'error',
-      'react/no-invalid-html-attribute': 'error',
-      'react/no-multi-comp': 'off',
-      'react/no-namespace': 'error',
-      'react/no-object-type-as-default-prop': 'warn',
-      'react/no-redundant-should-component-update': 'error',
-      'react/no-set-state': 'off',
-      'react/no-this-in-sfc': 'error',
-      'react/no-typos': 'error',
-      'react/no-unescaped-entities': 'warn',
-      'react/no-unsafe': 'warn', // if you need it there should be a comment explaining why
-      'react/no-unstable-nested-components': ['error', { allowAsProps: true }],
-      'react/no-unused-class-component-methods': 'error',
-      'react/no-unused-prop-types': hasPropTypes ? 'error' : 'off',
-      'react/no-unused-state': 'error',
-      'react/no-will-update-set-state': 'error',
-      'react/prefer-es6-class': 'off',
-      'react/prefer-exact-props': 'off',
-      'react/prefer-read-only-props': 'off',
-      'react/prefer-stateless-function': 'off',
-      'react/prop-types': hasPropTypes ? 'error' : 'off',
-      'react/require-default-props': 'off', // sometimes the default value is undefined so that's fine...
-      'react/require-optimization': 'off',
-      'react/self-closing-comp': 'error',
-      'react/sort-comp': 'off',
-      'react/sort-default-props': 'off',
-      'react/sort-prop-types': 'off',
-      'react/state-in-constructor': 'off',
-      'react/static-property-placement': 'off',
-      'react/style-prop-object': 'error',
-      'react/void-dom-elements-no-children': 'error',
-
       'jsx-a11y/lang': 'error',
       'jsx-a11y/no-aria-hidden-on-focusable': 'off',
       'jsx-a11y/no-autofocus': 'off',
       'jsx-a11y/prefer-tag-over-role': 'off',
       'jsx-a11y/tabindex-no-positive': 'warn',
+
+      '@eslint-react/avoid-shorthand-boolean': 'off',
+      '@eslint-react/avoid-shorthand-fragment': 'off',
+      '@eslint-react/jsx-no-iife': 'warn',
+      '@eslint-react/jsx-no-undef': 'error',
+      '@eslint-react/no-children-prop': 'warn',
+      '@eslint-react/no-class-component': 'warn',
+      '@eslint-react/no-complex-conditional-rendering': 'warn',
+      '@eslint-react/no-leaked-conditional-rendering': 'off', // will be enabled for typescript files below
+      '@eslint-react/no-missing-component-display-name': 'warn',
+      '@eslint-react/no-missing-context-display-name': 'warn',
+      '@eslint-react/no-useless-fragment': 'warn',
+      '@eslint-react/prefer-destructuring-assignment': 'warn',
+      '@eslint-react/prefer-react-namespace-import': 'warn',
+      '@eslint-react/prefer-read-only-props': 'off', // may be enabled for typescript files below
+      '@eslint-react/prefer-shorthand-boolean': 'warn',
+      '@eslint-react/prefer-shorthand-fragment': 'warn',
+
+      '@eslint-react/debug/class-component': 'off',
+      '@eslint-react/debug/function-component': 'off',
+      '@eslint-react/debug/hook': 'off',
+      '@eslint-react/debug/is-from-react': 'off',
+      '@eslint-react/debug/jsx': 'off',
+      '@eslint-react/debug/react-hooks': 'off',
+
+      '@eslint-react/dom/no-children-in-void-dom-elements': 'error',
+      '@eslint-react/dom/no-unknown-property': 'error',
+
+      '@eslint-react/hooks-extra/no-direct-set-state-in-use-layout-effect':
+        'warn',
+      '@eslint-react/hooks-extra/no-unnecessary-use-callback': 'warn',
+      '@eslint-react/hooks-extra/no-unnecessary-use-memo': 'warn',
+
+      '@eslint-react/naming-convention/component-name': 'warn',
+      '@eslint-react/naming-convention/filename': 'off', // this needs to be configured per project
+      '@eslint-react/naming-convention/filename-extension': [
+        'warn',
+        'as-needed',
+      ],
+      '@eslint-react/naming-convention/use-state': 'off',
+
+      // @eslint-react/eslint-plugin marks their rules as deprecated in jsdoc,
+      // but not in the rule's metadata.
+      ...deprecated.disable('@eslint-react', [
+        'ensure-forward-ref-using-ref',
+        'no-complicated-conditional-rendering',
+        'no-duplicate-jsx-props',
+        'no-nested-components',
+        'use-jsx-vars',
+        'hooks-extra/ensure-custom-hooks-using-other-hooks',
+        'hooks-extra/ensure-use-callback-has-non-empty-deps',
+        'hooks-extra/ensure-use-memo-has-non-empty-deps',
+        'hooks-extra/no-redundant-custom-hook',
+        'hooks-extra/no-useless-custom-hooks',
+      ]),
     },
     settings: {
-      react: {
+      'react-x': {
         version: minimumSupportedReactVersion,
       },
     },
   },
   {
     files: ['**/*.ts?(x)'],
-    name: 'mrpalmer/react/typescript',
-    rules: {
-      'react/jsx-filename-extension': [
-        'error',
-        { extensions: ['.ts', '.tsx'] },
-      ],
-      'react/prop-types': 'off',
-    },
+    ...pluginReact.configs['recommended-type-checked'],
   }
 )

package/configs/typescript.js

@@ -130,6 +130,7 @@ export default tseslint.config({
     '@typescript-eslint/no-unnecessary-parameter-property-assignment': 'warn',
     '@typescript-eslint/no-unnecessary-qualifier': 'warn',
     '@typescript-eslint/no-unnecessary-type-arguments': 'warn',
+    '@typescript-eslint/no-unnecessary-type-conversion': 'warn',
     '@typescript-eslint/no-unsafe-type-assertion': 'error',
     '@typescript-eslint/no-useless-empty-export': 'error',
     '@typescript-eslint/parameter-properties': [
@@ -148,7 +149,6 @@ export default tseslint.config({
     ],
     '@typescript-eslint/strict-boolean-expressions': 'off',
     '@typescript-eslint/switch-exhaustiveness-check': 'error',
-    '@typescript-eslint/typedef': 'off',
   },
   settings: {
     'import-x/resolver-next': [

package/index.js

@@ -6,7 +6,7 @@ import react from './configs/react.js'
 import typescript from './configs/typescript.js'
 
 const configs = {
-  all: [...base, ...react, ...jest, ...typescript],
+  all: [...base, ...typescript, ...react, ...jest],
   base,
   jest,
   react,

package/package.json

@@ -1,11 +1,21 @@
 {
   "name": "@mrpalmer/eslint-config",
-  "version": "2.1.0",
+  "version": "2.2.0",
   "description": "Mike Palmer's personal ESLint rules",
   "license": "MIT",
   "type": "module",
+  "exports": {
+    ".": {
+      "import": "./index.js",
+      "types": "./types/index.d.ts"
+    },
+    "./package.json": "./package.json"
+  },
   "main": "index.js",
+  "types": "types/index.d.ts",
   "scripts": {
+    "prebuild": "rm -rf types",
+    "build": "tsc",
     "check-config": "run-p check-config:*",
     "check-config:jest": "cd test && validate-config -f component.test.js",
     "check-config:jest-ts": "cd test && validate-config -f component.test.ts",
@@ -15,21 +25,20 @@
     "validate": "npm run check-config"
   },
   "dependencies": {
-    "@eslint/js": "^9.20.0",
-    "@mrpalmer/eslint-plugin": "^1.0.0",
-    "@types/eslint__js": "^8.42.3",
-    "eslint-import-resolver-typescript": "^4.3.4",
-    "eslint-plugin-import-x": "^4.11.1",
-    "eslint-plugin-jest": "^28.11.0",
+    "@eslint-react/eslint-plugin": "^1.52.3",
+    "@eslint/js": "^9.31.0",
+    "@mrpalmer/eslint-plugin": "^1.0.1",
+    "eslint-import-resolver-typescript": "^4.4.4",
+    "eslint-plugin-import-x": "^4.16.1",
+    "eslint-plugin-jest": "^29.0.1",
     "eslint-plugin-jest-dom": "^5.5.0",
     "eslint-plugin-jsx-a11y": "^6.10.2",
-    "eslint-plugin-react": "^7.37.4",
-    "eslint-plugin-react-hooks": "^5.1.0",
-    "eslint-plugin-testing-library": "^7.1.1",
-    "globals": "^15.14.0",
+    "eslint-plugin-react-hooks": "^5.2.0",
+    "eslint-plugin-testing-library": "^7.5.4",
+    "globals": "^16.3.0",
     "read-package-up": "^11.0.0",
-    "semver": "^7.3.2",
-    "typescript-eslint": "^8.23.0"
+    "semver": "^7.7.2",
+    "typescript-eslint": "^8.36.0"
   },
   "peerDependencies": {
     "@testing-library/dom": "*",

package/tsconfig.json

@@ -0,0 +1,10 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "allowJs": true,
+    "declaration": true,
+    "declarationDir": "./types",
+    "emitDeclarationOnly": true
+  },
+  "include": ["index.js"]
+}

package/turbo.json

@@ -0,0 +1,8 @@
+{
+  "extends": ["//"],
+  "tasks": {
+    "build": {
+      "outputs": ["types/**"]
+    }
+  }
+}

package/types/configs/base.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("@typescript-eslint/utils/ts-eslint").FlatConfig.ConfigArray;
+export default _default;

package/types/configs/jest.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("@typescript-eslint/utils/ts-eslint").FlatConfig.ConfigArray;
+export default _default;

package/types/configs/react.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("@typescript-eslint/utils/ts-eslint").FlatConfig.ConfigArray;
+export default _default;

package/types/configs/typescript.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("@typescript-eslint/utils/ts-eslint").FlatConfig.ConfigArray;
+export default _default;

package/types/index.d.ts

@@ -0,0 +1,20 @@
+declare namespace _default {
+    export { config };
+    export { configs };
+    export { globals };
+}
+export default _default;
+import { config } from 'typescript-eslint';
+export namespace configs {
+    export let all: import("@typescript-eslint/utils/ts-eslint").FlatConfig.Config[];
+    export { base };
+    export { jest };
+    export { react };
+    export { typescript };
+}
+import globals from 'globals';
+import base from './configs/base.js';
+import jest from './configs/jest.js';
+import react from './configs/react.js';
+import typescript from './configs/typescript.js';
+export { config, globals };

package/types/utils/deprecated.d.ts

@@ -0,0 +1,4 @@
+export function remove(config: any, ruleNames: any): any;
+export function disable(pluginName: any, ruleNames: any): {
+    [k: string]: any;
+};

package/types/utils/packageJson.d.ts

@@ -0,0 +1,14 @@
+/** @typedef {Record<string, string>} Dependencies */
+/**
+ * Get all dependencies from the current project
+ * @returns {Dependencies}
+ */
+export function getAllDependencies(): Dependencies;
+/**
+ * Get the installed version of a dependency
+ * @param {Dependencies} allDeps
+ * @param {string} depName
+ * @returns {string | undefined}
+ */
+export function getMinimumSupportedVersion(allDeps: Dependencies, depName: string): string | undefined;
+export type Dependencies = Record<string, string>;

package/utils/deprecated.js

@@ -0,0 +1,19 @@
+export function remove(config, ruleNames) {
+  if (!config || !config.rules) {
+    return config
+  }
+
+  for (const ruleName of ruleNames) {
+    if (Object.hasOwn(config.rules, ruleName)) {
+      delete config.rules[ruleName]
+    }
+  }
+
+  return config
+}
+
+export function disable(pluginName, ruleNames) {
+  return Object.fromEntries(
+    ruleNames.map((ruleName) => [`${pluginName}/${ruleName}`, 'off'])
+  )
+}