Merge pull request #101 from Boehringer-Ingelheim/feature/perfectionist-v5

feat(deps): update eslint-plugin-perfectionist to v5

Author: SimonGolms

configs/base.js

@@ -6,6 +6,7 @@ const { defineConfig } = require('eslint/config');
 const tseslint = require('typescript-eslint');
 
 const {
+  PERFECTIONIST_SETTINGS,
   SORT_CLASSES_GROUPS,
   SORT_IMPORTS_GROUPS,
   SORT_INTERSECTION_TYPES_GROUPS,
@@ -93,36 +94,31 @@ module.exports = defineConfig(
       'perfectionist/sort-classes': [
         'error',
         {
-          ...perfectionist.configs['recommended-natural'].rules['perfectionist/sort-classes'][1],
           groups: SORT_CLASSES_GROUPS,
         },
       ],
       'perfectionist/sort-imports': [
         'error',
         {
-          ...perfectionist.configs['recommended-natural'].rules['perfectionist/sort-imports'][1],
           groups: SORT_IMPORTS_GROUPS,
-          newlinesBetween: 'ignore',
+          newlinesBetween: 0, // No newlines are allowed between groups
         },
       ],
       'perfectionist/sort-intersection-types': [
         'error',
         {
-          ...perfectionist.configs['recommended-natural'].rules['perfectionist/sort-intersection-types'][1],
           groups: SORT_INTERSECTION_TYPES_GROUPS,
         },
       ],
       'perfectionist/sort-named-imports': [
         'error',
         {
-          ...perfectionist.configs['recommended-natural'].rules['perfectionist/sort-named-imports'][1],
           ignoreAlias: true,
         },
       ],
       'perfectionist/sort-objects': [
         'error',
         {
-          ...perfectionist.configs['recommended-natural'].rules['perfectionist/sort-objects'][1],
           partitionByComment: true,
         },
       ],
@@ -131,6 +127,9 @@ module.exports = defineConfig(
       'import/resolver': {
         typescript: true,
       },
+      perfectionist: {
+        ...PERFECTIONIST_SETTINGS,
+      },
     },
   },
   {

configs/react.js

@@ -4,8 +4,7 @@ const reactHooks = require('eslint-plugin-react-hooks');
 const reactRefresh = require('eslint-plugin-react-refresh');
 const { defineConfig } = require('eslint/config');
 const globals = require('globals');
-
-const { SORT_IMPORTS_GROUPS } = require('../lib/eslint-plugin-perfectionist.js');
+const { PERFECTIONIST_SETTINGS, SORT_IMPORTS_GROUPS } = require('../lib/eslint-plugin-perfectionist.js');
 const base = require('./base.js');
 
 module.exports = defineConfig(
@@ -60,30 +59,30 @@ module.exports = defineConfig(
       'perfectionist/sort-imports': [
         'error',
         {
-          customGroups: {
-            type: {
-              react: ['react'],
-            },
-            value: {
-              react: ['react'],
+          customGroups: [
+            {
+              elementNamePattern: ['^react$'],
+              groupName: 'react',
             },
-          },
+          ],
           groups: ['react', ...SORT_IMPORTS_GROUPS],
-          ignoreCase: true,
-          newlinesBetween: 'ignore',
-          type: 'natural',
+          newlinesBetween: 0, // No newlines are allowed between groups
         },
       ],
       'perfectionist/sort-jsx-props': [
         'error',
         {
-          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#L41-L46
-          },
+          customGroups: [
+            {
+              elementNamePattern: '^on.+',
+              groupName: 'callback',
+            },
+            {
+              elementNamePattern: ['children', 'dangerouslySetInnerHTML', 'key', 'ref'], // Reserved props from: https://github.com/jsx-eslint/eslint-plugin-react/blob/master/lib/rules/jsx-sort-props.js#L41-L46
+              groupName: 'reservedProps',
+            },
+          ],
           groups: ['reservedProps', 'unknown', 'callback'],
-          ignoreCase: true,
-          type: 'natural',
         },
       ],
 
@@ -100,6 +99,9 @@ module.exports = defineConfig(
       ],
     },
     settings: {
+      perfectionist: {
+        ...PERFECTIONIST_SETTINGS,
+      },
       react: {
         version: 'detect',
       },

lib/eslint-plugin-perfectionist.js

@@ -1,22 +1,33 @@
+/**
+ * Opinionated 'default' settings for eslint-plugin-perfectionist.
+ * @see https://perfectionist.dev/guide/getting-started#settings
+ */
+const PERFECTIONIST_SETTINGS = {
+  ignoreCase: true, // Ignore case when sorting
+  type: 'natural',
+};
+
 /**
  * While the sorting of imports is done by `eslint-plugin-perfectionist/sort-imports`,
  * the order and grouping of imports is still taken from the previous configuration of `eslint-plugin-import/order`,
  * as it feels more natural.
  * The following group names are available for configuration: https://eslint-plugin-perfectionist.azat.io/rules/sort-imports#groups
  */
 const SORT_IMPORTS_GROUPS = [
-  ['builtin', 'builtin-type'],
-  ['external', 'external-type'],
-  ['internal', 'internal-type'],
-  ['parent', 'parent-type', 'sibling', 'sibling-type', 'index', 'index-type'],
-  'style',
-  ['side-effect-style', 'side-effect'],
-  'object',
+  ['value-builtin', 'named-type-builtin'],
+  ['value-external', 'named-type-external'],
+  ['value-internal', 'named-type-internal'],
+  ['value-parent', 'named-type-parent'],
+  ['value-sibling', 'named-type-sibling'],
+  ['value-index', 'named-type-index'],
+  'value-style',
+  ['value-side-effect-style', 'value-side-effect'],
+  'value-ts-equals-import',
   'unknown',
 ];
 
 /**
- * This is the the groups configuration of all the recommended configs by eslint-plugin-perfectionist.
+ * This is the the default groups configuration of all the recommended configs by eslint-plugin-perfectionist.
  * This array can be used to reconfigure some options of the perfectionist/sort-classes rule without
  * overwriting the groups configuration of this rule.
  * This config can be found here:
@@ -25,19 +36,31 @@ const SORT_IMPORTS_GROUPS = [
  */
 const SORT_CLASSES_GROUPS = [
   'index-signature',
-  'static-property',
-  'private-property',
-  'property',
-  'constructor',
-  'static-method',
-  'private-method',
-  'method',
+  ['static-property', 'static-accessor-property'],
+  ['static-get-method', 'static-set-method'],
+  ['protected-static-property', 'protected-static-accessor-property'],
+  ['protected-static-get-method', 'protected-static-set-method'],
+  ['private-static-property', 'private-static-accessor-property'],
+  ['private-static-get-method', 'private-static-set-method'],
+  'static-block',
+  ['property', 'accessor-property'],
   ['get-method', 'set-method'],
+  ['protected-property', 'protected-accessor-property'],
+  ['protected-get-method', 'protected-set-method'],
+  ['private-property', 'private-accessor-property'],
+  ['private-get-method', 'private-set-method'],
+  'constructor',
+  ['static-method', 'static-function-property'],
+  ['protected-static-method', 'protected-static-function-property'],
+  ['private-static-method', 'private-static-function-property'],
+  ['method', 'function-property'],
+  ['protected-method', 'protected-function-property'],
+  ['private-method', 'private-function-property'],
   'unknown',
 ];
 
 /**
- * This array can be used to configure the perfectionist/sort-intersection-types rule.
+ * Customized configuration 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 = [
@@ -57,6 +80,7 @@ const SORT_INTERSECTION_TYPES_GROUPS = [
 ];
 
 module.exports = {
+  PERFECTIONIST_SETTINGS,
   SORT_CLASSES_GROUPS,
   SORT_IMPORTS_GROUPS,
   SORT_INTERSECTION_TYPES_GROUPS,