@boehringer-ingelheim/eslint-config 7.4.0 → 8.0.0-defineConfig.2

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 Boehringer Ingelheim
+Copyright (c) 2025 Boehringer Ingelheim
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -25,24 +25,22 @@ Create or update the `eslint.config.mjs` (`eslint.config.cjs` is also possible i
 
 ```js
 import boehringer from '@boehringer-ingelheim/eslint-config';
+import { defineConfig } from 'eslint/config';
 
-export default boehringer.config(
+export default defineConfig(
   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
+#### 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
 import boehringer from '@boehringer-ingelheim/eslint-config';
+import { defineConfig } from 'eslint/config';
 
-export default boehringer.config(
+export default defineConfig(
   boehringer.configs.strict, 
   {
     rules: {
@@ -60,8 +58,9 @@ It is recommended to use this function to ensure that your `.gitignore` file is
 
 ```js
 import boehringer from '@boehringer-ingelheim/eslint-config';
+import { defineConfig } from 'eslint/config';
 
-export default boehringer.config(
+export default defineConfig(
   boehringer.includeIgnoreFile(), // default value '.gitignore'
   boehringer.configs.strict,
 );
@@ -71,8 +70,9 @@ or in case you have a different paths to your `.gitignore` file(s):
 
 ```js
 import boehringer from '@boehringer-ingelheim/eslint-config';
+import { defineConfig } from 'eslint/config';
 
-export default boehringer.config(
+export default defineConfig(
   boehringer.includeIgnoreFile('./backend/.gitignore'),
   boehringer.includeIgnoreFile('./frontend/.gitignore'),
   boehringer.configs.strict,
@@ -95,8 +95,9 @@ Opinionated Options that differ from the standard/recommended ESLint configurati
 
 ```js
 import boehringer from '@boehringer-ingelheim/eslint-config';
+import { defineConfig } from 'eslint/config';
 
-export default boehringer.config(
+export default defineConfig(
   boehringer.configs.base
 )
 ```
@@ -117,8 +118,9 @@ This configuration also sets up the TypeScript parser [`@typescript-eslint/parse
 
 ```js
 import boehringer from '@boehringer-ingelheim/eslint-config';
+import { defineConfig } from 'eslint/config';
 
-export default boehringer.config(
+export default defineConfig(
   boehringer.configs.base,
   boehringer.configs.local
 );
@@ -130,8 +132,9 @@ This shared ESLint configuration configures or disables some rules for a better
 
 ```js
 import boehringer from '@boehringer-ingelheim/eslint-config';
+import { defineConfig } from 'eslint/config';
 
-export default boehringer.config(
+export default defineConfig(
   boehringer.configs.strict
 );
 ```
@@ -142,8 +145,9 @@ This shared ESLint configuration extends the [base configuration](#base) and add
 
 ```js
 import boehringer from '@boehringer-ingelheim/eslint-config';
+import { defineConfig } from 'eslint/config';
 
-export default boehringer.config(
+export default defineConfig(
   boehringer.configs.strict,
   boehringer.configs.react
 );
@@ -163,8 +167,9 @@ Additionally in restricts the usage of enums using [`no-restricted-syntax`](http
 
 ```js
 import boehringer from '@boehringer-ingelheim/eslint-config';
+import { defineConfig } from 'eslint/config';
 
-export default boehringer.config(
+export default defineConfig(
   boehringer.configs.strict,
   boehringer.configs.nextjs
 );
@@ -176,8 +181,9 @@ This shared ESLint configuration is specifically tailored for [Next.js](https://
 
 ```js
 import boehringer from '@boehringer-ingelheim/eslint-config';
+import { defineConfig } from 'eslint/config';
 
-export default boehringer.config(
+export default defineConfig(
   boehringer.configs.strict,
   boehringer.configs.playwright
 );
@@ -187,12 +193,13 @@ or for specific files only:
 
 ```js
 import boehringer from '@boehringer-ingelheim/eslint-config';
+import { defineConfig } from 'eslint/config';
 
-export default boehringer.config(
+export default defineConfig(
   boehringer.configs.strict,
   {
     files: ['src/**/*.test.{ts,tsx}'],
-    ...(await boehringer.configs.playwright)[0],
+    ...boehringer.configs.playwright[0],
   },
 );
 ```
@@ -207,8 +214,9 @@ This shared ESLint configuration is designed to enforce best practices and recom
 
 ```js
 import boehringer from '@boehringer-ingelheim/eslint-config';
+import { defineConfig } from 'eslint/config';
 
-export default boehringer.config(
+export default defineConfig(
   boehringer.configs.strict,
   // possibly other configs,
   boehringer.configs.experimentalNamingConvention
@@ -222,8 +230,9 @@ This shared ESLint configuration is designed to enforce some naming conventions.
 ```js
 import boehringer from '@boehringer-ingelheim/eslint-config';
 import prettier from 'eslint-plugin-prettier/recommended';
+import { defineConfig } from 'eslint/config';
 
-export default boehringer.config(
+export default defineConfig(
   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
@@ -272,8 +281,9 @@ You can use the new [`allowDefaultProject`](https://typescript-eslint.io/package
 
 ```js
 import boehringer from '@boehringer-ingelheim/eslint-config';
+import { defineConfig } from 'eslint/config';
 
-export default boehringer.config(
+export default defineConfig(
   // other configs,
   {
     languageOptions: {
@@ -347,7 +357,7 @@ Give a ⭐️ if this project helped you!
 
 ## License
 
-Copyright © 2023 [Boehringer Ingelheim](https://github.com/boehringer-ingelheim).  
+Copyright © 2025 [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

@@ -2,6 +2,7 @@ const eslint = require('@eslint/js');
 const importPlugin = require('eslint-plugin-import');
 const perfectionist = require('eslint-plugin-perfectionist');
 const sonarjs = require('eslint-plugin-sonarjs');
+const { defineConfig } = require('eslint/config');
 const tseslint = require('typescript-eslint');
 
 const {
@@ -10,7 +11,7 @@ const {
   SORT_INTERSECTION_TYPES_GROUPS,
 } = require('../lib/eslint-plugin-perfectionist.js');
 
-module.exports = tseslint.config(
+module.exports = defineConfig(
   eslint.configs.recommended,
   tseslint.configs.recommendedTypeChecked,
   tseslint.configs.stylisticTypeChecked,

package/configs/experimental-naming-convention.js

@@ -1,6 +1,6 @@
-const tseslint = require('typescript-eslint');
+const { defineConfig } = require('eslint/config');
 
-module.exports = tseslint.config({
+module.exports = defineConfig({
   rules: {
     '@typescript-eslint/naming-convention': [
       'error',

package/configs/local.js

@@ -1,7 +1,7 @@
+const { defineConfig } = require('eslint/config');
 const isCI = require('is-ci');
-const tseslint = require('typescript-eslint');
 
-module.exports = tseslint.config(
+module.exports = defineConfig(
   isCI
     ? {}
     : {

package/configs/nextjs.js

@@ -1,9 +1,9 @@
 const nextPlugin = require('@next/eslint-plugin-next');
-const tseslint = require('typescript-eslint');
+const { defineConfig } = require('eslint/config');
 
 const react = require('./react.js');
 
-module.exports = tseslint.config(
+module.exports = defineConfig(
   ...react,
   {
     plugins: {

package/configs/playwright.js

@@ -1,7 +1,7 @@
 const playwright = require('eslint-plugin-playwright');
-const tseslint = require('typescript-eslint');
+const { defineConfig } = require('eslint/config');
 
-module.exports = tseslint.config({
+module.exports = defineConfig({
   ...playwright.configs['flat/recommended'],
   rules: {
     /**

package/configs/prettier-disable.js

@@ -1,7 +1,7 @@
 const prettier = require('eslint-config-prettier');
-const tseslint = require('typescript-eslint');
+const { defineConfig } = require('eslint/config');
 
-module.exports = tseslint.config({
+module.exports = defineConfig({
   ...prettier,
   rules: {
     ...prettier.rules,

package/configs/react.js

@@ -2,13 +2,13 @@ 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 { defineConfig } = require('eslint/config');
 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(
+module.exports = defineConfig(
   ...base,
   jsxA11y.flatConfigs.recommended,
   react.configs.flat.recommended,

package/configs/strict.js

@@ -1,8 +1,9 @@
+const { defineConfig } = require('eslint/config');
 const tseslint = require('typescript-eslint');
 
 const base = require('./base.js');
 
-module.exports = tseslint.config(...base, tseslint.configs.strictTypeChecked, {
+module.exports = defineConfig(...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',

package/index.d.ts

@@ -1,5 +1,4 @@
-import { FlatConfig } from '@eslint/compat';
-import { Config } from 'typescript-eslint';
+import type { Linter } from 'eslint';
 
 type Configs =
   | 'base'
@@ -11,18 +10,15 @@ type Configs =
   | 'react'
   | 'strict';
 
-declare module './index' {
-  const config: typeof import('typescript-eslint').config;
-  const configs: Record<Configs, Config>;
+declare module './index.js' {
+  export const configs: Record<Configs, Linter.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.
+   * @returns {Linter.Config} The result of including the ignore file at the resolved absolute path.
    */
-  const includeIgnoreFile: (ignoreFilePath = '.gitignore') => FlatConfig;
-
-  export { config, configs, includeIgnoreFile };
+  export const includeIgnoreFile: (ignoreFilePath?: string) => Linter.Config;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@boehringer-ingelheim/eslint-config",
-  "version": "7.4.0",
+  "version": "8.0.0-defineConfig.2",
   "description": "Shared eslint configuration used at Boehringer Ingelheim for code styling",
   "keywords": [
     "boehringer",
@@ -29,25 +29,25 @@
     "lint": "eslint ."
   },
   "peerDependencies": {
-    "eslint": ">= 8"
+    "eslint": ">= 9.34.0"
   },
   "dependencies": {
-    "@eslint/compat": "^1.3.1",
-    "@eslint/js": "^9.20.0",
-    "@next/eslint-plugin-next": "^15.4.3",
+    "@eslint/compat": "^1.3.2",
+    "@eslint/js": "^9.34.0",
+    "@next/eslint-plugin-next": "^15.5.2",
     "eslint-config-prettier": "^10.1.8",
     "eslint-import-resolver-typescript": "^4.4.4",
     "eslint-plugin-import": "^2.32.0",
     "eslint-plugin-jsx-a11y": "^6.10.2",
     "eslint-plugin-perfectionist": "^4.15.0",
-    "eslint-plugin-playwright": "^2.2.0",
+    "eslint-plugin-playwright": "^2.2.2",
     "eslint-plugin-react": "^7.37.5",
     "eslint-plugin-react-hooks": "^5.2.0",
     "eslint-plugin-react-refresh": "^0.4.20",
     "eslint-plugin-sonarjs": "^1.0.4",
     "globals": "^16.3.0",
     "is-ci": "^4.1.0",
-    "typescript-eslint": "^8.38.0"
+    "typescript-eslint": "^8.42.0"
   },
   "devDependencies": {
     "@boehringer-ingelheim/prettier-config": "2.0.0",
@@ -56,7 +56,7 @@
     "@commitlint/types": "19.8.1",
     "@semantic-release/changelog": "6.0.3",
     "@semantic-release/git": "10.0.1",
-    "dotenv-cli": "9.0.0",
+    "dotenv-cli": "10.0.0",
     "husky": "9.1.7",
     "prettier": "3.6.2",
     "semantic-release": "24.2.7"