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

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
 
@@ -160,8 +159,6 @@ 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. The configuration also adapts the rule `react-refresh/only-export-components` to be compatible with Next.js.
 
-It
-
 ### Playwright
 
 ```js
@@ -200,6 +197,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
@@ -255,7 +315,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

@@ -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',
 

package/package.json

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