@kununu/eslint-config 7.1.5 → 7.3.0

package/README.md

@@ -1,46 +1,126 @@
 # @kununu/eslint-config
 
-> kununu config for ESLint v9 (Flat Config)
+> kununu's shared [ESLint](https://eslint.org/) config (ESLint v9 — flat config)
 
-This package contains ESLint rules for consistent JS, JSX, TS, and TSX code across kununu's projects.
+Shared linting rules for consistent JS, JSX, TS, and TSX across kununu's frontend
+apps, BFFs, and shared libraries. It bundles the parsers and plugins it needs, so
+consumers only install this one package.
 
-**Version 6.0.0+** uses ESLint v9 with the new flat config format.
+> **Flat config only.** This package targets ESLint v9's flat config
+> (`eslint.config.*`). There is no legacy `.eslintrc` export. (v6.0.0+ is flat
+> config; v4/v5 were the legacy format.)
 
 ## 📦 Installation
 
-Add @kununu/eslint-config npm package as dev dependency to your project:
-
 ```console
 npm install --save-dev @kununu/eslint-config
 ```
 
-## 💻 Usage
+`typescript` is an optional peer dependency (`>=5.0.0`) — only needed for the
+type-aware TypeScript rules (see below).
 
-### ESLint v9 (Flat Config)
+## 💻 Usage
 
-Create an `eslint.config.cjs` file:
+Create an **`eslint.config.mjs`** (ESM — the config is published as an ES module):
 
 ```javascript
 import kununuConfig from '@kununu/eslint-config';
 
 export default [
   ...kununuConfig,
-  // Your custom config here
+  // your project-specific overrides here
 ];
 ```
 
-See [docs](https://eslint.org/docs/user-guide/getting-started) to find more detailed information on ESLint configuration and usage.
+Add a lint script to `package.json`:
 
-## ⚡️ Plugins
+```json
+{
+  "scripts": {
+    "lint": "eslint ."
+  }
+}
+```
 
-At kununu, [@kununu/eslint-config](https://www.npmjs.com/package/@kununu/eslint-config) and [@kununu/stylelint-config](https://www.npmjs.com/package/@kununu/stylelint-config) linters runs on every commit, but finding a lint error after push can be frustrating and waste time. In order to avoid it, editor plugins are available to warn you and validate as you code.
+See the [ESLint docs](https://eslint.org/docs/latest/use/getting-started) for more
+on configuration and usage.
 
-There's what we use and recommend:
+### TypeScript (type-aware rules)
 
-### Visual Code Studio
+The TS rules use `@typescript-eslint`'s `projectService`, which auto-discovers
+your `tsconfig.json`. Make sure one exists at the project root, otherwise the
+type-aware rules will error.
 
-- [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
+### Project-specific overrides
 
-### Atom
+Append your own flat-config objects after the spread. Scope them with `files`,
+and remember **last match wins**:
+
+```javascript
+import kununuConfig from '@kununu/eslint-config';
 
-- [linter-eslint](https://atom.io/packages/linter-eslint)
+export default [
+  ...kununuConfig,
+  {
+    rules: {
+      'no-console': 'off',
+    },
+  },
+  {
+    files: ['**/*.spec.*'],
+    rules: {
+      // test-only tweaks
+    },
+  },
+];
+```
+
+## 🎨 What's included
+
+Built on `@eslint/js`, `typescript-eslint`, and the React ecosystem, plus kununu
+conventions. Parsers are wired up automatically: **`.ts`/`.tsx`** use
+`@typescript-eslint/parser` (with `projectService`), **`.js`/`.jsx`** use
+`@babel/eslint-parser`.
+
+| Area | Plugins |
+| --- | --- |
+| Base | `@eslint/js`, `typescript-eslint` |
+| React | `eslint-plugin-react`, `eslint-plugin-react-hooks` (incl. React Compiler rules) |
+| Accessibility | `eslint-plugin-jsx-a11y` |
+| Style / formatting | `@stylistic/eslint-plugin` |
+| Code smells | `eslint-plugin-sonarjs` |
+| Imports / ordering | `eslint-plugin-perfectionist` |
+| Tests (`*.spec.*`) | `eslint-plugin-jest`, `eslint-plugin-jest-dom`, `eslint-plugin-testing-library` |
+| kununu-specific | `eslint-plugin-lodash`, `eslint-plugin-granular-selectors`, `@babel/eslint-plugin` |
+
+### Notable conventions
+
+- **No default React import** — `import React from 'react'` is disallowed; import
+  named hooks/types instead (`import {useState} from 'react'`).
+- **Per-method lodash imports** — `import debounce from 'lodash/debounce'`, not
+  `import {debounce} from 'lodash'`.
+- **Import ordering** (`perfectionist/sort-imports`): `react` → types →
+  builtins/externals → `@kununu/*` internals → aliases → relatives.
+- **Granular Redux selectors** for `use*Selector*` / `use*Store*` hooks.
+- **Formatting** via `@stylistic` (120-char lines ignoring comments/strings/URLs,
+  semicolons, single quotes, …).
+- **React Compiler rules** (`react-hooks/refs`, `set-state-in-effect`, …) are
+  **warnings**, not errors.
+- **Test files** (`**/*.spec.*`) automatically get Jest globals plus the jest /
+  jest-dom / testing-library rule sets; some source-only rules (e.g.
+  `react/prop-types`, `sonarjs/no-hardcoded-passwords`) are relaxed there.
+
+## ⚡️ Editor integration
+
+Linting runs in CI / pre-commit, but catching errors in your editor is faster. We
+recommend the
+[ESLint VS Code extension](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint).
+
+Recent versions auto-detect flat config. If your editor still defaults to the
+legacy format, enable it in `.vscode/settings.json`:
+
+```json
+{
+  "eslint.useFlatConfig": true
+}
+```

package/eslint.config.mjs

@@ -25,8 +25,12 @@ export default defineConfig([
   reactPlugin.configs.flat['jsx-runtime'],
   sonarjs.configs.recommended,
   stylistic.configs.recommended,
-  testingLibraryPlugin.configs['flat/dom'],
-  tseslint.configs.recommended,
+  // Scope the TypeScript rules to TS files only; .js/.jsx use the Babel parser
+  // below and would otherwise run type-aware rules under the wrong parser.
+  ...tseslint.configs.recommended.map(config => ({
+    ...config,
+    files: ['**/*.ts', '**/*.tsx'],
+  })),
 
   globalIgnores([
     '**/.next/',
@@ -51,6 +55,18 @@ export default defineConfig([
         projectService: true,
       },
     },
+    rules: {
+      '@typescript-eslint/no-require-imports': 'error',
+      // Allow intentionally-unused identifiers prefixed with `_`.
+      '@typescript-eslint/no-unused-vars': ['error', {
+        argsIgnorePattern: '^_',
+        caughtErrorsIgnorePattern: '^_',
+        destructuredArrayIgnorePattern: '^_',
+        ignoreRestSiblings: true,
+        varsIgnorePattern: '^_',
+      }],
+      '@typescript-eslint/no-use-before-define': 'error',
+    },
   },
 
   {
@@ -66,18 +82,33 @@ export default defineConfig([
     },
   },
 
+  // Test-only configs. Spread as separate entries so their plugins/rules
+  // aren't clobbered, and scope them to spec files (incl. testing-library,
+  // which previously applied to every file).
+  {...pluginJest.configs['flat/recommended'], files: ['**/*.spec.*']},
+  {...jestDomPlugin.configs['flat/recommended'], files: ['**/*.spec.*']},
+  {...testingLibraryPlugin.configs['flat/dom'], files: ['**/*.spec.*']},
   {
-    files: [
-      ['**/*.spec.*'],
-    ],
-    ...jestDomPlugin.configs['flat/recommended'],
-    languageOptions: {
-      globals: pluginJest.environments.globals.globals,
-    },
-    plugins: {jest: pluginJest},
+    files: ['**/*.spec.*'],
     rules: {
       '@typescript-eslint/no-explicit-any': 'off',
+      // Tests legitimately require() dynamic mocks / json fixtures.
+      '@typescript-eslint/no-require-imports': 'off',
+      // Recognise assertions made through `assert*` helper functions, not just
+      // direct expect() calls.
+      'jest/expect-expect': ['warn', {assertFunctionNames: ['expect', 'assert*']}],
+      // kununu stores shared test fixtures under __mocks__ and imports them
+      // directly; this rule targets jest auto-mocks, not that convention.
+      'jest/no-mocks-import': 'off',
       'react/display-name': 'off',
+      // Prop-types are redundant in a TypeScript codebase.
+      'react/prop-types': 'off',
+      // Test fixtures often contain password-like strings (mock query strings,
+      // tokens) that aren't real credentials; keep the rule for source code.
+      'sonarjs/no-hardcoded-passwords': 'off',
+      // Direct DOM access is common and acceptable in tests.
+      'testing-library/no-node-access': 'off',
+      'testing-library/render-result-naming-convention': 'off',
     },
   },
 
@@ -146,7 +177,8 @@ export default defineConfig([
         {blankLine: 'any', next: 'import', prev: 'import'},
         // Always require blank line after imports when followed by non-imports
         {blankLine: 'always', next: '*', prev: 'import'},
-        // But allow imports to be followed by imports without forcing blank line
+        // Re-allow consecutive imports with no blank line. Must stay AFTER the
+        // rule above (last match wins) or every adjacent import is forced apart.
         {blankLine: 'any', next: 'import', prev: 'import'},
         // Allow any spacing between variable declarations (before and between)
         {blankLine: 'any', next: ['const', 'let', 'var'], prev: '*'},
@@ -163,8 +195,6 @@ export default defineConfig([
       '@stylistic/quote-props': ['error', 'as-needed'],
       '@stylistic/semi': ['error', 'always'],
       '@stylistic/switch-colon-spacing': 'error',
-      '@typescript-eslint/no-use-before-define': 'error',
-      '@typescript-eslint/no-var-requires': 'error',
       'granular-selectors/granular-selectors': ['error', {
         include: ['use.*Selector.*', 'use.*Store.*'],
       }],
@@ -254,7 +284,14 @@ export default defineConfig([
       }],
       'prefer-template': 'error',
       'react-hooks/exhaustive-deps': 'warn',
+      // React Compiler rules: advisory for now. They flag patterns the compiler
+      // can't optimise, but the current codebases use them widely; keep as
+      // warnings rather than blocking errors.
+      'react-hooks/immutability': 'warn',
+      'react-hooks/refs': 'warn',
       'react-hooks/rules-of-hooks': 'error',
+      'react-hooks/set-state-in-effect': 'warn',
+      'react-hooks/use-memo': 'warn',
       'react/jsx-closing-bracket-location': ['error', 'tag-aligned'],
       // More restrictive JSX rules that are auto-fixable
       'react/jsx-curly-spacing': ['error', 'never'],
@@ -271,6 +308,8 @@ export default defineConfig([
         closingSlash: 'never',
       }],
       'sonarjs/deprecation': ['warn'],
+      // TypeScript already infers/checks return types; this duplicates it.
+      'sonarjs/function-return-type': 'off',
       'sonarjs/todo-tag': ['warn'],
     },
   },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kununu/eslint-config",
-  "version": "7.1.5",
+  "version": "7.3.0",
   "description": "kununu's ESLint config",
   "main": "eslint.config.mjs",
   "type": "module",
@@ -30,24 +30,24 @@
   },
   "homepage": "https://github.com/kununu/eslint-config#readme",
   "dependencies": {
-    "@babel/core": "7.29.7",
-    "@babel/eslint-parser": "7.29.7",
-    "@babel/eslint-plugin": "7.29.7",
+    "@babel/core": "8.0.1",
+    "@babel/eslint-parser": "8.0.1",
+    "@babel/eslint-plugin": "8.0.1",
     "@eslint/js": "9.39.4",
     "@stylistic/eslint-plugin": "5.10.0",
-    "@typescript-eslint/parser": "8.59.4",
+    "@typescript-eslint/parser": "8.62.0",
     "eslint": "9.39.2",
     "eslint-plugin-granular-selectors": "1.5.0",
-    "eslint-plugin-jest": "29.15.2",
+    "eslint-plugin-jest": "29.15.3",
     "eslint-plugin-jest-dom": "5.5.0",
     "eslint-plugin-jsx-a11y": "6.10.2",
     "eslint-plugin-lodash": "8.0.0",
-    "eslint-plugin-perfectionist": "5.9.0",
+    "eslint-plugin-perfectionist": "5.9.1",
     "eslint-plugin-react": "7.37.5",
     "eslint-plugin-react-hooks": "7.1.1",
-    "eslint-plugin-sonarjs": "4.0.3",
+    "eslint-plugin-sonarjs": "4.1.0",
     "eslint-plugin-testing-library": "7.16.2",
-    "typescript-eslint": "8.59.4"
+    "typescript-eslint": "8.62.0"
   },
   "peerDependencies": {
     "typescript": ">=5.0.0"