eslint-config/configs/nextjs.js at ba56c44ae6649d2da5d8a2878538c48ca2e3bb3d · Boehringer-Ingelheim/eslint-config · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
import nextPlugin from '@next/eslint-plugin-next';
import { defineConfig } from 'eslint/config';

import { NEXTJS_ROUTING_FILES } from '../lib/nextjs.utils.js';
import react from './react.js';

export default defineConfig(
  ...react,
  {
    plugins: {
      '@next/next': nextPlugin,
    },
    rules: {
      ...nextPlugin.configs.recommended.rules,
      ...nextPlugin.configs['core-web-vitals'].rules,
    },
  },
  {
    files: [`{app,src/app}/**/{${NEXTJS_ROUTING_FILES.join(',')}}.{ts,tsx}`],
    rules: {
      'import/no-unused-modules': ['off'],

      // eslint-plugin-react-refresh: https://github.com/ArnaudBarre/eslint-plugin-react-refresh
      'react-refresh/only-export-components': [
        'warn',
        {
          allowExportNames: [
            /**
             * 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
             */
            'dynamic',
            'dynamicParams',
            'fetchCache',
            'maxDuration',
            'preferredRegion',
            'revalidate',
            'runtime',

            /**
             * Next.js allows exporting the following metadata options in layouts and pages
             *
             * @link https://nextjs.org/docs/app/api-reference/functions/generate-metadata
             */
            'generateMetadata',
            'metadata',

            /**
             * Next.js allows exporting the following static params functions in pages
             *
             * @link https://nextjs.org/docs/app/api-reference/functions/generate-static-params
             */
            'generateStaticParams',

            /**
             * Next.js allows exporting the following viewport options in layouts and pages
             *
             * @link https://nextjs.org/docs/app/api-reference/functions/generate-viewport
             */
            'generateViewport',
            'viewport',
          ],
        },
      ],
    },
  },
  {
    files: [`{instrumentation,src/instrumentation}.{ts,tsx}`],
    rules: {
      'import/no-unused-modules': ['off'],

      // eslint-plugin-react-refresh: https://github.com/ArnaudBarre/eslint-plugin-react-refresh
      'react-refresh/only-export-components': [
        'warn',
        {
          allowExportNames: [
            /**
             * Next.js allows exporting the following exports in instrumentation files
             *
             * @link https://nextjs.org/docs/app/guides/instrumentation#convention
             */
            'register',
          ],
        },
      ],
    },
  },
  {
    /**
     * Next.js 'middleware' files are beeing deprecated in favor of the new proxy files with v16+
     *
     * @link https://nextjs.org/blog/next-16#proxyts-formerly-middlewarets
     */
    files: [`{middleware,src/middleware}.{ts,tsx}`],
    rules: {
      'import/no-unused-modules': ['off'],

      // eslint-plugin-react-refresh: https://github.com/ArnaudBarre/eslint-plugin-react-refresh
      'react-refresh/only-export-components': [
        'warn',
        {
          allowExportNames: [
            /**
             * Next.js allows exporting the following config options in middleware
             *
             * @link https://nextjs.org/docs/app/api-reference/file-conventions/middleware#config-object-optional
             */
            'config',
          ],
        },
      ],
    },
  },
  {
    files: [`{proxy,src/proxy}.{ts,tsx}`],
    rules: {
      'import/no-unused-modules': ['off'],

      // eslint-plugin-react-refresh: https://github.com/ArnaudBarre/eslint-plugin-react-refresh
      'react-refresh/only-export-components': [
        'warn',
        {
          allowExportNames: [
            /**
             * Next.js allows exporting the following exports in proxy files
             *
             * @link https://nextjs.org/docs/app/api-reference/file-conventions/proxy#config-object-optional
             */
            'config',
            'proxy',
          ],
        },
      ],
    },
  },
);