@boehringer-ingelheim/eslint-config 7.0.0-shared-configuration-nextjs.1 → 7.0.0-shared-configuration-nextjs.3

package/README.md

@@ -142,6 +142,7 @@ This shared ESLint configuration is specifically tailored for [React](https://re
 - [`eslint-plugin-jsx-a11y`](https://github.com/jsx-eslint/eslint-plugin-jsx-a11y)
 - [`eslint-plugin-react`](https://github.com/jsx-eslint/eslint-plugin-react)
 - [`eslint-plugin-react-hooks`](https://github.com/facebook/react/tree/main/packages/eslint-plugin-react-hooks)
+- [`eslint-plugin-react-refresh`](https://github.com/ArnaudBarre/eslint-plugin-react-refresh) (with rule severity `warn`)
 
 The configuration sets several custom rules, including [`@typescript-eslint/no-restricted-types`](https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/docs/rules/no-restricted-types.mdx) and [`@typescript-eslint/consistent-type-definitions`](https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/docs/rules/consistent-type-definitions.mdx), as well as rules for organizing and formatting import statements.
 Additionally in restricts the usage of enums using [`no-restricted-syntax`](https://github.com/eslint/eslint/blob/main/docs/src/rules/no-restricted-syntax.md).
@@ -157,7 +158,9 @@ export default boehringer.config(
 );
 ```
 
-This shared ESLint configuration is specifically tailored for [Next.js](https://nextjs.org/) projects. It extends the [react configuration](#react) and includes the [`@next/eslint-plugin-next`](https://nextjs.org/docs/app/api-reference/config/eslint) plugin with the recommended and [`core-web-vital`](https://nextjs.org/docs/app/api-reference/config/eslint#with-core-web-vitals) rule set.
+This shared ESLint configuration is specifically tailored for [Next.js](https://nextjs.org/) projects. It extends the [react configuration](#react) and includes the [`@next/eslint-plugin-next`](https://nextjs.org/docs/app/api-reference/config/eslint) plugin with the recommended and [`core-web-vital`](https://nextjs.org/docs/app/api-reference/config/eslint#with-core-web-vitals) rule set. The configuration also adapts the rule `react-refresh/only-export-components` to be compatible with Next.js.
+
+It
 
 ### Playwright
 

package/configs/nextjs.js

@@ -8,6 +8,32 @@ module.exports = tseslint.config(...react, {
     '@next/next': nextPlugin,
   },
   rules: {
+    // eslint-plugin-react-refresh: https://github.com/ArnaudBarre/eslint-plugin-react-refresh
+    'react-refresh/only-export-components': [
+      'warn',
+      {
+        /**
+         * Next.js allows exporting the following options in pages, layouts and route handlers
+         *
+         * @see https://nextjs.org/docs/app/api-reference/file-conventions/route-segment-config
+         */
+        allowExportNames: [
+          'config',
+          'dynamic',
+          'dynamicParams',
+          'fetchCache',
+          'generateMetadata',
+          'generateStaticParams',
+          'generateViewport',
+          'maxDuration',
+          'metadata',
+          'preferredRegion',
+          'revalidate',
+          'runtime',
+          'viewport',
+        ],
+      },
+    ],
     ...nextPlugin.configs.recommended.rules,
     ...nextPlugin.configs['core-web-vitals'].rules,
   },

package/configs/react.js

@@ -13,6 +13,7 @@ module.exports = tseslint.config(
   jsxA11y.flatConfigs.recommended,
   react.configs.flat.recommended,
   react.configs.flat['jsx-runtime'],
+  reactRefresh.configs.recommended,
   {
     languageOptions: {
       globals: {
@@ -25,9 +26,7 @@ module.exports = tseslint.config(
       },
     },
     plugins: {
-      'jsx-a11y': jsxA11y,
       'react-hooks': reactHooks,
-      'react-refresh': reactRefresh,
     },
     rules: {
       // @typescript-eslint: https://github.com/typescript-eslint/typescript-eslint/tree/main/packages/eslint-plugin/docs/rules

package/index.js

@@ -2,6 +2,7 @@ const tseslint = require('typescript-eslint');
 
 const base = require('./configs/base.js');
 const local = require('./configs/local.js');
+const nextjs = require('./configs/nextjs.js');
 const playwright = require('./configs/playwright.js');
 const prettierDisable = require('./configs/prettier-disable.js');
 const react = require('./configs/react.js');
@@ -12,6 +13,7 @@ module.exports = {
   configs: {
     base,
     local,
+    nextjs,
     playwright,
     prettierDisable,
     react,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@boehringer-ingelheim/eslint-config",
-  "version": "7.0.0-shared-configuration-nextjs.1",
+  "version": "7.0.0-shared-configuration-nextjs.3",
   "description": "Shared eslint configuration used at Boehringer Ingelheim for code styling",
   "keywords": [
     "boehringer",