@boehringer-ingelheim/eslint-config 7.2.0 → 7.3.0-include-ignore-file.2

package/README.md

@@ -35,7 +35,7 @@ export default 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
+##### 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:
 
@@ -52,6 +52,33 @@ export default boehringer.config(
 );
 ```
 
+#### `boehringer.includeIgnoreFile()`
+
+The `includeIgnoreFile` function allows you to include `.gitignore` files in your ESLint configuration using a relative path.
+This is an adjusted version of the same function from ESLint ([Ignore Files](https://eslint.org/docs/latest/use/configure/ignore#including-gitignore-files)).
+It is recommended to use this function to ensure that your `.gitignore` file is properly included in your ESLint setup.
+
+```js
+import boehringer from '@boehringer-ingelheim/eslint-config';
+
+export default boehringer.config(
+  boehringer.includeIgnoreFile(), // default value '.gitignore'
+  boehringer.configs.strict,
+);
+```
+
+or in case you have a different paths to your `.gitignore` file(s):
+
+```js
+import boehringer from '@boehringer-ingelheim/eslint-config';
+
+export default boehringer.config(
+  boehringer.includeIgnoreFile('./backend/.gitignore'),
+  boehringer.includeIgnoreFile('./frontend/.gitignore'),
+  boehringer.configs.strict,
+);
+```
+
 More Information: [ESLint - Configuration Files](https://eslint.org/docs/latest/use/configure/configuration-files#extending-configuration-files)
 
 ### Run

package/index.d.ts

@@ -1,3 +1,4 @@
+import { FlatConfig } from '@eslint/compat';
 import { Config } from 'typescript-eslint';
 
 type Configs =
@@ -13,6 +14,15 @@ type Configs =
 declare module './index' {
   const config: typeof import('typescript-eslint').config;
   const configs: Record<Configs, Config>;
+  /**
+   * Reads an ignore file (e.g. `.gitignore`) and returns an object with the ignore patterns.
+   *
+   * @param {string} [ignoreFilePath='.gitignore'] - The path to the ignore file. Defaults to `.gitignore`.
+   * @throws {TypeError} If the provided path is not a string.
+   * @throws {Error} If the provided path is an empty string.
+   * @returns {FlatConfig} The result of including the ignore file at the resolved absolute path.
+   */
+  const includeIgnoreFile: (ignoreFilePath = '.gitignore') => FlatConfig;
 
-  export { config, configs };
+  export { config, configs, includeIgnoreFile };
 }

package/index.js

@@ -8,6 +8,7 @@ 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');
+const { includeIgnoreFile } = require('./lib/include-ignore-file.js');
 
 module.exports = {
   config: tseslint.config,
@@ -21,4 +22,5 @@ module.exports = {
     react,
     strict,
   },
+  includeIgnoreFile,
 };

package/lib/include-ignore-file.js

@@ -0,0 +1,28 @@
+const { includeIgnoreFile: includeIgnoreFileAbsolute } = require('@eslint/compat');
+const path = require('node:path');
+const { cwd } = require('node:process');
+
+/**
+ * Reads an ignore file (e.g. `.gitignore`) and returns an object with the ignore patterns.
+ *
+ * @param {string} [ignoreFilePath='.gitignore'] - The path to the ignore file. Defaults to `.gitignore`.
+ * @throws {TypeError} If the provided path is not a string.
+ * @throws {Error} If the provided path is an empty string.
+ * @returns {import('@eslint/compat').FlatConfig} The result of including the ignore file at the resolved absolute path.
+ */
+const includeIgnoreFile = (ignoreFilePath = '.gitignore') => {
+  if (typeof ignoreFilePath !== 'string') {
+    throw new TypeError('Expected a string');
+  }
+
+  if (ignoreFilePath === '') {
+    throw new Error('Expected a non-empty string');
+  }
+
+  const absolutePath = path.resolve(cwd(), ignoreFilePath);
+  return includeIgnoreFileAbsolute(absolutePath);
+};
+
+module.exports = {
+  includeIgnoreFile,
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@boehringer-ingelheim/eslint-config",
-  "version": "7.2.0",
+  "version": "7.3.0-include-ignore-file.2",
   "description": "Shared eslint configuration used at Boehringer Ingelheim for code styling",
   "keywords": [
     "boehringer",
@@ -32,21 +32,22 @@
     "eslint": ">= 8"
   },
   "dependencies": {
-    "@eslint/js": "^9.19.0",
-    "@next/eslint-plugin-next": "^15.1.6",
+    "@eslint/compat": "^1.2.6",
+    "@eslint/js": "^9.20.0",
+    "@next/eslint-plugin-next": "^15.1.7",
     "eslint-config-prettier": "^10.0.1",
-    "eslint-import-resolver-typescript": "^3.7.0",
+    "eslint-import-resolver-typescript": "^3.8.1",
     "eslint-plugin-import": "^2.31.0",
     "eslint-plugin-jsx-a11y": "^6.10.2",
-    "eslint-plugin-perfectionist": "^4.8.0",
+    "eslint-plugin-perfectionist": "^4.9.0",
     "eslint-plugin-playwright": "^2.2.0",
     "eslint-plugin-react": "^7.37.4",
     "eslint-plugin-react-hooks": "^5.1.0",
-    "eslint-plugin-react-refresh": "^0.4.18",
+    "eslint-plugin-react-refresh": "^0.4.19",
     "eslint-plugin-sonarjs": "^1.0.4",
-    "globals": "^15.14.0",
+    "globals": "^15.15.0",
     "is-ci": "^4.1.0",
-    "typescript-eslint": "^8.23.0"
+    "typescript-eslint": "^8.24.1"
   },
   "devDependencies": {
     "@boehringer-ingelheim/prettier-config": "2.0.0",
@@ -57,7 +58,7 @@
     "@semantic-release/git": "10.0.1",
     "dotenv-cli": "8.0.0",
     "husky": "9.1.7",
-    "prettier": "3.4.2",
-    "semantic-release": "24.2.1"
+    "prettier": "3.5.1",
+    "semantic-release": "24.2.3"
   }
 }