@boehringer-ingelheim/eslint-config 2.0.0 → 3.1.0-next.1

package/README.md

@@ -71,7 +71,7 @@ The following plugins are used in this configuration:
 - [`eslint-plugin-import`](https://github.com/import-js/eslint-plugin-import)
 - [`eslint-plugin-sonarjs`](https://github.com/SonarSource/eslint-plugin-sonarjs)
 
-Additionally, the [`eslint-plugin-sort-keys-plus`](https://github.com/forivall/eslint-plugin-sort-keys-plus) is used to automatically fix sorting issues.
+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/architecture/parser) and [`eslint-import-resolver-typescript`](https://github.com/import-js/eslint-import-resolver-typescript). The TypeScript project file `./tsconfig.json` is set as default value for the project option in the parser configuration. If this is not the case, this must be changed accordingly:
 

package/base/index.js

@@ -1,3 +1,5 @@
+const { SORT_IMPORTS_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.
@@ -15,6 +17,7 @@ module.exports = {
     "plugin:@typescript-eslint/stylistic-type-checked",
     "plugin:import/recommended",
     "plugin:import/typescript",
+    "plugin:perfectionist/recommended-natural",
     "plugin:sonarjs/recommended",
   ],
   overrides: [
@@ -34,9 +37,10 @@ module.exports = {
     // find the tsconfig.json nearest each source file
     project: true,
   },
-  plugins: ["@typescript-eslint", "sonarjs", "sort-keys-plus"],
+  plugins: ["@typescript-eslint", "sonarjs"],
   rules: {
     // @typescript-eslint: https://github.com/typescript-eslint/typescript-eslint/tree/main/packages/eslint-plugin/docs/rules
+    "@typescript-eslint/adjacent-overload-signatures": "off", // disabled due to conflict with eslint-plugin-perfectionist
     "@typescript-eslint/no-floating-promises": ["error", { ignoreVoid: true }],
     "@typescript-eslint/no-misused-promises": [
       "error",
@@ -52,7 +56,7 @@ module.exports = {
         varsIgnorePattern: "^_",
       },
     ],
-    "@typescript-eslint/sort-type-constituents": "error",
+    "@typescript-eslint/sort-type-constituents": "off", // disabled due to conflict with eslint-plugin-perfectionist
 
     // eslint: https://github.com/eslint/eslint/tree/main/lib/rules
     "arrow-body-style": ["error", "as-needed"],
@@ -75,6 +79,8 @@ module.exports = {
     "prefer-const": "error",
     "prefer-rest-params": "error",
     "prefer-template": "error",
+    "sort-imports": "off", // disabled due to conflict with eslint-plugin-perfectionist
+    "sort-keys": "off", // disabled due to conflict with eslint-plugin-perfectionist
 
     // eslint-plugin-import: https://github.com/import-js/eslint-plugin-import/tree/main/docs/rules
     "import/no-cycle": "error",
@@ -86,30 +92,34 @@ module.exports = {
         unusedExports: true,
       },
     ],
-    "import/order": [
-      "error",
-      {
-        alphabetize: {
-          caseInsensitive: true,
-          order: "asc",
-          orderImportKind: "asc",
-        },
-      },
-    ],
+    "import/order": "off", // disabled due to conflict with eslint-plugin-perfectionist
     "import/prefer-default-export": "off",
 
-    /**
-     * Required to fix sort-keys automatically, since this is not done by default.
-     * See: https://github.com/forivall/eslint-plugin-sort-keys-plus
-     */
-    "sort-keys-plus/sort-keys": [
+    // 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", { "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-imports": [
       "error",
-      "asc",
       {
-        caseSensitive: false,
-        natural: true,
+        groups: SORT_IMPORTS_GROUPS,
+        "ignore-case": true,
+        "newlines-between": "ignore",
+        type: "natural",
       },
     ],
+    "perfectionist/sort-interfaces": ["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-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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@boehringer-ingelheim/eslint-config",
-  "version": "2.0.0",
+  "version": "3.1.0-next.1",
   "description": "Shared eslint configuration used at Boehringer Ingelheim for code styling",
   "keywords": [
     "boehringer",
@@ -30,16 +30,16 @@
   },
   "dependencies": {
     "@rushstack/eslint-patch": "^1.3.3",
-    "@typescript-eslint/eslint-plugin": "^6.3.0",
-    "@typescript-eslint/parser": "^6.3.0",
+    "@typescript-eslint/eslint-plugin": "^6.7.0",
+    "@typescript-eslint/parser": "^6.7.0",
     "eslint-import-resolver-typescript": "^3.6.0",
-    "eslint-plugin-import": "^2.28.0",
+    "eslint-plugin-import": "^2.28.1",
     "eslint-plugin-jsx-a11y": "^6.7.1",
-    "eslint-plugin-playwright": "^0.15.3",
-    "eslint-plugin-react": "^7.33.1",
+    "eslint-plugin-perfectionist": "^2.1.0",
+    "eslint-plugin-playwright": "^0.16.0",
+    "eslint-plugin-react": "^7.33.2",
     "eslint-plugin-react-hooks": "^4.6.0",
-    "eslint-plugin-sonarjs": "^0.20.0",
-    "eslint-plugin-sort-keys-plus": "^1.3.1",
+    "eslint-plugin-sonarjs": "^0.21.0",
     "eslint-plugin-typescript-enum": "^2.1.0"
   },
   "devDependencies": {
@@ -49,9 +49,9 @@
     "@commitlint/types": "17.4.4",
     "@semantic-release/changelog": "6.0.3",
     "@semantic-release/git": "10.0.1",
-    "dotenv-cli": "7.2.1",
+    "dotenv-cli": "7.3.0",
     "husky": "8.0.3",
-    "prettier": "3.0.1",
-    "semantic-release": "21.0.7"
+    "prettier": "3.0.3",
+    "semantic-release": "21.1.1"
   }
 }

package/react/index.js

@@ -1,3 +1,5 @@
+const { SORT_IMPORTS_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.
@@ -43,44 +45,45 @@ module.exports = {
     ],
     "@typescript-eslint/consistent-type-definitions": ["error", "type"],
 
-    // eslint-plugin-import: https://github.com/import-js/eslint-plugin-import/tree/main/docs/rules
-    "import/order": [
+    // eslint-plugin-react: https://github.com/jsx-eslint/eslint-plugin-react/tree/master/lib/rules
+    "react/jsx-pascal-case": "error",
+    "react/jsx-sort-props": "off", // disabled due to conflict with eslint-plugin-perfectionist
+    "react/sort-default-props": "error",
+
+    // eslint-plugin-react-hooks: https://github.com/facebook/react/blob/main/packages/eslint-plugin-react-hooks/README.md
+    "react-hooks/exhaustive-deps": "error",
+    "react-hooks/rules-of-hooks": "error",
+
+    // eslint-plugin-perfectionist: https://github.com/azat-io/eslint-plugin-perfectionist
+    "perfectionist/sort-imports": [
       "error",
       {
-        alphabetize: {
-          caseInsensitive: true,
-          order: "asc",
-          orderImportKind: "asc",
-        },
-        pathGroups: [
-          {
-            group: "external",
-            pattern: "react",
-            position: "before",
+        "custom-groups": {
+          type: {
+            react: ["react"],
+          },
+          value: {
+            react: ["react"],
           },
-        ],
-        pathGroupsExcludedImportTypes: ["react"],
+        },
+        groups: ["react", ...SORT_IMPORTS_GROUPS],
+        "ignore-case": true,
+        "newlines-between": "ignore",
+        type: "natural",
       },
     ],
-
-    // eslint-plugin-react: https://github.com/jsx-eslint/eslint-plugin-react/tree/master/lib/rules
-    "react/jsx-pascal-case": "error",
-    "react/jsx-sort-props": [
+    "perfectionist/sort-jsx-props": [
       "error",
       {
-        callbacksLast: true,
-        ignoreCase: true,
-        noSortAlphabetically: false,
-        reservedFirst: true,
-        shorthandFirst: false,
-        shorthandLast: false,
+        "custom-groups": {
+          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,
+        type: "natural",
       },
     ],
-    "react/sort-default-props": "error",
-
-    // eslint-plugin-react-hooks: https://github.com/facebook/react/blob/main/packages/eslint-plugin-react-hooks/README.md
-    "react-hooks/exhaustive-deps": "error",
-    "react-hooks/rules-of-hooks": "error",
   },
   settings: {
     react: {