@kirill.konshin/eslint-config-next-custom 0.3.2 → 0.4.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @kirill.konshin/eslint-config-next-custom
 
+## 0.4.0
+
+### Minor Changes
+
+- ESLint 10 & Next.js 16
+
 ## 0.3.2
 
 ### Patch Changes

package/README.md

@@ -3,32 +3,47 @@
 ## Installation
 
 ```bash
-$ yarn add -D eslint @eslint-compat prettier @kirill.konshin/eslint-config-next-custom husky lint-staged
+$ yarn add -D eslint prettier @kirill.konshin/eslint-config-next-custom husky lint-staged
 ```
 
-`eslint.config.mjs`:
+### PNPM
 
-```js
-import { dirname, resolve } from 'node:path';
-import { fileURLToPath } from 'node:url';
+https://eslint.org/docs/latest/use/getting-started#manual-set-up
+
+```dotenv
+auto-install-peers=true
+node-linker=hoisted
+```
 
-import { includeIgnoreFile } from '@eslint/compat';
-import customConfig from '@kirill.konshin/eslint-config-next-custom';
+## Settings
 
-const gitignorePath = resolve(dirname(fileURLToPath(import.meta.url)), '.prettierignore'); // <----- !!!
+`eslint.config.mjs`:
+
+```js
+import { defineConfig } from 'eslint/config';
+import customConfig, { nextPlugin, includeIgnoreFile } from '@kirill.konshin/eslint-config-next-custom';
 
-const config = [
+export default defineConfig([
     ...customConfig,
+    {
+        files: ['**/*.{js,jsx,ts,tsx}'],
+        plugins: {
+            next: nextPlugin,
+        },
+        settings: {
+            next: {
+                rootDir: process.cwd() + '/path/to/next-app',
+            },
+        },
+    },
     {
         name: 'Custom rules',
         rules: {
             // overrides
         },
     },
-    includeIgnoreFile(gitignorePath),
-];
-
-export default config;
+    includeIgnoreFile(import.meta.url, '.prettierignore'),
+]);
 ```
 
 `.prettierrc.mjs`:
@@ -47,20 +62,23 @@ export default {
 ```json5
 {
     scripts: {
-        eslint: 'DEBUG=eslint:eslint eslint --cache --cache-location node_modules/.cache/eslint --fix',
-        prettier: 'prettier --write',
+        eslint: 'eslint --fix --concurrency=auto --cache --cache-location node_modules/.cache/eslint', // to see files use --debug
+        prettier: 'prettier --write --log-level=warn', // to see files use --log-level=log
         'lint:all': 'yarn eslint . && yarn prettier .',
+        'lint:staged': 'lint-staged',
     },
 }
 ```
 
-IDEA settings:
+## IDEA settings:
 
 - Eslint: `**/*.{js,jsx,ts,tsx,cjs,cts,mjs,mts,htm,html,md,mdx,vue}`
 - Prettier: `{**/*}.{js,jsx,ts,tsx,cjs,cts,mjs,mts,htm,html,md,mdx,css,scss,sass,less,yml,yaml,json}`
 
 ## Lint Staged
 
+`.lintstagedrc`
+
 ```json5
 {
     '*.{js,jsx,ts,tsx,cjs,cts,mjs,mts,htm,html,md,mdx,vue}': 'yarn eslint',
@@ -70,6 +88,8 @@ IDEA settings:
 
 ## Husky
 
+`package.json`:
+
 ```json5
 {
     scripts: {
@@ -88,5 +108,8 @@ yarn lint:staged
 
 ## Issues
 
-- [x] https://github.com/microsoft/rushstack/issues/4635 Failed to patch ESLint because the calling module was not recognized
-- [x] https://github.com/microsoft/rushstack/issues/4965 Failed to patch ESLint because the calling module was not recognized
+- ESLint 9
+    - [x] https://github.com/microsoft/rushstack/issues/4635 Failed to patch ESLint because the calling module was not recognized
+    - [x] https://github.com/microsoft/rushstack/issues/4965 Failed to patch ESLint because the calling module was not recognized
+- ESLint 10
+    - [ ] https://github.com/vercel/next.js/issues/89764 TypeError: Error while loading rule 'react/display-name': contextOrFilename.getFilename is not a function

package/index.js

@@ -1,22 +1,17 @@
-// @see https://blog.linotte.dev/eslint-9-next-js-935c2b6d0371
-import { dirname } from 'node:path';
+import { dirname, resolve } from 'node:path';
 import { fileURLToPath } from 'node:url';
-
+import { includeIgnoreFile as includeIgnoreFileCompat } from '@eslint/compat';
 import js from '@eslint/js';
-import { FlatCompat } from '@eslint/eslintrc';
-import { fixupConfigRules } from '@eslint/compat';
 import prettierConfigRecommended from 'eslint-config-prettier';
 import globals from 'globals';
-
-const flatCompat = new FlatCompat({
-    baseDirectory: dirname(fileURLToPath(import.meta.url)),
-    recommendedConfig: js.configs.recommended,
-    allConfig: js.configs.all,
-});
+import next from 'eslint-config-next';
+import nextTs from 'eslint-config-next/typescript';
+import nextPlugin from '@next/eslint-plugin-next';
 
 const index = [
     js.configs.recommended,
-    ...fixupConfigRules([...flatCompat.extends('next', 'next/typescript')]), // https://nextjs.org/docs/app/api-reference/config/eslint#with-typescript
+    ...next,
+    ...nextTs,
     {
         // Plugin is not recommended by Prettier, they suggest to just use config, and disable all the rules, except for these two in plugin:
         // 'arrow-body-style': 'off'
@@ -51,8 +46,29 @@ const index = [
             'import/no-anonymous-default-export': 'off',
             'import/no-unresolved': 'off',
             'import/no-webpack-loader-syntax': 'off',
+            'jsx-a11y/alt-text': 'off',
+        },
+    },
+    //FIXME ESLint 10 + Next fix
+    // https://github.com/vercel/next.js/issues/89764
+    // https://gist.github.com/OscarGauss/1f305edf5b7c103bb2ee32ba479f4261
+    {
+        settings: {
+            react: { version: '19' },
         },
     },
 ];
 
 export default index;
+
+export { nextPlugin };
+
+/**
+ * @param {string} importMetaUrl
+ * @param {string} ignoreFile
+ * @returns {import('@eslint/core').ConfigObject}
+ */
+export function includeIgnoreFile(importMetaUrl, ignoreFile) {
+    // @see https://blog.linotte.dev/eslint-9-next-js-935c2b6d0371
+    return includeIgnoreFileCompat(resolve(dirname(fileURLToPath(importMetaUrl)), ignoreFile));
+}

package/package.json

@@ -1,7 +1,9 @@
 {
   "name": "@kirill.konshin/eslint-config-next-custom",
-  "version": "0.3.2",
+  "description": "",
+  "version": "0.4.0",
   "type": "module",
+  "skipGenerate": true,
   "main": "index.js",
   "module": "index.js",
   "exports": {
@@ -9,27 +11,28 @@
     "./prettier": "./prettier.js"
   },
   "dependencies": {
-    "@eslint/compat": "^1.2.5",
-    "@eslint/eslintrc": "^3.2.0",
-    "@eslint/js": "^9.18.0",
-    "@next/eslint-plugin-next": "^15.1.6",
-    "@typescript-eslint/eslint-plugin": "^8.21.0",
-    "@typescript-eslint/parser": "^8.21.0",
-    "eslint-config-next": "^15.1.6",
-    "eslint-config-prettier": "^10.0.1",
-    "eslint-plugin-react-hooks": "^5.1.0",
-    "globals": "^15.14.0"
-  },
-  "devDependencies": {
-    "typescript": "^5.7.3"
+    "@eslint/compat": "^2.0.3",
+    "@eslint/js": "^10.0.1",
+    "@next/eslint-plugin-next": "^16.2.1",
+    "@typescript-eslint/eslint-plugin": "^8.57.2",
+    "@typescript-eslint/parser": "^8.57.2",
+    "eslint-config-next": "^16.2.1",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-react-hooks": "^7.0.1",
+    "globals": "^16.4.0"
   },
   "peerDependencies": {
-    "next": "^15"
+    "eslint": "^10",
+    "next": "^16"
   },
   "publishConfig": {
     "access": "public"
   },
   "author": "Kirill Konshin <kirill@konshin.org> (https://konshin.org)",
   "license": "MIT",
-  "description": ""
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/kirill-konshin/utils.git",
+    "directory": "packages/eslint-config-next-custom"
+  }
 }

package/prettier.js

@@ -4,7 +4,7 @@ export default {
     singleQuote: true,
     overrides: [
         {
-            files: '*.{js,jsx,ts,tsx,html,md,mdx}',
+            files: '*.{js,jsx,ts,tsx,cjs,cts,mjs,mts,html,md,mdx}',
             options: {
                 tabWidth: 4,
             },