@boehringer-ingelheim/eslint-config 7.0.0-migrate-flat-config.1 → 7.0.0-naming-convetion-configuration.2

package/README.md

@@ -52,8 +52,7 @@ export default boehringer.config(
 );
 ```
 
-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
 
@@ -63,7 +62,7 @@ npx eslint .
 
 ## Shared Configurations
 
-Opinionated Options that differ from the standard/recommended eslint configurations.
+Opinionated Options that differ from the standard/recommended ESLint configurations.
 
 ### Base
 
@@ -85,21 +84,20 @@ 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
 import boehringer from '@boehringer-ingelheim/eslint-config';
 
-export default boehringer.config(
-  boehringer.configs.base,
-  {
-    languageOptions: {
-      parserOptions: {
-        project: ['./tsconfig.dev.json'],
+export default boehringer.config(boehringer.configs.base, {
+  languageOptions: {
+    parserOptions: {
+      projectService: {
+        defaultProject: ['./tsconfig.dev.json'],
       },
     },
-  }
-);
+  },
+});
 ```
 
 ### Local
@@ -143,10 +141,24 @@ 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).
 
+### Next.js
+
+```js
+import boehringer from '@boehringer-ingelheim/eslint-config';
+
+export default boehringer.config(
+  boehringer.configs.strict,
+  boehringer.configs.nextjs
+);
+```
+
+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
@@ -164,6 +176,20 @@ 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.
 
+### 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
@@ -185,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
@@ -240,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

@@ -22,7 +22,7 @@ module.exports = tseslint.config(
     languageOptions: {
       parserOptions: {
         // find the tsconfig.json nearest each source file
-        project: true,
+        projectService: true,
       },
     },
     linterOptions: {
@@ -74,14 +74,13 @@ module.exports = tseslint.config(
 
       // 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,
-        },
-      ],
+      /**
+       * The rule is disabled for now as it is not compatible with flat-configs, without adding an artifical `.eslintrc` file.
+       *
+       * @see: https://github.com/import-js/eslint-plugin-import/issues/3079#issuecomment-2557191925
+       * @todo Enable rule, as soon as fix is available: https://github.com/Boehringer-Ingelheim/eslint-config/blob/9f028ed43bb5db11082a2982f249ddfe7eaf5c13/configs/base.js#L77
+       */
+      'import/no-unused-modules': 'off',
       'import/order': 'off', // disabled due to conflict with eslint-plugin-perfectionist
       'import/prefer-default-export': 'off',
 
@@ -95,14 +94,14 @@ module.exports = tseslint.config(
       'perfectionist/sort-classes': [
         'error',
         {
-          ...perfectionist.configs['recommended-natural-legacy'].rules['perfectionist/sort-classes'][1],
+          ...perfectionist.configs['recommended-natural'].rules['perfectionist/sort-classes'][1],
           groups: SORT_CLASSES_GROUPS,
         },
       ],
       'perfectionist/sort-imports': [
         'error',
         {
-          ...perfectionist.configs['recommended-natural-legacy'].rules['perfectionist/sort-imports'][1],
+          ...perfectionist.configs['recommended-natural'].rules['perfectionist/sort-imports'][1],
           groups: SORT_IMPORTS_GROUPS,
           newlinesBetween: 'ignore',
         },
@@ -110,21 +109,21 @@ module.exports = tseslint.config(
       'perfectionist/sort-intersection-types': [
         'error',
         {
-          ...perfectionist.configs['recommended-natural-legacy'].rules['perfectionist/sort-intersection-types'][1],
+          ...perfectionist.configs['recommended-natural'].rules['perfectionist/sort-intersection-types'][1],
           groups: SORT_INTERSECTION_TYPES_GROUPS,
         },
       ],
       'perfectionist/sort-named-imports': [
         'error',
         {
-          ...perfectionist.configs['recommended-natural-legacy'].rules['perfectionist/sort-named-imports'][1],
+          ...perfectionist.configs['recommended-natural'].rules['perfectionist/sort-named-imports'][1],
           ignoreAlias: true,
         },
       ],
       'perfectionist/sort-objects': [
         'error',
         {
-          ...perfectionist.configs['recommended-natural-legacy'].rules['perfectionist/sort-objects'][1],
+          ...perfectionist.configs['recommended-natural'].rules['perfectionist/sort-objects'][1],
           partitionByComment: true,
         },
       ],

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/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
@@ -79,8 +78,8 @@ module.exports = tseslint.config(
         '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#L40C12-L40C12
+            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,

package/index.d.ts

@@ -0,0 +1,10 @@
+import { Config } from 'typescript-eslint';
+
+type Configs = 'base' | 'local' | 'nextjs' | 'playwright' | 'prettierDisable' | 'react' | 'strict';
+
+declare module './index' {
+  const config: typeof import('typescript-eslint').config;
+  const configs: Record<Configs, Config>;
+
+  export { config, configs };
+}

package/index.js

@@ -2,6 +2,8 @@ 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');
@@ -12,6 +14,8 @@ module.exports = {
   configs: {
     base,
     local,
+    namingConvention,
+    nextjs,
     playwright,
     prettierDisable,
     react,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@boehringer-ingelheim/eslint-config",
-  "version": "7.0.0-migrate-flat-config.1",
+  "version": "7.0.0-naming-convetion-configuration.2",
   "description": "Shared eslint configuration used at Boehringer Ingelheim for code styling",
   "keywords": [
     "boehringer",
@@ -15,45 +15,49 @@
   "license": "MIT",
   "files": [
     "configs",
-    "lib"
+    "lib",
+    "index.js",
+    "index.d.ts"
   ],
   "main": "index.js",
+  "types": "index.d.ts",
   "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"
   },
   "dependencies": {
-    "@eslint/js": "^9.17.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",
     "globals": "^15.14.0",
     "is-ci": "^4.1.0",
-    "typescript-eslint": "^8.18.1"
+    "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"
   }
 }