@boehringer-ingelheim/eslint-config 6.0.2 → 7.0.0-naming-convetion-configuration.1

package/README.md

@@ -21,29 +21,38 @@ npm install --save-dev @boehringer-ingelheim/eslint-config
 
 ### Add the configuration
 
-Create or update the `.eslintrc.js` file in your projects root directory accordingly.
+Create or update the `eslint.config.mjs` (`eslint.config.cjs` is also possible if commonjs is preferred) file in your projects root directory accordingly.
 
 ```js
-module.exports = {
-  extends: ['@boehringer-ingelheim/eslint-config/base/strict'],
-};
+import boehringer from '@boehringer-ingelheim/eslint-config';
+
+export default boehringer.config(
+  boehringer.configs.strict
+)
 ```
 
+#### `boehringer.config(...)`
+
+This function is a re-export for the config-helper of typescript eslint (See [docs](https://github.com/typescript-eslint/typescript-eslint/blob/a383d5022b81eaf65ce7b0946491444c6eaa28e3/docs/packages/TypeScript_ESLint.mdx#config)).
+
 #### Extend or Override configuration
 
 This is not recommended as the goal is to have similar code stylings in all projects, but if for some reason you need to add or change the configuration, it is possible in the following way:
 
 ```js
-module.exports = {
-  extends: ['@boehringer-ingelheim/eslint-config/base/strict'],
-  rules: {
-    'no-empty-function': 'off',
-  },
-};
+import boehringer from '@boehringer-ingelheim/eslint-config';
+
+export default boehringer.config(
+  boehringer.configs.strict, 
+  {
+    rules: {
+      'no-empty-function': 'off',
+    },
+  }
+);
 ```
 
-More Information: [ESLint - Configuration Files
-](https://eslint.org/docs/latest/use/configure/configuration-files#extending-configuration-files)
+More Information: [ESLint - Configuration Files](https://eslint.org/docs/latest/use/configure/configuration-files#extending-configuration-files)
 
 ### Run
 
@@ -53,14 +62,16 @@ npx eslint .
 
 ## Shared Configurations
 
-Opinionated Options that differ from the standard/recommended eslint configurations.
+Opinionated Options that differ from the standard/recommended ESLint configurations.
 
-### `@boehringer-ingelheim/eslint-config/base`
+### Base
 
 ```js
-module.exports = {
-  extends: ['@boehringer-ingelheim/eslint-config/base'],
-};
+import boehringer from '@boehringer-ingelheim/eslint-config';
+
+export default boehringer.config(
+  boehringer.configs.base
+)
 ```
 
 This shared ESLint configuration is set up for TypeScript projects that adhere to modern JavaScript standards. It uses the latest version of TypeScript (ES2022) and extends several plugins and recommended rules to enforce best practices and catch potential errors.
@@ -73,60 +84,90 @@ The following plugins are used in this configuration:
 
 Additionally, the [`eslint-plugin-perfectionist`](https://github.com/azat-io/eslint-plugin-perfectionist) is used to automatically fix sorting issues.
 
-This configuration also sets up the TypeScript parser [`@typescript-eslint/parser`](https://typescript-eslint.io/architecture/parser) and [`eslint-import-resolver-typescript`](https://github.com/import-js/eslint-import-resolver-typescript). The TypeScript project file `./tsconfig.json` is set as default value for the project option in the parser configuration. If this is not the case, this must be changed accordingly:
+This configuration also sets up the TypeScript parser [`@typescript-eslint/parser`](https://typescript-eslint.io/packages/parser/) and [`eslint-import-resolver-typescript`](https://github.com/import-js/eslint-import-resolver-typescript). The TypeScript project configuration file `./tsconfig.json` is set as default value in the parser configuration. If this is not the case, this must be changed accordingly:
 
 ```js
-module.exports = {
-  parserOptions: {
-    // Use `tsconfing.dev.json` as typescript project configuration, see: https://typescript-eslint.io/architecture/parser/#project
-    project: './tsconfig.dev.json',
+import boehringer from '@boehringer-ingelheim/eslint-config';
+
+export default boehringer.config(boehringer.configs.base, {
+  languageOptions: {
+    parserOptions: {
+      projectService: {
+        defaultProject: ['./tsconfig.dev.json'],
+      },
+    },
   },
-};
+});
 ```
 
-### `@boehringer-ingelheim/eslint-config/base/local`
+### Local
 
 ```js
-module.exports = {
-  extends: ['@boehringer-ingelheim/eslint-config/base/strict', '@boehringer-ingelheim/eslint-config/base/local'],
-};
+import boehringer from '@boehringer-ingelheim/eslint-config';
+
+export default boehringer.config(
+  boehringer.configs.base,
+  boehringer.configs.local
+);
 ```
 
 This shared ESLint configuration configures or disables some rules for a better performance locally. With the help of [`is-ci`](https://www.npmjs.com/package/is-ci) those configs only apply to environments outside the CI pipelines.
 
-### `@boehringer-ingelheim/eslint-config/base/strict`
+### Strict
 
 ```js
-module.exports = {
-  extends: ['@boehringer-ingelheim/eslint-config/base/strict'],
-};
+import boehringer from '@boehringer-ingelheim/eslint-config';
+
+export default boehringer.config(
+  boehringer.configs.strict
+);
 ```
 
-This shared ESLint configuration extends the `@boehringer-ingelheim/eslint-config/base` configuration and adds additional strict linting rules from the `@typescript-eslint/eslint-plugin` plugin. These strict rules aim to enforce a high standard of code quality and improve code maintainability.
+This shared ESLint configuration extends the [base configuration](#base) and adds additional strict linting rules from the typescript-eslint plugin. These strict rules aim to enforce a high standard of code quality and improve code maintainability.
 
-### `@boehringer-ingelheim/eslint-config/react`
+### React
 
 ```js
-module.exports = {
-  extends: ['@boehringer-ingelheim/eslint-config/base/strict', '@boehringer-ingelheim/eslint-config/react'],
-};
+import boehringer from '@boehringer-ingelheim/eslint-config';
+
+export default boehringer.config(
+  boehringer.configs.strict,
+  boehringer.configs.react
+);
 ```
 
-This shared ESLint configuration is specifically tailored for [React](https://reactjs.org/) projects, and extends `@boehringer-ingelheim/eslint-config/base`. It uses the browser environment, and includes recommended configurations for the following plugins:
+This shared ESLint configuration is specifically tailored for [React](https://reactjs.org/) projects, and extends the [base configuration](#base). It uses the browser environment, and includes recommended configurations for the following plugins:
 
 - [`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-typescript-enum`](https://github.com/shian15810/eslint-plugin-typescript-enum)
+- [`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).
+
+### Next.js
 
-The configuration sets several custom rules, including `@typescript-eslint/ban-types` and `@typescript-eslint/consistent-type-definitions`, as well as rules for organizing and formatting import statements.
+```js
+import boehringer from '@boehringer-ingelheim/eslint-config';
+
+export default boehringer.config(
+  boehringer.configs.strict,
+  boehringer.configs.nextjs
+);
+```
 
-### `@boehringer-ingelheim/eslint-config/playwright`
+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.
+
+### Playwright
 
 ```js
-module.exports = {
-  extends: ['@boehringer-ingelheim/eslint-config/base/strict', '@boehringer-ingelheim/eslint-config/playwright'],
-};
+import boehringer from '@boehringer-ingelheim/eslint-config';
+
+export default boehringer.config(
+  boehringer.configs.strict,
+  boehringer.configs.playwright
+);
 ```
 
 This shared ESLint configuration is designed to enforce best practices and recommendations when writing tests with Playwright. It extends the [`eslint-plugin-playwright`](https://github.com/playwright-community/eslint-plugin-playwright) configuration and adds the following rules:
@@ -135,19 +176,34 @@ This shared ESLint configuration is designed to enforce best practices and recom
 - [`playwright/prefer-to-have-length`](https://github.com/playwright-community/eslint-plugin-playwright/blob/main/docs/rules/prefer-to-have-length.md): enforces the use of `.toHaveLength()` instead of `.toEqual(n)` when testing the length of an object.
 - [`playwright/require-top-level-describe`](https://github.com/playwright-community/eslint-plugin-playwright/blob/main/docs/rules/require-top-level-describe.md): requires tests to be organized into top-level `describe()` blocks.
 
-### `@boehringer-ingelheim/eslint-config/prettier-disable`
+### Naming Convention
+
+```js
+import boehringer from '@boehringer-ingelheim/eslint-config';
+
+export default boehringer.config(
+  boehringer.configs.strict,
+  // possibly other configs,
+  boehringer.configs.namingConvention
+);
+```
+
+This shared ESLint configuration is designed to enforce some naming conventions. It uses the [`@typescript-eslint/naming-convention`](https://typescript-eslint.io/rules/naming-convention/) rule for enforcing the naming conventions. The enforced conventions can be found in [configs/naming-convention.js](./configs/naming-convention.js#L7-L65)
+
+### Prettier-disable
 
 ```js
-module.exports = {
-  extends: [
-    '@boehringer-ingelheim/eslint-config/base/strict',
-    // Following needs eslint-plugin-prettier to be installed as described by https://github.com/prettier/eslint-plugin-prettier
-    // Should be second to last
-    'plugin:prettier/recommended',
-    // Should be last
-    '@boehringer-ingelheim/eslint-config/prettier-disable'
-  ],
-};
+import boehringer from '@boehringer-ingelheim/eslint-config';
+import prettier from 'eslint-plugin-prettier/recommended';
+
+export default boehringer.config(
+  boehringer.configs.strict,
+  // Following needs eslint-plugin-prettier to be installed as described by https://github.com/prettier/eslint-plugin-prettier
+  // Should be second to last
+  prettier,
+  // Should be last
+  boehringer.configs.prettierDisable,
+);
 ```
 
 This shared ESLint configuration is wrapper around [`eslint-config-disable`](https://github.com/prettier/eslint-config-prettier), which is used to turn off all rules that are unnecessary or might conflict with Prettier. This wrapper reenables a few rules that can be used with our shared configurations as we are using specific options of those rules which are compatible with Prettier (see [Special Rules](https://github.com/prettier/eslint-config-prettier#special-rules)). Following rules are reenabled:
@@ -155,6 +211,69 @@ This shared ESLint configuration is wrapper around [`eslint-config-disable`](htt
 - [`curly`](https://github.com/eslint/eslint/blob/main/docs/src/rules/curly.md) with the (default) option "all": Enforce consistent brace style for all control statements
 - [`no-confusing-arrow`](https://github.com/eslint/eslint/blob/main/docs/src/rules/no-confusing-arrow.md) with allowParens `false` and onlyOneSimpleParam `true`: Disallow arrow functions where they could be confused with comparisons.
 
+## Known issues
+
+### Parsing error
+
+ESLint may throw the following error for some files (even for its own eslint.config.js): `ESLint was configured to run ... However, that TSConfig does not / none of those TSConfigs include this file`.
+
+This error is caused by including the respective file in the scope of ESLint but not in the scope of TypeScript. For more information about this error and more suggestions how to solve it you can check the [FAQ of typescript-eslint](https://typescript-eslint.io/troubleshooting/typed-linting/#i-get-errors-telling-me-eslint-was-configured-to-run--however-that-tsconfig-does-not--none-of-those-tsconfigs-include-this-file).
+
+Our recommendation is to keep type-aware linting of those files.
+
+#### Solution 1
+
+Include the .(c|m)?js files in your main tsconfig.json:
+
+```json
+{
+  "include": [
+    // your existing includes
+    "*.*js", // this will include all .js, .cjs, .mjs files and similar in your project root
+    "*.ts", // this will include all .ts files and similar in your project root
+    // Add all other files/folders in which this error occurs
+  ]
+}
+```
+
+#### Solution 2
+
+Extend your main tsconfig.json in a tsconfig.eslint.json (or similar) which includes those files and ensures allowJs is set to true, which is used in a similar way by typescript-eslint in [their own repo](https://github.com/typescript-eslint/typescript-eslint/tree/v8.20.0):
+
+```json
+{
+  "compilerOptions": {
+    "noEmit": true,
+    "allowJs": true
+  },
+  "extends": "./tsconfig.json",
+  "include": [
+    // you have to add here all the items from your original tsconfig.json as it overwrites the whole array
+    "*.*js", // this will include all .js, .cjs, .mjs files and similar in your project root
+    "*.ts", // this will include all .ts files and similar in your project root
+    // Add all other files/folders in which this error occurs
+  ]
+}
+```
+
+In this case you have to overwrite the configured tsconfig file:
+
+```js
+import boehringer from '@boehringer-ingelheim/eslint-config';
+
+export default boehringer.config(
+  // other configs,
+  {
+    languageOptions: {
+      parserOptions: {
+        project: './tsconfig.eslint.json',
+        tsconfigRootDir: __dirname,
+      },
+    },
+  },
+)
+```
+
 ## Local Development
 
 ### Install Dependencies
@@ -202,7 +321,7 @@ npm run release
 - [ ] Shared configuration: Angular
 - [ ] Shared configuration: Node.js
 - [ ] Test Cases
-- [ ] "[Flat](https://eslint.org/docs/latest/use/configure/configuration-files-new)" Config
+- [x] "[Flat](https://eslint.org/docs/latest/use/configure/configuration-files-new)" Config
 
 ## Show your support
 
@@ -210,7 +329,7 @@ Give a ⭐️ if this project helped you!
 
 ## License
 
-Copyright © 2023 [Boehringer Ingelheim](https://github.com/boehringer-ingelheim).<br />
+Copyright © 2023 [Boehringer Ingelheim](https://github.com/boehringer-ingelheim).  
 This project is [MIT](https://github.com/boehringer-ingelheim/eslint-config/blob/master/LICENSE) licensed.
 
 ## Resources

package/configs/base.js

@@ -0,0 +1,148 @@
+const eslint = require('@eslint/js');
+const importPlugin = require('eslint-plugin-import');
+const perfectionist = require('eslint-plugin-perfectionist');
+const sonarjs = require('eslint-plugin-sonarjs');
+const tseslint = require('typescript-eslint');
+
+const {
+  SORT_CLASSES_GROUPS,
+  SORT_IMPORTS_GROUPS,
+  SORT_INTERSECTION_TYPES_GROUPS,
+} = require('../lib/eslint-plugin-perfectionist.js');
+
+module.exports = tseslint.config(
+  eslint.configs.recommended,
+  tseslint.configs.recommendedTypeChecked,
+  tseslint.configs.stylisticTypeChecked,
+  importPlugin.flatConfigs.recommended,
+  importPlugin.flatConfigs.typescript,
+  perfectionist.configs['recommended-natural'],
+  sonarjs.configs.recommended,
+  {
+    languageOptions: {
+      parserOptions: {
+        // find the tsconfig.json nearest each source file
+        projectService: true,
+      },
+    },
+    linterOptions: {
+      reportUnusedDisableDirectives: 'error',
+    },
+    rules: {
+      // @typescript-eslint: https://github.com/typescript-eslint/typescript-eslint/tree/main/packages/eslint-plugin/docs/rules
+      '@typescript-eslint/adjacent-overload-signatures': 'off', // disabled due to conflict with eslint-plugin-perfectionist
+      '@typescript-eslint/no-floating-promises': ['error', { ignoreVoid: true }],
+      '@typescript-eslint/no-misused-promises': [
+        'error',
+        {
+          checksVoidReturn: false,
+        },
+      ],
+      '@typescript-eslint/no-unused-vars': [
+        'error',
+        {
+          argsIgnorePattern: '^_',
+          caughtErrorsIgnorePattern: '^_',
+          varsIgnorePattern: '^_',
+        },
+      ],
+      '@typescript-eslint/sort-type-constituents': 'off', // disabled due to conflict with eslint-plugin-perfectionist
+
+      // eslint: https://github.com/eslint/eslint/tree/main/lib/rules
+      '@typescript-eslint/dot-notation': ['error', { allowPattern: '^[a-z]+(_[a-z]+)+$' }],
+      'arrow-body-style': ['error', 'as-needed'],
+      camelcase: 'warn',
+      curly: 'error',
+      'default-case': 'error',
+      eqeqeq: 'error',
+      'logical-assignment-operators': ['error', 'never'],
+      'no-console': ['warn', { allow: ['warn', 'error'] }],
+      'no-else-return': ['error', { allowElseIf: false }],
+      'no-empty-function': 'error',
+      'no-lonely-if': 'error',
+      'no-negated-condition': 'error',
+      'no-nested-ternary': 'error',
+      'no-plusplus': ['error', { allowForLoopAfterthoughts: true }],
+      'no-unneeded-ternary': 'error',
+      'no-useless-concat': 'error',
+      'operator-assignment': ['error', 'never'],
+      'prefer-const': 'error',
+      'prefer-rest-params': 'error',
+      'prefer-template': 'error',
+      'sort-imports': 'off', // disabled due to conflict with eslint-plugin-perfectionist
+      'sort-keys': 'off', // disabled due to conflict with eslint-plugin-perfectionist
+
+      // eslint-plugin-import: https://github.com/import-js/eslint-plugin-import/tree/main/docs/rules
+      'import/no-cycle': 'error',
+      'import/no-unused-modules': [
+        'error',
+        {
+          missingExports: true,
+          src: ['.'],
+          unusedExports: true,
+        },
+      ],
+      'import/order': 'off', // disabled due to conflict with eslint-plugin-perfectionist
+      'import/prefer-default-export': 'off',
+
+      // Deactivated as TypeScript provides the same checks as part of standard type checking: https://typescript-eslint.io/linting/troubleshooting/performance-troubleshooting
+      'import/default': 'off',
+      'import/named': 'off',
+      'import/namespace': 'off',
+      'import/no-named-as-default-member': 'off',
+
+      // eslint-plugin-perfectionist: https://github.com/azat-io/eslint-plugin-perfectionist
+      'perfectionist/sort-classes': [
+        'error',
+        {
+          ...perfectionist.configs['recommended-natural'].rules['perfectionist/sort-classes'][1],
+          groups: SORT_CLASSES_GROUPS,
+        },
+      ],
+      'perfectionist/sort-imports': [
+        'error',
+        {
+          ...perfectionist.configs['recommended-natural'].rules['perfectionist/sort-imports'][1],
+          groups: SORT_IMPORTS_GROUPS,
+          newlinesBetween: 'ignore',
+        },
+      ],
+      'perfectionist/sort-intersection-types': [
+        'error',
+        {
+          ...perfectionist.configs['recommended-natural'].rules['perfectionist/sort-intersection-types'][1],
+          groups: SORT_INTERSECTION_TYPES_GROUPS,
+        },
+      ],
+      'perfectionist/sort-named-imports': [
+        'error',
+        {
+          ...perfectionist.configs['recommended-natural'].rules['perfectionist/sort-named-imports'][1],
+          ignoreAlias: true,
+        },
+      ],
+      'perfectionist/sort-objects': [
+        'error',
+        {
+          ...perfectionist.configs['recommended-natural'].rules['perfectionist/sort-objects'][1],
+          partitionByComment: true,
+        },
+      ],
+    },
+    settings: {
+      'import/resolver': {
+        typescript: true,
+      },
+    },
+  },
+  {
+    files: [
+      '**/*.d.ts', // TypeScript declaration files
+      '**/*.{spec,test}.*', // Usually test files
+      './*.{js,cjs,mjs,ts,cts,mts}', // Mostly configuration files on root level
+    ],
+    rules: {
+      'import/no-unused-modules': 'off',
+    },
+  },
+);

package/configs/local.js

@@ -0,0 +1,16 @@
+const isCI = require('is-ci');
+const tseslint = require('typescript-eslint');
+
+module.exports = tseslint.config(
+  isCI
+    ? {}
+    : {
+        rules: {
+          // Only activate in CI, as suggested here: https://typescript-eslint.io/linting/troubleshooting/performance-troubleshooting#eslint-plugin-import
+          'import/no-cycle': 'off',
+          'import/no-deprecated': 'off',
+          'import/no-named-as-default': 'off',
+          'import/no-unused-modules': 'off',
+        },
+      },
+);

package/configs/naming-convention.js

@@ -0,0 +1,68 @@
+const tseslint = require('typescript-eslint');
+
+module.exports = tseslint.config({
+  rules: {
+    '@typescript-eslint/naming-convention': [
+      'error',
+      {
+        // Enforce that interface names do not start with an 'I'
+        custom: {
+          match: false,
+          regex: '^I[A-Z]',
+        },
+        format: ['StrictPascalCase'],
+        leadingUnderscore: 'forbid',
+        selector: 'interface',
+        trailingUnderscore: 'forbid',
+      },
+      {
+        // Enforce that type alias names do not start with an 'T'
+        custom: {
+          match: false,
+          regex: '^T[A-Z]',
+        },
+        format: ['StrictPascalCase'],
+        leadingUnderscore: 'forbid',
+        selector: 'typeAlias',
+        trailingUnderscore: 'forbid',
+      },
+      {
+        // Enforce that all top-level variables are in UPPER_CASE
+        format: ['UPPER_CASE'],
+        leadingUnderscore: 'forbid',
+        modifiers: ['global'],
+        selector: 'variable',
+        trailingUnderscore: 'forbid',
+        types: ['boolean', 'number', 'string'],
+      },
+      {
+        // Enforce that all top-level array variables are in UPPER_CASE and are suffixed with a 'S' to indicate plural form
+        format: ['UPPER_CASE'],
+        leadingUnderscore: 'forbid',
+        modifiers: ['global'],
+        selector: 'variable',
+        suffix: ['S'],
+        trailingUnderscore: 'forbid',
+        types: ['array'],
+      },
+      {
+        // Enforce that array variables are suffixed with a 's' to indicate plural form
+        format: ['strictCamelCase'],
+        leadingUnderscore: 'forbid',
+        selector: 'variable',
+        suffix: ['s'],
+        trailingUnderscore: 'forbid',
+        types: ['array'],
+      },
+      {
+        // Enforce that boolean variables are prefixed with an allowed verb
+        format: ['StrictPascalCase'],
+        leadingUnderscore: 'forbid',
+        prefix: ['is', 'has', 'should', 'can'],
+        selector: 'variable',
+        trailingUnderscore: 'forbid',
+        types: ['boolean'],
+      },
+    ],
+  },
+});

package/configs/nextjs.js

@@ -0,0 +1,46 @@
+const nextPlugin = require('@next/eslint-plugin-next');
+const tseslint = require('typescript-eslint');
+
+const react = require('./react.js');
+
+module.exports = tseslint.config(
+  ...react,
+  {
+    plugins: {
+      '@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,
+    },
+  },
+  {
+    ignores: ['.next/*'],
+  },
+);

package/configs/playwright.js

@@ -0,0 +1,13 @@
+const playwright = require('eslint-plugin-playwright');
+const tseslint = require('typescript-eslint');
+
+module.exports = tseslint.config({
+  ...playwright.configs['flat/recommended'],
+  rules: {
+    ...playwright.configs['flat/recommended'].rules,
+    // eslint-plugin-playwright: https://github.com/playwright-community/eslint-plugin-playwright
+    'playwright/prefer-to-be': 'error',
+    'playwright/prefer-to-have-length': 'error',
+    'playwright/require-top-level-describe': 'error',
+  },
+});

package/configs/prettier-disable.js

@@ -0,0 +1,10 @@
+const prettier = require('eslint-config-prettier');
+const tseslint = require('typescript-eslint');
+
+module.exports = tseslint.config({
+  ...prettier,
+  rules: {
+    ...prettier.rules,
+    curly: 'error',
+  },
+});

package/configs/react.js

@@ -0,0 +1,108 @@
+const jsxA11y = require('eslint-plugin-jsx-a11y');
+const react = require('eslint-plugin-react');
+const reactHooks = require('eslint-plugin-react-hooks');
+const reactRefresh = require('eslint-plugin-react-refresh');
+const globals = require('globals');
+const tseslint = require('typescript-eslint');
+
+const { SORT_IMPORTS_GROUPS } = require('../lib/eslint-plugin-perfectionist.js');
+const base = require('./base.js');
+
+module.exports = tseslint.config(
+  ...base,
+  jsxA11y.flatConfigs.recommended,
+  react.configs.flat.recommended,
+  react.configs.flat['jsx-runtime'],
+  reactRefresh.configs.recommended,
+  {
+    languageOptions: {
+      globals: {
+        ...globals.browser,
+      },
+      parserOptions: {
+        ecmaFeatures: {
+          jsx: true,
+        },
+      },
+    },
+    plugins: {
+      'react-hooks': reactHooks,
+    },
+    rules: {
+      // @typescript-eslint: https://github.com/typescript-eslint/typescript-eslint/tree/main/packages/eslint-plugin/docs/rules
+      '@typescript-eslint/consistent-type-definitions': ['error', 'type'],
+      '@typescript-eslint/no-restricted-types': [
+        'error',
+        {
+          types: {
+            'React.FC': {
+              message:
+                'Please use object type destructure declaration, see: https://react-typescript-cheatsheet.netlify.app/docs/basic/getting-started/function_components',
+            },
+            'React.FunctionalComponent': {
+              message:
+                'Please use object type destructure declaration, see: https://react-typescript-cheatsheet.netlify.app/docs/basic/getting-started/function_components',
+            },
+          },
+        },
+      ],
+
+      // eslint-plugin-react: https://github.com/jsx-eslint/eslint-plugin-react/tree/master/lib/rules
+      'react/jsx-pascal-case': 'error',
+      'react/jsx-sort-props': 'off', // disabled due to conflict with eslint-plugin-perfectionist
+      'react/sort-default-props': 'error',
+
+      // eslint-plugin-react-hooks: https://github.com/facebook/react/blob/main/packages/eslint-plugin-react-hooks/README.md
+      'react-hooks/exhaustive-deps': 'error',
+      'react-hooks/rules-of-hooks': 'error',
+
+      // eslint-plugin-perfectionist: https://github.com/azat-io/eslint-plugin-perfectionist
+      'perfectionist/sort-imports': [
+        'error',
+        {
+          customGroups: {
+            type: {
+              react: ['react'],
+            },
+            value: {
+              react: ['react'],
+            },
+          },
+          groups: ['react', ...SORT_IMPORTS_GROUPS],
+          ignoreCase: true,
+          newlinesBetween: 'ignore',
+          type: 'natural',
+        },
+      ],
+      'perfectionist/sort-jsx-props': [
+        'error',
+        {
+          customGroups: {
+            callback: '^on.+',
+            reservedProps: ['children', 'dangerouslySetInnerHTML', 'key', 'ref'], // Reserved props from: https://github.com/jsx-eslint/eslint-plugin-react/blob/master/lib/rules/jsx-sort-props.js#L41-L46
+          },
+          groups: ['reservedProps', 'unknown', 'callback'],
+          ignoreCase: true,
+          type: 'natural',
+        },
+      ],
+
+      // eslint-plugin-react-refresh: https://github.com/ArnaudBarre/eslint-plugin-react-refresh
+      'react-refresh/only-export-components': 'warn',
+
+      // Forbid enum declaration
+      'no-restricted-syntax': [
+        'error',
+        {
+          message: "Don't declare enums",
+          selector: 'TSEnumDeclaration',
+        },
+      ],
+    },
+    settings: {
+      react: {
+        version: 'detect',
+      },
+    },
+  },
+);

package/{base → configs}/strict.js

@@ -1,14 +1,8 @@
-/**
- * Workaround to allow ESLint to resolve plugins that were installed
- * by an external config, see https://github.com/eslint/eslint/issues/3458.
- */
-require('@rushstack/eslint-patch/modern-module-resolution');
+const tseslint = require('typescript-eslint');
 
-const typescriptEslintPlugin = require('@typescript-eslint/eslint-plugin');
+const base = require('./base.js');
 
-/** @type {import('eslint').ESLint.ConfigData}  */
-module.exports = {
-  extends: ['./index.js', 'plugin:@typescript-eslint/strict-type-checked'],
+module.exports = tseslint.config(...base, tseslint.configs.strictTypeChecked, {
   rules: {
     // @typescript-eslint: https://github.com/typescript-eslint/typescript-eslint/tree/main/packages/eslint-plugin/docs/rules
     '@typescript-eslint/consistent-type-imports': 'error',
@@ -16,7 +10,7 @@ module.exports = {
     '@typescript-eslint/restrict-template-expressions': [
       'error',
       {
-        ...typescriptEslintPlugin.rules['restrict-template-expressions'].meta.docs.recommended.strict[0],
+        ...tseslint.plugin.rules['restrict-template-expressions'].meta.docs.recommended.strict[0],
         allowNumber: true,
       },
     ],
@@ -24,4 +18,4 @@ module.exports = {
     // eslint-plugin-import: https://github.com/import-js/eslint-plugin-import/tree/main/docs/rules
     'import/consistent-type-specifier-style': ['error', 'prefer-top-level'],
   },
-};
+});

package/index.js

@@ -0,0 +1,24 @@
+const tseslint = require('typescript-eslint');
+
+const base = require('./configs/base.js');
+const local = require('./configs/local.js');
+const namingConvention = require('./configs/naming-convention.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');
+const strict = require('./configs/strict.js');
+
+module.exports = {
+  config: tseslint.config,
+  configs: {
+    base,
+    local,
+    namingConvention,
+    nextjs,
+    playwright,
+    prettierDisable,
+    react,
+    strict,
+  },
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@boehringer-ingelheim/eslint-config",
-  "version": "6.0.2",
+  "version": "7.0.0-naming-convetion-configuration.1",
   "description": "Shared eslint configuration used at Boehringer Ingelheim for code styling",
   "keywords": [
     "boehringer",
@@ -14,49 +14,47 @@
   ],
   "license": "MIT",
   "files": [
-    "base",
-    "lib",
-    "react",
-    "playwright",
-    "prettier-disable"
+    "configs",
+    "lib"
   ],
-  "main": "base/index.js",
+  "main": "index.js",
   "scripts": {
     "prepare": "husky",
     "release": "dotenv -- semantic-release --no-ci",
     "release:ci": "semantic-release",
-    "repair": "npx --no rimraf .git/hooks node_modules package-lock.json && npm install"
+    "repair": "npx --no rimraf@6 .git/hooks node_modules package-lock.json && npm install",
+    "lint": "eslint ."
   },
   "peerDependencies": {
-    "eslint": "^8.57.1"
+    "eslint": ">= 8"
   },
   "dependencies": {
-    "@rushstack/eslint-patch": "^1.10.4",
-    "@typescript-eslint/eslint-plugin": "^8.18.0",
-    "@typescript-eslint/parser": "^8.18.0",
-    "eslint-config-prettier": "^9.1.0",
+    "@eslint/js": "^9.18.0",
+    "@next/eslint-plugin-next": "^15.1.4",
+    "eslint-config-prettier": "^10.0.1",
     "eslint-import-resolver-typescript": "^3.7.0",
     "eslint-plugin-import": "^2.31.0",
     "eslint-plugin-jsx-a11y": "^6.10.2",
-    "eslint-plugin-perfectionist": "^4.3.0",
+    "eslint-plugin-perfectionist": "^4.6.0",
     "eslint-plugin-playwright": "^2.1.0",
-    "eslint-plugin-react": "^7.37.2",
+    "eslint-plugin-react": "^7.37.4",
     "eslint-plugin-react-hooks": "^5.1.0",
-    "eslint-plugin-react-refresh": "^0.4.16",
+    "eslint-plugin-react-refresh": "^0.4.18",
     "eslint-plugin-sonarjs": "^1.0.4",
-    "eslint-plugin-typescript-enum": "^2.1.0",
-    "is-ci": "^4.1.0"
+    "globals": "^15.14.0",
+    "is-ci": "^4.1.0",
+    "typescript-eslint": "^8.20.0"
   },
   "devDependencies": {
     "@boehringer-ingelheim/prettier-config": "2.0.0",
-    "@commitlint/cli": "19.6.0",
+    "@commitlint/cli": "19.6.1",
     "@commitlint/config-conventional": "19.6.0",
     "@commitlint/types": "19.5.0",
     "@semantic-release/changelog": "6.0.3",
     "@semantic-release/git": "10.0.1",
-    "dotenv-cli": "7.4.4",
+    "dotenv-cli": "8.0.0",
     "husky": "9.1.7",
     "prettier": "3.4.2",
-    "semantic-release": "24.2.0"
+    "semantic-release": "24.2.1"
   }
 }

package/base/index.js

@@ -1,156 +0,0 @@
-const {
-  SORT_CLASSES_GROUPS,
-  SORT_IMPORTS_GROUPS,
-  SORT_INTERSECTION_TYPES_GROUPS,
-} = require('../lib/eslint-plugin-perfectionist');
-
-/**
- * Workaround to allow ESLint to resolve plugins that were installed
- * by an external config, see https://github.com/eslint/eslint/issues/3458.
- */
-require('@rushstack/eslint-patch/modern-module-resolution');
-const eslintPluginPerfectionist = require('eslint-plugin-perfectionist');
-
-/** @type {import('eslint').ESLint.ConfigData & { parserOptions: import('eslint').ESLint.ConfigData['parserOptions'] & import('@typescript-eslint/parser').ParserOptions } }  */
-module.exports = {
-  env: {
-    es2022: true,
-  },
-  extends: [
-    'eslint:recommended',
-    'plugin:@typescript-eslint/recommended-type-checked',
-    'plugin:@typescript-eslint/stylistic-type-checked',
-    'plugin:import/recommended',
-    'plugin:import/typescript',
-    'plugin:perfectionist/recommended-natural-legacy',
-    'plugin:sonarjs/recommended-legacy',
-  ],
-  overrides: [
-    {
-      files: [
-        '**/*.d.ts', // TypeScript declaration files
-        '**/*.{spec,test}.*', // Usually test files
-        './*.{js,cjs,mjs,ts,cts,mts}', // Mostly configuration files on root level
-      ],
-      rules: {
-        'import/no-unused-modules': 'off',
-      },
-    },
-  ],
-  parser: '@typescript-eslint/parser',
-  parserOptions: {
-    // find the tsconfig.json nearest each source file
-    project: true,
-  },
-  plugins: ['@typescript-eslint', 'sonarjs'],
-  // Warn about unused eslint-disable directives
-  reportUnusedDisableDirectives: true,
-  rules: {
-    // @typescript-eslint: https://github.com/typescript-eslint/typescript-eslint/tree/main/packages/eslint-plugin/docs/rules
-    '@typescript-eslint/adjacent-overload-signatures': 'off', // disabled due to conflict with eslint-plugin-perfectionist
-    '@typescript-eslint/no-floating-promises': ['error', { ignoreVoid: true }],
-    '@typescript-eslint/no-misused-promises': [
-      'error',
-      {
-        checksVoidReturn: false,
-      },
-    ],
-    '@typescript-eslint/no-unused-vars': [
-      'error',
-      {
-        argsIgnorePattern: '^_',
-        caughtErrorsIgnorePattern: '^_',
-        varsIgnorePattern: '^_',
-      },
-    ],
-    '@typescript-eslint/sort-type-constituents': 'off', // disabled due to conflict with eslint-plugin-perfectionist
-
-    // eslint: https://github.com/eslint/eslint/tree/main/lib/rules
-    '@typescript-eslint/dot-notation': ['error', { allowPattern: '^[a-z]+(_[a-z]+)+$' }],
-    'arrow-body-style': ['error', 'as-needed'],
-    camelcase: 'warn',
-    curly: 'error',
-    'default-case': 'error',
-    eqeqeq: 'error',
-    'logical-assignment-operators': ['error', 'never'],
-    'no-console': ['warn', { allow: ['warn', 'error'] }],
-    'no-else-return': ['error', { allowElseIf: false }],
-    'no-empty-function': 'error',
-    'no-lonely-if': 'error',
-    'no-negated-condition': 'error',
-    'no-nested-ternary': 'error',
-    'no-plusplus': ['error', { allowForLoopAfterthoughts: true }],
-    'no-unneeded-ternary': 'error',
-    'no-useless-concat': 'error',
-    'operator-assignment': ['error', 'never'],
-    'prefer-const': 'error',
-    'prefer-rest-params': 'error',
-    'prefer-template': 'error',
-    'sort-imports': 'off', // disabled due to conflict with eslint-plugin-perfectionist
-    'sort-keys': 'off', // disabled due to conflict with eslint-plugin-perfectionist
-
-    // eslint-plugin-import: https://github.com/import-js/eslint-plugin-import/tree/main/docs/rules
-    'import/no-cycle': 'error',
-    'import/no-unused-modules': [
-      'error',
-      {
-        missingExports: true,
-        src: ['.'],
-        unusedExports: true,
-      },
-    ],
-    'import/order': 'off', // disabled due to conflict with eslint-plugin-perfectionist
-    'import/prefer-default-export': 'off',
-
-    // Deactivated as TypeScript provides the same checks as part of standard type checking: https://typescript-eslint.io/linting/troubleshooting/performance-troubleshooting
-    'import/default': 'off',
-    'import/named': 'off',
-    'import/namespace': 'off',
-    'import/no-named-as-default-member': 'off',
-
-    // eslint-plugin-perfectionist: https://github.com/azat-io/eslint-plugin-perfectionist
-    'perfectionist/sort-classes': [
-      'error',
-      {
-        ...eslintPluginPerfectionist.configs['recommended-natural-legacy'].rules['perfectionist/sort-classes'][1],
-        groups: SORT_CLASSES_GROUPS,
-      },
-    ],
-    'perfectionist/sort-imports': [
-      'error',
-      {
-        ...eslintPluginPerfectionist.configs['recommended-natural-legacy'].rules['perfectionist/sort-imports'][1],
-        groups: SORT_IMPORTS_GROUPS,
-        newlinesBetween: 'ignore',
-      },
-    ],
-    'perfectionist/sort-intersection-types': [
-      'error',
-      {
-        ...eslintPluginPerfectionist.configs['recommended-natural-legacy'].rules[
-          'perfectionist/sort-intersection-types'
-        ][1],
-        groups: SORT_INTERSECTION_TYPES_GROUPS,
-      },
-    ],
-    'perfectionist/sort-named-imports': [
-      'error',
-      {
-        ...eslintPluginPerfectionist.configs['recommended-natural-legacy'].rules['perfectionist/sort-named-imports'][1],
-        ignoreAlias: true,
-      },
-    ],
-    'perfectionist/sort-objects': [
-      'error',
-      {
-        ...eslintPluginPerfectionist.configs['recommended-natural-legacy'].rules['perfectionist/sort-objects'][1],
-        partitionByComment: true,
-      },
-    ],
-  },
-  settings: {
-    'import/resolver': {
-      typescript: true,
-    },
-  },
-};

package/base/local.js

@@ -1,20 +0,0 @@
-/**
- * Workaround to allow ESLint to resolve plugins that were installed
- * by an external config, see https://github.com/eslint/eslint/issues/3458.
- */
-require('@rushstack/eslint-patch/modern-module-resolution');
-
-const isCI = require('is-ci');
-
-/** @type {import('eslint').ESLint.ConfigData}  */
-module.exports = {
-  rules: isCI
-    ? {}
-    : {
-        // Only activate in CI, as suggested here: https://typescript-eslint.io/linting/troubleshooting/performance-troubleshooting#eslint-plugin-import
-        'import/no-cycle': 'off',
-        'import/no-deprecated': 'off',
-        'import/no-named-as-default': 'off',
-        'import/no-unused-modules': 'off',
-      },
-};

package/playwright/index.js

@@ -1,16 +0,0 @@
-/**
- * Workaround to allow ESLint to resolve plugins that were installed
- * by an external config, see https://github.com/eslint/eslint/issues/3458.
- */
-require('@rushstack/eslint-patch/modern-module-resolution');
-
-/** @type {import('eslint').ESLint.ConfigData}  */
-module.exports = {
-  extends: ['plugin:playwright/playwright-test'],
-  rules: {
-    // eslint-plugin-playwright: https://github.com/playwright-community/eslint-plugin-playwright
-    'playwright/prefer-to-be': 'error',
-    'playwright/prefer-to-have-length': 'error',
-    'playwright/require-top-level-describe': 'error',
-  },
-};

package/prettier-disable/index.js

@@ -1,13 +0,0 @@
-/**
- * Workaround to allow ESLint to resolve plugins that were installed
- * by an external config, see https://github.com/eslint/eslint/issues/3458.
- */
-require('@rushstack/eslint-patch/modern-module-resolution');
-
-/** @type {import('eslint').ESLint.ConfigData & { parserOptions: import('eslint').ESLint.ConfigData['parserOptions'] & import('@typescript-eslint/parser').ParserOptions } }  */
-module.exports = {
-  extends: ['prettier'],
-  rules: {
-    curly: 'error',
-  },
-};

package/react/index.js

@@ -1,96 +0,0 @@
-const { SORT_IMPORTS_GROUPS } = require('../lib/eslint-plugin-perfectionist');
-
-/**
- * Workaround to allow ESLint to resolve plugins that were installed
- * by an external config, see https://github.com/eslint/eslint/issues/3458.
- */
-require('@rushstack/eslint-patch/modern-module-resolution');
-
-/** @type {import('eslint').ESLint.ConfigData & { parserOptions: import('eslint').ESLint.ConfigData['parserOptions'] & import('@typescript-eslint/parser').ParserOptions } }  */
-module.exports = {
-  env: {
-    browser: true,
-  },
-  extends: [
-    '../base/index.js',
-    'plugin:jsx-a11y/recommended',
-    'plugin:react/recommended',
-    'plugin:react/jsx-runtime',
-    'plugin:typescript-enum/recommended',
-  ],
-  parserOptions: {
-    ecmaFeatures: {
-      jsx: true,
-    },
-    ecmaVersion: 'latest',
-    sourceType: 'module',
-  },
-  plugins: ['jsx-a11y', 'react', 'react-hooks', 'react-refresh', 'typescript-enum'],
-  rules: {
-    // @typescript-eslint: https://github.com/typescript-eslint/typescript-eslint/tree/main/packages/eslint-plugin/docs/rules
-    '@typescript-eslint/no-restricted-types': [
-      'error',
-      {
-        types: {
-          'React.FC': {
-            message:
-              'Please use object type destructure declaration, see: https://react-typescript-cheatsheet.netlify.app/docs/basic/getting-started/function_components',
-          },
-          'React.FunctionalComponent': {
-            message:
-              'Please use object type destructure declaration, see: https://react-typescript-cheatsheet.netlify.app/docs/basic/getting-started/function_components',
-          },
-        },
-      },
-    ],
-    '@typescript-eslint/consistent-type-definitions': ['error', 'type'],
-
-    // eslint-plugin-react: https://github.com/jsx-eslint/eslint-plugin-react/tree/master/lib/rules
-    'react/jsx-pascal-case': 'error',
-    'react/jsx-sort-props': 'off', // disabled due to conflict with eslint-plugin-perfectionist
-    'react/sort-default-props': 'error',
-
-    // eslint-plugin-react-hooks: https://github.com/facebook/react/blob/main/packages/eslint-plugin-react-hooks/README.md
-    'react-hooks/exhaustive-deps': 'error',
-    'react-hooks/rules-of-hooks': 'error',
-
-    // eslint-plugin-perfectionist: https://github.com/azat-io/eslint-plugin-perfectionist
-    'perfectionist/sort-imports': [
-      'error',
-      {
-        customGroups: {
-          type: {
-            react: ['react'],
-          },
-          value: {
-            react: ['react'],
-          },
-        },
-        groups: ['react', ...SORT_IMPORTS_GROUPS],
-        ignoreCase: true,
-        newlinesBetween: 'ignore',
-        type: 'natural',
-      },
-    ],
-    'perfectionist/sort-jsx-props': [
-      'error',
-      {
-        customGroups: {
-          callback: '^on.+',
-          reservedProps: ['children', 'dangerouslySetInnerHTML', 'key', 'ref'], // Reserved props from: https://github.com/jsx-eslint/eslint-plugin-react/blob/master/lib/rules/jsx-sort-props.js#L41-L46
-        },
-        groups: ['reservedProps', 'unknown', 'callback'],
-        ignoreCase: true,
-        type: 'natural',
-      },
-    ],
-
-    // eslint-plugin-react-refresh: https://github.com/ArnaudBarre/eslint-plugin-react-refresh
-    'react-refresh/only-export-components': 'warn',
-  },
-  settings: {
-    react: {
-      version: 'detect',
-    },
-  },
-};