@boehringer-ingelheim/eslint-config 7.0.0-next.7 → 7.0.0-next.9

package/README.md

@@ -84,21 +84,7 @@ 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/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: {
-      projectService: {
-        defaultProject: ['./tsconfig.dev.json'],
-      },
-    },
-  },
-});
-```
+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).
 
 ### Local
 
@@ -176,6 +162,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.
 
+### (experimental) Naming Convention
+
+```js
+import boehringer from '@boehringer-ingelheim/eslint-config';
+
+export default boehringer.config(
+  boehringer.configs.strict,
+  // possibly other configs,
+  boehringer.configs.experimentalNamingConvention
+);
+```
+
+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
@@ -201,9 +201,12 @@ This shared ESLint configuration is wrapper around [`eslint-config-disable`](htt
 
 ### 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`.
+ESLint may throw one of the following errors 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`.
+- `... was not found by the project service. Consider either including it in the tsconfig.json or including it in allowDefaultProject`
 
-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).
+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 [troubleshooting of typescript-eslint](https://typescript-eslint.io/troubleshooting/typed-linting/#i-get-errors-telling-me--was-not-found-by-the-project-service-consider-either-including-it-in-the-tsconfigjson-or-including-it-in-allowdefaultproject).
 
 Our recommendation is to keep type-aware linting of those files.
 
@@ -211,7 +214,7 @@ Our recommendation is to keep type-aware linting of those files.
 
 Include the .(c|m)?js files in your main tsconfig.json:
 
-```json
+```jsonc
 {
   "include": [
     // your existing includes
@@ -224,25 +227,7 @@ Include the .(c|m)?js files in your main tsconfig.json:
 
 #### 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:
+You can use the new [`allowDefaultProject`](https://typescript-eslint.io/packages/parser#allowdefaultproject) option, which works perfectly with our [`projectService` configuration](./configs/base.js#L25):
 
 ```js
 import boehringer from '@boehringer-ingelheim/eslint-config';
@@ -252,8 +237,14 @@ export default boehringer.config(
   {
     languageOptions: {
       parserOptions: {
-        project: './tsconfig.eslint.json',
-        tsconfigRootDir: __dirname,
+        projectService: {
+          allowDefaultProject: [
+            '*.*js', 
+            '.*.*js',
+          ],
+          // defaultProject can be used to specify separate tsconfig options for "out-of-project" files included by allowDefaultProject
+          // defaultProject: 'tsconfig.eslint.json',
+        },
       },
     },
   },

package/configs/experimental-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/index.d.ts

@@ -0,0 +1,18 @@
+import { Config } from 'typescript-eslint';
+
+type Configs =
+  | 'base'
+  | 'experimentalNamingConvention'
+  | '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

@@ -1,6 +1,7 @@
 const tseslint = require('typescript-eslint');
 
 const base = require('./configs/base.js');
+const experimentalNamingConvention = require('./configs/experimental-naming-convention.js');
 const local = require('./configs/local.js');
 const nextjs = require('./configs/nextjs.js');
 const playwright = require('./configs/playwright.js');
@@ -12,6 +13,7 @@ module.exports = {
   config: tseslint.config,
   configs: {
     base,
+    experimentalNamingConvention,
     local,
     nextjs,
     playwright,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@boehringer-ingelheim/eslint-config",
-  "version": "7.0.0-next.7",
+  "version": "7.0.0-next.9",
   "description": "Shared eslint configuration used at Boehringer Ingelheim for code styling",
   "keywords": [
     "boehringer",
@@ -15,9 +15,12 @@
   "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",