@boehringer-ingelheim/eslint-config 5.1.0-next.1 → 6.0.0-flat-config.1

package/README.md

@@ -135,6 +135,26 @@ 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.
 
+### `@boehringer-ingelheim/eslint-config/prettier-disable`
+
+```js
+module.exports = {
+  extends: [
+    '@boehringer-ingelheim/eslint-config/base/strict',
+    // Following needs eslint-plugin-prettier to be installed as described by https://github.com/prettier/eslint-plugin-prettier
+    // Should be second to last
+    'plugin:prettier/recommended',
+    // Should be last
+    '@boehringer-ingelheim/eslint-config/prettier-disable'
+  ],
+};
+```
+
+This shared ESLint configuration is wrapper around [`eslint-config-disable`](https://github.com/prettier/eslint-config-prettier), which is used to turn off all rules that are unnecessary or might conflict with Prettier. This wrapper reenables a few rules that can be used with our shared configurations as we are using specific options of those rules which are compatible with Prettier (see [Special Rules](https://github.com/prettier/eslint-config-prettier#special-rules)). Following rules are reenabled:
+
+- [`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.
+
 ## Local Development
 
 ### Install Dependencies

package/base/index.js

@@ -1,10 +1,15 @@
-const { SORT_CLASSES_GROUPS, SORT_IMPORTS_GROUPS } = require('../lib/eslint-plugin-perfectionist');
+const {
+  SORT_CLASSES_GROUPS,
+  SORT_IMPORTS_GROUPS,
+  SORT_INTERSECTION_TYPES_GROUPS,
+} = require('../lib/eslint-plugin-perfectionist');
 
 /**
  * Workaround to allow ESLint to resolve plugins that were installed
  * by an external config, see https://github.com/eslint/eslint/issues/3458.
  */
 require('@rushstack/eslint-patch/modern-module-resolution');
+const eslintPluginPerfectionist = require('eslint-plugin-perfectionist');
 
 /** @type {import('eslint').ESLint.ConfigData & { parserOptions: import('eslint').ESLint.ConfigData['parserOptions'] & import('@typescript-eslint/parser').ParserOptions } }  */
 module.exports = {
@@ -17,7 +22,7 @@ module.exports = {
     'plugin:@typescript-eslint/stylistic-type-checked',
     'plugin:import/recommended',
     'plugin:import/typescript',
-    'plugin:perfectionist/recommended-natural',
+    'plugin:perfectionist/recommended-natural-legacy',
     'plugin:sonarjs/recommended-legacy',
   ],
   overrides: [
@@ -61,11 +66,11 @@ module.exports = {
     '@typescript-eslint/sort-type-constituents': 'off', // disabled due to conflict with eslint-plugin-perfectionist
 
     // eslint: https://github.com/eslint/eslint/tree/main/lib/rules
+    '@typescript-eslint/dot-notation': ['error', { allowPattern: '^[a-z]+(_[a-z]+)+$' }],
     'arrow-body-style': ['error', 'as-needed'],
     camelcase: 'warn',
     curly: 'error',
     'default-case': 'error',
-    'dot-notation': ['error', { allowPattern: '^[a-z]+(_[a-z]+)+$' }],
     eqeqeq: 'error',
     'logical-assignment-operators': ['error', 'never'],
     'no-console': ['warn', { allow: ['warn', 'error'] }],
@@ -104,31 +109,44 @@ module.exports = {
     'import/no-named-as-default-member': 'off',
 
     // eslint-plugin-perfectionist: https://github.com/azat-io/eslint-plugin-perfectionist
-    'perfectionist/sort-array-includes': ['error', { 'ignore-case': true, type: 'natural' }],
-    'perfectionist/sort-astro-attributes': ['error', { 'ignore-case': true, type: 'natural' }],
-    'perfectionist/sort-classes': ['error', { groups: SORT_CLASSES_GROUPS, 'ignore-case': true, type: 'natural' }],
-    'perfectionist/sort-enums': ['error', { 'ignore-case': true, type: 'natural' }],
-    'perfectionist/sort-exports': ['error', { 'ignore-case': true, type: 'natural' }],
+    'perfectionist/sort-classes': [
+      'error',
+      {
+        ...eslintPluginPerfectionist.configs['recommended-natural-legacy'].rules['perfectionist/sort-classes'][1],
+        groups: SORT_CLASSES_GROUPS,
+      },
+    ],
     'perfectionist/sort-imports': [
       'error',
       {
+        ...eslintPluginPerfectionist.configs['recommended-natural-legacy'].rules['perfectionist/sort-imports'][1],
         groups: SORT_IMPORTS_GROUPS,
-        'ignore-case': true,
-        'newlines-between': 'ignore',
-        type: 'natural',
+        newlinesBetween: 'ignore',
+      },
+    ],
+    'perfectionist/sort-intersection-types': [
+      'error',
+      {
+        ...eslintPluginPerfectionist.configs['recommended-natural-legacy'].rules[
+          'perfectionist/sort-intersection-types'
+        ][1],
+        groups: SORT_INTERSECTION_TYPES_GROUPS,
+      },
+    ],
+    'perfectionist/sort-named-imports': [
+      'error',
+      {
+        ...eslintPluginPerfectionist.configs['recommended-natural-legacy'].rules['perfectionist/sort-named-imports'][1],
+        ignoreAlias: true,
+      },
+    ],
+    'perfectionist/sort-objects': [
+      'error',
+      {
+        ...eslintPluginPerfectionist.configs['recommended-natural-legacy'].rules['perfectionist/sort-objects'][1],
+        partitionByComment: true,
       },
     ],
-    'perfectionist/sort-interfaces': ['error', { 'ignore-case': true, type: 'natural' }],
-    'perfectionist/sort-intersection-types': ['error', { 'ignore-case': true, type: 'natural' }],
-    'perfectionist/sort-jsx-props': ['error', { 'ignore-case': true, type: 'natural' }],
-    'perfectionist/sort-maps': ['error', { 'ignore-case': true, type: 'natural' }],
-    'perfectionist/sort-named-exports': ['error', { 'ignore-case': true, type: 'natural' }],
-    'perfectionist/sort-named-imports': ['error', { 'ignore-alias': true, 'ignore-case': true, type: 'natural' }],
-    'perfectionist/sort-object-types': ['error', { 'ignore-case': true, type: 'natural' }],
-    'perfectionist/sort-objects': ['error', { 'ignore-case': true, 'partition-by-comment': true, type: 'natural' }],
-    'perfectionist/sort-svelte-attributes': ['error', { 'ignore-case': true, type: 'natural' }],
-    'perfectionist/sort-union-types': ['error', { 'ignore-case': true, type: 'natural' }],
-    'perfectionist/sort-vue-attributes': ['error', { 'ignore-case': true, type: 'natural' }],
   },
   settings: {
     'import/resolver': {

package/lib/eslint-plugin-perfectionist.js

@@ -9,7 +9,8 @@ const SORT_IMPORTS_GROUPS = [
   ['external', 'external-type'],
   ['internal', 'internal-type'],
   ['parent', 'parent-type', 'sibling', 'sibling-type', 'index', 'index-type'],
-  ['style', 'side-effect'],
+  'style',
+  ['side-effect-style', 'side-effect'],
   'object',
   'unknown',
 ];
@@ -35,7 +36,28 @@ const SORT_CLASSES_GROUPS = [
   'unknown',
 ];
 
+/**
+ * This array can be used to configure the perfectionist/sort-intersection-types rule.
+ * The following group names are available for configuration: https://perfectionist.dev/rules/sort-intersection-types#groups
+ */
+const SORT_INTERSECTION_TYPES_GROUPS = [
+  'conditional',
+  'function',
+  'import',
+  'intersection',
+  'union',
+  'named',
+  'keyword',
+  'literal',
+  'operator',
+  'tuple',
+  'object',
+  'nullish',
+  'unknown',
+];
+
 module.exports = {
   SORT_CLASSES_GROUPS,
   SORT_IMPORTS_GROUPS,
+  SORT_INTERSECTION_TYPES_GROUPS,
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@boehringer-ingelheim/eslint-config",
-  "version": "5.1.0-next.1",
+  "version": "6.0.0-flat-config.1",
   "description": "Shared eslint configuration used at Boehringer Ingelheim for code styling",
   "keywords": [
     "boehringer",
@@ -27,34 +27,35 @@
     "repair": "npx --no rimraf .git/hooks node_modules package-lock.json && npm install"
   },
   "peerDependencies": {
-    "eslint": "^8.56.0"
+    "eslint": "^8.57.1"
   },
   "dependencies": {
-    "@rushstack/eslint-patch": "^1.10.3",
-    "@typescript-eslint/eslint-plugin": "^7.17.0",
-    "@typescript-eslint/parser": "^7.17.0",
-    "eslint-import-resolver-typescript": "^3.6.1",
-    "eslint-plugin-import": "^2.29.1",
-    "eslint-plugin-jsx-a11y": "^6.9.0",
-    "eslint-plugin-perfectionist": "^2.11.0",
-    "eslint-plugin-playwright": "^1.6.2",
-    "eslint-plugin-react": "^7.35.0",
-    "eslint-plugin-react-hooks": "^4.6.2",
-    "eslint-plugin-react-refresh": "^0.4.9",
-    "eslint-plugin-sonarjs": "^1.0.4",
+    "@rushstack/eslint-patch": "^1.10.4",
+    "@typescript-eslint/eslint-plugin": "^8.18.0",
+    "@typescript-eslint/parser": "^8.18.0",
+    "eslint-config-prettier": "^9.1.0",
+    "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-playwright": "^2.1.0",
+    "eslint-plugin-react": "^7.37.2",
+    "eslint-plugin-react-hooks": "^5.1.0",
+    "eslint-plugin-react-refresh": "^0.4.16",
+    "eslint-plugin-sonarjs": "^3.0.1",
     "eslint-plugin-typescript-enum": "^2.1.0",
-    "is-ci": "^3.0.1"
+    "is-ci": "^4.1.0"
   },
   "devDependencies": {
     "@boehringer-ingelheim/prettier-config": "2.0.0",
-    "@commitlint/cli": "19.3.0",
-    "@commitlint/config-conventional": "19.2.2",
-    "@commitlint/types": "19.0.3",
+    "@commitlint/cli": "19.6.0",
+    "@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.2",
-    "husky": "9.1.1",
-    "prettier": "3.3.3",
-    "semantic-release": "24.0.0"
+    "dotenv-cli": "7.4.4",
+    "husky": "9.1.7",
+    "prettier": "3.4.2",
+    "semantic-release": "24.2.0"
   }
 }

package/react/index.js

@@ -28,7 +28,7 @@ module.exports = {
   plugins: ['jsx-a11y', 'react', 'react-hooks', 'react-refresh', 'typescript-enum'],
   rules: {
     // @typescript-eslint: https://github.com/typescript-eslint/typescript-eslint/tree/main/packages/eslint-plugin/docs/rules
-    '@typescript-eslint/ban-types': [
+    '@typescript-eslint/no-restricted-types': [
       'error',
       {
         types: {
@@ -58,7 +58,7 @@ module.exports = {
     'perfectionist/sort-imports': [
       'error',
       {
-        'custom-groups': {
+        customGroups: {
           type: {
             react: ['react'],
           },
@@ -67,20 +67,20 @@ module.exports = {
           },
         },
         groups: ['react', ...SORT_IMPORTS_GROUPS],
-        'ignore-case': true,
-        'newlines-between': 'ignore',
+        ignoreCase: true,
+        newlinesBetween: 'ignore',
         type: 'natural',
       },
     ],
     'perfectionist/sort-jsx-props': [
       'error',
       {
-        'custom-groups': {
+        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
         },
         groups: ['reservedProps', 'unknown', 'callback'],
-        'ignore-case': true,
+        ignoreCase: true,
         type: 'natural',
       },
     ],