eslint-plugin-perfectionist 4.12.2 → 4.13.0

package/dist/package.json.js

@@ -1,6 +1,6 @@
 'use strict'
 Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' })
 const name = 'eslint-plugin-perfectionist'
-const version = '4.12.2'
+const version = '4.13.0'
 exports.name = name
 exports.version = version

package/dist/rules/sort-decorators.js

@@ -1,7 +1,7 @@
 'use strict'
 const commonJsonSchemas = require('../utils/common-json-schemas.js')
+const validateGeneratedGroupsConfiguration = require('../utils/validate-generated-groups-configuration.js')
 const validateCustomSortConfiguration = require('../utils/validate-custom-sort-configuration.js')
-const validateGroupsConfiguration = require('../utils/validate-groups-configuration.js')
 const getEslintDisabledLines = require('../utils/get-eslint-disabled-lines.js')
 const isNodeEslintDisabled = require('../utils/is-node-eslint-disabled.js')
 const reportErrors = require('../utils/report-errors.js')
@@ -42,9 +42,9 @@ const sortDecorators = createEslintRule.createEslintRule({
       defaultOptions,
     )
     validateCustomSortConfiguration.validateCustomSortConfiguration(options)
-    validateGroupsConfiguration.validateGroupsConfiguration({
-      allowedCustomGroups: Object.keys(options.customGroups),
-      allowedPredefinedGroups: ['unknown'],
+    validateGeneratedGroupsConfiguration.validateGeneratedGroupsConfiguration({
+      selectors: [],
+      modifiers: [],
       options,
     })
     return {
@@ -129,7 +129,7 @@ const sortDecorators = createEslintRule.createEslintRule({
             type: 'boolean',
           },
           partitionByComment: commonJsonSchemas.partitionByCommentJsonSchema,
-          customGroups: commonJsonSchemas.customGroupsJsonSchema,
+          customGroups: commonJsonSchemas.deprecatedCustomGroupsJsonSchema,
           groups: commonJsonSchemas.groupsJsonSchema,
         },
         additionalProperties: false,

package/dist/rules/sort-enums.js

@@ -221,19 +221,19 @@ const sortEnums = createEslintRule.createEslintRule({
       {
         properties: {
           ...commonJsonSchemas.commonJsonSchemas,
-          forceNumericSort: {
-            description:
-              'Will always sort numeric enums by their value regardless of the sort type specified.',
-            type: 'boolean',
-          },
           customGroups: {
             oneOf: [
-              commonJsonSchemas.customGroupsJsonSchema,
+              commonJsonSchemas.deprecatedCustomGroupsJsonSchema,
               commonJsonSchemas.buildCustomGroupsArrayJsonSchema({
                 singleCustomGroupJsonSchema: types.singleCustomGroupJsonSchema,
               }),
             ],
           },
+          forceNumericSort: {
+            description:
+              'Will always sort numeric enums by their value regardless of the sort type specified.',
+            type: 'boolean',
+          },
           sortByValue: {
             description: 'Compare enum values instead of names.',
             type: 'boolean',

package/dist/rules/sort-heritage-clauses.js

@@ -1,7 +1,7 @@
 'use strict'
 const commonJsonSchemas = require('../utils/common-json-schemas.js')
+const validateGeneratedGroupsConfiguration = require('../utils/validate-generated-groups-configuration.js')
 const validateCustomSortConfiguration = require('../utils/validate-custom-sort-configuration.js')
-const validateGroupsConfiguration = require('../utils/validate-groups-configuration.js')
 const getEslintDisabledLines = require('../utils/get-eslint-disabled-lines.js')
 const isNodeEslintDisabled = require('../utils/is-node-eslint-disabled.js')
 const reportErrors = require('../utils/report-errors.js')
@@ -30,7 +30,7 @@ const sortHeritageClauses = createEslintRule.createEslintRule({
       {
         properties: {
           ...commonJsonSchemas.commonJsonSchemas,
-          customGroups: commonJsonSchemas.customGroupsJsonSchema,
+          customGroups: commonJsonSchemas.deprecatedCustomGroupsJsonSchema,
           groups: commonJsonSchemas.groupsJsonSchema,
         },
         additionalProperties: false,
@@ -57,9 +57,9 @@ const sortHeritageClauses = createEslintRule.createEslintRule({
       defaultOptions,
     )
     validateCustomSortConfiguration.validateCustomSortConfiguration(options)
-    validateGroupsConfiguration.validateGroupsConfiguration({
-      allowedCustomGroups: Object.keys(options.customGroups),
-      allowedPredefinedGroups: ['unknown'],
+    validateGeneratedGroupsConfiguration.validateGeneratedGroupsConfiguration({
+      selectors: [],
+      modifiers: [],
       options,
     })
     return {

package/dist/rules/sort-imports.js

@@ -7,7 +7,6 @@ const validateSideEffectsConfiguration = require('./sort-imports/validate-side-e
 const validateCustomSortConfiguration = require('../utils/validate-custom-sort-configuration.js')
 const getCustomGroupsCompareOptions = require('../utils/get-custom-groups-compare-options.js')
 const readClosestTsConfigByPath = require('./sort-imports/read-closest-ts-config-by-path.js')
-const validateGroupsConfiguration = require('../utils/validate-groups-configuration.js')
 const getOptionsWithCleanGroups = require('../utils/get-options-with-clean-groups.js')
 const computeCommonSelectors = require('./sort-imports/compute-common-selectors.js')
 const isSideEffectOnlyGroup = require('./sort-imports/is-side-effect-only-group.js')
@@ -43,8 +42,8 @@ const sortImports = createEslintRule.createEslintRule({
     let userOptions = context.options.at(0)
     let options = getOptionsWithCleanGroups.getOptionsWithCleanGroups(
       complete.complete(userOptions, settings, {
+        internalPattern: ['^~/.+', '^@/.+'],
         fallbackSort: { type: 'unsorted' },
-        internalPattern: ['^~/.+'],
         partitionByComment: false,
         partitionByNewLine: false,
         newlinesBetween: 'always',
@@ -60,36 +59,19 @@ const sortImports = createEslintRule.createEslintRule({
         order: 'asc',
       }),
     )
-    if (Array.isArray(options.customGroups)) {
-      validateGeneratedGroupsConfiguration.validateGeneratedGroupsConfiguration(
-        {
-          options: {
-            ...options,
-            customGroups: options.customGroups,
-          },
-          selectors: [...types.allSelectors, ...types.allDeprecatedSelectors],
-          modifiers: types.allModifiers,
-        },
-      )
-    } else {
-      let generatedGroups = generatePredefinedGroups.generatePredefinedGroups({
-        cache: cachedGroupsByModifiersAndSelectors,
-        selectors: types.allSelectors,
-        modifiers: types.allModifiers,
-      })
-      validateGroupsConfiguration.validateGroupsConfiguration({
-        allowedCustomGroups: [
-          ...Object.keys(options.customGroups.type ?? {}),
-          ...Object.keys(options.customGroups.value ?? {}),
-        ],
-        allowedPredefinedGroups: [
-          ...generatedGroups,
-          ...types.allDeprecatedSelectors,
-          'unknown',
-        ],
-        options,
-      })
-    }
+    validateGeneratedGroupsConfiguration.validateGeneratedGroupsConfiguration({
+      options: {
+        ...options,
+        customGroups: Array.isArray(options.customGroups)
+          ? options.customGroups
+          : {
+              ...options.customGroups.type,
+              ...options.customGroups.value,
+            },
+      },
+      selectors: [...types.allSelectors, ...types.allDeprecatedSelectors],
+      modifiers: types.allModifiers,
+    })
     validateCustomSortConfiguration.validateCustomSortConfiguration(options)
     validateNewlinesAndPartitionConfiguration.validateNewlinesAndPartitionConfiguration(
       options,
@@ -367,12 +349,12 @@ const sortImports = createEslintRule.createEslintRule({
               {
                 properties: {
                   value: {
+                    ...commonJsonSchemas.deprecatedCustomGroupsJsonSchema,
                     description: 'Specifies custom groups for value imports.',
-                    type: 'object',
                   },
                   type: {
+                    ...commonJsonSchemas.deprecatedCustomGroupsJsonSchema,
                     description: 'Specifies custom groups for type imports.',
-                    type: 'object',
                   },
                 },
                 description: 'Specifies custom groups.',
@@ -410,41 +392,9 @@ const sortImports = createEslintRule.createEslintRule({
           internalPattern: commonJsonSchemas.regexJsonSchema,
           groups: commonJsonSchemas.groupsJsonSchema,
         },
-        allOf: [
-          {
-            $ref: '#/definitions/max-line-length-requires-line-length-type',
-          },
-        ],
-        dependencies: {
-          maxLineLength: ['type'],
-        },
         additionalProperties: false,
         type: 'object',
       },
-      definitions: {
-        'max-line-length-requires-line-length-type': {
-          anyOf: [
-            {
-              not: {
-                required: ['maxLineLength'],
-                type: 'object',
-              },
-              type: 'object',
-            },
-            {
-              $ref: '#/definitions/is-line-length',
-            },
-          ],
-        },
-        'is-line-length': {
-          properties: {
-            type: { enum: ['line-length'], type: 'string' },
-          },
-          required: ['type'],
-          type: 'object',
-        },
-      },
-      id: 'sort-imports',
       uniqueItems: true,
       type: 'array',
     },
@@ -466,7 +416,7 @@ const sortImports = createEslintRule.createEslintRule({
   defaultOptions: [
     {
       customGroups: { value: {}, type: {} },
-      internalPattern: ['^~/.+'],
+      internalPattern: ['^~/.+', '^@/.+'],
       partitionByComment: false,
       partitionByNewLine: false,
       specialCharacters: 'keep',

package/dist/rules/sort-intersection-types.js

@@ -11,6 +11,7 @@ let defaultOptions = {
   type: 'alphabetical',
   ignoreCase: true,
   locales: 'en-US',
+  customGroups: [],
   alphabet: '',
   order: 'asc',
   groups: [],
@@ -28,7 +29,7 @@ const sortIntersectionTypes = createEslintRule.createEslintRule({
       description: 'Enforce sorted intersection types.',
       recommended: true,
     },
-    schema: [sortUnionTypes.jsonSchema],
+    schema: sortUnionTypes.jsonSchema,
     type: 'suggestion',
     fixable: 'code',
   },

package/dist/rules/sort-jsx-props.js

@@ -205,7 +205,7 @@ const sortJsxProps = createEslintRule.createEslintRule({
           ...commonJsonSchemas.commonJsonSchemas,
           customGroups: {
             oneOf: [
-              commonJsonSchemas.customGroupsJsonSchema,
+              commonJsonSchemas.deprecatedCustomGroupsJsonSchema,
               commonJsonSchemas.buildCustomGroupsArrayJsonSchema({
                 singleCustomGroupJsonSchema: types.singleCustomGroupJsonSchema,
               }),

package/dist/rules/sort-object-types.js

@@ -50,11 +50,13 @@ let jsonSchema = {
   items: {
     properties: {
       ...commonJsonSchemas.buildCommonJsonSchemas({
-        additionalFallbackSortProperties: {},
+        additionalFallbackSortProperties: {
+          sortBy: types.sortByJsonSchema,
+        },
       }),
       customGroups: {
         oneOf: [
-          commonJsonSchemas.customGroupsJsonSchema,
+          commonJsonSchemas.deprecatedCustomGroupsJsonSchema,
           commonJsonSchemas.buildCustomGroupsArrayJsonSchema({
             additionalFallbackSortProperties: {
               sortBy: types.sortByJsonSchema,

package/dist/rules/sort-objects.js

@@ -382,7 +382,7 @@ const sortObjects = createEslintRule.createEslintRule({
           },
           customGroups: {
             oneOf: [
-              commonJsonSchemas.customGroupsJsonSchema,
+              commonJsonSchemas.deprecatedCustomGroupsJsonSchema,
               commonJsonSchemas.buildCustomGroupsArrayJsonSchema({
                 singleCustomGroupJsonSchema: types.singleCustomGroupJsonSchema,
               }),

package/dist/rules/sort-union-types/types.js

@@ -0,0 +1,23 @@
+'use strict'
+Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' })
+const commonJsonSchemas = require('../../utils/common-json-schemas.js')
+let allSelectors = [
+  'intersection',
+  'conditional',
+  'function',
+  'operator',
+  'keyword',
+  'literal',
+  'nullish',
+  'import',
+  'object',
+  'named',
+  'tuple',
+  'union',
+]
+let singleCustomGroupJsonSchema = {
+  selector: commonJsonSchemas.buildCustomGroupSelectorJsonSchema(allSelectors),
+  elementNamePattern: commonJsonSchemas.regexJsonSchema,
+}
+exports.allSelectors = allSelectors
+exports.singleCustomGroupJsonSchema = singleCustomGroupJsonSchema

package/dist/rules/sort-union-types.js

@@ -6,10 +6,14 @@ Object.defineProperties(exports, {
 const commonJsonSchemas = require('../utils/common-json-schemas.js')
 const reportErrors = require('../utils/report-errors.js')
 const validateNewlinesAndPartitionConfiguration = require('../utils/validate-newlines-and-partition-configuration.js')
+const getCustomGroupsCompareOptions = require('../utils/get-custom-groups-compare-options.js')
+const validateGeneratedGroupsConfiguration = require('../utils/validate-generated-groups-configuration.js')
 const validateCustomSortConfiguration = require('../utils/validate-custom-sort-configuration.js')
-const validateGroupsConfiguration = require('../utils/validate-groups-configuration.js')
+const generatePredefinedGroups = require('../utils/generate-predefined-groups.js')
 const getEslintDisabledLines = require('../utils/get-eslint-disabled-lines.js')
 const isNodeEslintDisabled = require('../utils/is-node-eslint-disabled.js')
+const doesCustomGroupMatch = require('../utils/does-custom-group-match.js')
+const types = require('./sort-union-types/types.js')
 const sortNodesByGroups = require('../utils/sort-nodes-by-groups.js')
 const createEslintRule = require('../utils/create-eslint-rule.js')
 const reportAllErrors = require('../utils/report-all-errors.js')
@@ -18,6 +22,7 @@ const computeGroup = require('../utils/compute-group.js')
 const rangeToDiff = require('../utils/range-to-diff.js')
 const getSettings = require('../utils/get-settings.js')
 const complete = require('../utils/complete.js')
+let cachedGroupsByModifiersAndSelectors = /* @__PURE__ */ new Map()
 let defaultOptions = {
   fallbackSort: { type: 'unsorted' },
   specialCharacters: 'keep',
@@ -27,20 +32,28 @@ let defaultOptions = {
   type: 'alphabetical',
   ignoreCase: true,
   locales: 'en-US',
+  customGroups: [],
   alphabet: '',
   order: 'asc',
   groups: [],
 }
 let jsonSchema = {
-  properties: {
-    ...commonJsonSchemas.commonJsonSchemas,
-    partitionByComment: commonJsonSchemas.partitionByCommentJsonSchema,
-    partitionByNewLine: commonJsonSchemas.partitionByNewLineJsonSchema,
-    newlinesBetween: commonJsonSchemas.newlinesBetweenJsonSchema,
-    groups: commonJsonSchemas.groupsJsonSchema,
+  items: {
+    properties: {
+      ...commonJsonSchemas.commonJsonSchemas,
+      customGroups: commonJsonSchemas.buildCustomGroupsArrayJsonSchema({
+        singleCustomGroupJsonSchema: types.singleCustomGroupJsonSchema,
+      }),
+      partitionByComment: commonJsonSchemas.partitionByCommentJsonSchema,
+      partitionByNewLine: commonJsonSchemas.partitionByNewLineJsonSchema,
+      newlinesBetween: commonJsonSchemas.newlinesBetweenJsonSchema,
+      groups: commonJsonSchemas.groupsJsonSchema,
+    },
+    additionalProperties: false,
+    type: 'object',
   },
-  additionalProperties: false,
-  type: 'object',
+  uniqueItems: true,
+  type: 'array',
 }
 const sortUnionTypes = createEslintRule.createEslintRule({
   create: context => ({
@@ -70,7 +83,7 @@ const sortUnionTypes = createEslintRule.createEslintRule({
       description: 'Enforce sorted union types.',
       recommended: true,
     },
-    schema: [jsonSchema],
+    schema: jsonSchema,
     type: 'suggestion',
     fixable: 'code',
   },
@@ -90,23 +103,9 @@ let sortUnionOrIntersectionTypes = ({
     defaultOptions,
   )
   validateCustomSortConfiguration.validateCustomSortConfiguration(options)
-  validateGroupsConfiguration.validateGroupsConfiguration({
-    allowedPredefinedGroups: [
-      'intersection',
-      'conditional',
-      'function',
-      'operator',
-      'keyword',
-      'literal',
-      'nullish',
-      'unknown',
-      'import',
-      'object',
-      'named',
-      'tuple',
-      'union',
-    ],
-    allowedCustomGroups: [],
+  validateGeneratedGroupsConfiguration.validateGeneratedGroupsConfiguration({
+    selectors: types.allSelectors,
+    modifiers: [],
     options,
   })
   validateNewlinesAndPartitionConfiguration.validateNewlinesAndPartitionConfiguration(
@@ -119,33 +118,33 @@ let sortUnionOrIntersectionTypes = ({
   })
   let formattedMembers = node.types.reduce(
     (accumulator, type) => {
-      let predefinedGroups = []
+      let selectors = []
       switch (type.type) {
         case 'TSTemplateLiteralType':
         case 'TSLiteralType':
-          predefinedGroups.push('literal')
+          selectors.push('literal')
           break
         case 'TSIndexedAccessType':
         case 'TSTypeReference':
         case 'TSQualifiedName':
         case 'TSArrayType':
         case 'TSInferType':
-          predefinedGroups.push('named')
+          selectors.push('named')
           break
         case 'TSIntersectionType':
-          predefinedGroups.push('intersection')
+          selectors.push('intersection')
           break
         case 'TSUndefinedKeyword':
         case 'TSNullKeyword':
         case 'TSVoidKeyword':
-          predefinedGroups.push('nullish')
+          selectors.push('nullish')
           break
         case 'TSConditionalType':
-          predefinedGroups.push('conditional')
+          selectors.push('conditional')
           break
         case 'TSConstructorType':
         case 'TSFunctionType':
-          predefinedGroups.push('function')
+          selectors.push('function')
           break
         case 'TSBooleanKeyword':
         case 'TSUnknownKeyword':
@@ -157,27 +156,40 @@ let sortUnionOrIntersectionTypes = ({
         case 'TSNeverKeyword':
         case 'TSAnyKeyword':
         case 'TSThisType':
-          predefinedGroups.push('keyword')
+          selectors.push('keyword')
           break
         case 'TSTypeOperator':
         case 'TSTypeQuery':
-          predefinedGroups.push('operator')
+          selectors.push('operator')
           break
         case 'TSTypeLiteral':
         case 'TSMappedType':
-          predefinedGroups.push('object')
+          selectors.push('object')
           break
         case 'TSImportType':
-          predefinedGroups.push('import')
+          selectors.push('import')
           break
         case 'TSTupleType':
-          predefinedGroups.push('tuple')
+          selectors.push('tuple')
           break
         case 'TSUnionType':
-          predefinedGroups.push('union')
+          selectors.push('union')
           break
       }
+      let name = sourceCode.getText(type)
+      let predefinedGroups = generatePredefinedGroups.generatePredefinedGroups({
+        cache: cachedGroupsByModifiersAndSelectors,
+        modifiers: [],
+        selectors,
+      })
       let group = computeGroup.computeGroup({
+        customGroupMatcher: customGroup =>
+          doesCustomGroupMatch.doesCustomGroupMatch({
+            elementName: name,
+            modifiers: [],
+            customGroup,
+            selectors,
+          }),
         predefinedGroups,
         options,
       })
@@ -189,9 +201,9 @@ let sortUnionOrIntersectionTypes = ({
           eslintDisabledLines,
         ),
         size: rangeToDiff.rangeToDiff(type, sourceCode),
-        name: sourceCode.getText(type),
         node: type,
         group,
+        name,
       }
       if (
         shouldPartition.shouldPartition({
@@ -213,7 +225,10 @@ let sortUnionOrIntersectionTypes = ({
   for (let nodes of formattedMembers) {
     let sortNodesExcludingEslintDisabled = ignoreEslintDisabledNodes =>
       sortNodesByGroups.sortNodesByGroups({
-        getOptionsByGroupNumber: () => ({ options }),
+        getOptionsByGroupNumber:
+          getCustomGroupsCompareOptions.buildGetCustomGroupOverriddenOptionsFunction(
+            options,
+          ),
         ignoreEslintDisabledNodes,
         groups: options.groups,
         nodes,

package/dist/rules/sort-variable-declarations/types.js

@@ -0,0 +1,10 @@
+'use strict'
+Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' })
+const commonJsonSchemas = require('../../utils/common-json-schemas.js')
+let allSelectors = ['initialized', 'uninitialized']
+let singleCustomGroupJsonSchema = {
+  selector: commonJsonSchemas.buildCustomGroupSelectorJsonSchema(allSelectors),
+  elementNamePattern: commonJsonSchemas.regexJsonSchema,
+}
+exports.allSelectors = allSelectors
+exports.singleCustomGroupJsonSchema = singleCustomGroupJsonSchema

package/dist/rules/sort-variable-declarations.js

@@ -1,28 +1,38 @@
 'use strict'
 const commonJsonSchemas = require('../utils/common-json-schemas.js')
+const reportErrors = require('../utils/report-errors.js')
+const validateNewlinesAndPartitionConfiguration = require('../utils/validate-newlines-and-partition-configuration.js')
+const getCustomGroupsCompareOptions = require('../utils/get-custom-groups-compare-options.js')
 const validateCustomSortConfiguration = require('../utils/validate-custom-sort-configuration.js')
+const types = require('./sort-variable-declarations/types.js')
+const generatePredefinedGroups = require('../utils/generate-predefined-groups.js')
 const sortNodesByDependencies = require('../utils/sort-nodes-by-dependencies.js')
-const reportErrors = require('../utils/report-errors.js')
 const getEslintDisabledLines = require('../utils/get-eslint-disabled-lines.js')
 const isNodeEslintDisabled = require('../utils/is-node-eslint-disabled.js')
+const doesCustomGroupMatch = require('../utils/does-custom-group-match.js')
+const sortNodesByGroups = require('../utils/sort-nodes-by-groups.js')
 const createEslintRule = require('../utils/create-eslint-rule.js')
 const reportAllErrors = require('../utils/report-all-errors.js')
 const shouldPartition = require('../utils/should-partition.js')
+const computeGroup = require('../utils/compute-group.js')
 const rangeToDiff = require('../utils/range-to-diff.js')
 const getSettings = require('../utils/get-settings.js')
 const isSortable = require('../utils/is-sortable.js')
-const sortNodes = require('../utils/sort-nodes.js')
 const complete = require('../utils/complete.js')
+let cachedGroupsByModifiersAndSelectors = /* @__PURE__ */ new Map()
 let defaultOptions = {
   fallbackSort: { type: 'unsorted' },
   specialCharacters: 'keep',
   partitionByNewLine: false,
   partitionByComment: false,
+  newlinesBetween: 'ignore',
   type: 'alphabetical',
+  customGroups: [],
   ignoreCase: true,
   locales: 'en-US',
   alphabet: '',
   order: 'asc',
+  groups: [],
 }
 const sortVariableDeclarations = createEslintRule.createEslintRule({
   create: context => ({
@@ -37,83 +47,14 @@ const sortVariableDeclarations = createEslintRule.createEslintRule({
         defaultOptions,
       )
       validateCustomSortConfiguration.validateCustomSortConfiguration(options)
+      validateNewlinesAndPartitionConfiguration.validateNewlinesAndPartitionConfiguration(
+        options,
+      )
       let { sourceCode, id } = context
       let eslintDisabledLines = getEslintDisabledLines.getEslintDisabledLines({
         ruleName: id,
         sourceCode,
       })
-      let extractDependencies = init => {
-        let dependencies = []
-        let checkNode = nodeValue => {
-          if (
-            nodeValue.type === 'ArrowFunctionExpression' ||
-            nodeValue.type === 'FunctionExpression'
-          ) {
-            return
-          }
-          if (nodeValue.type === 'Identifier') {
-            dependencies.push(nodeValue.name)
-          }
-          if (nodeValue.type === 'Property') {
-            traverseNode(nodeValue.key)
-            traverseNode(nodeValue.value)
-          }
-          if (nodeValue.type === 'ConditionalExpression') {
-            traverseNode(nodeValue.test)
-            traverseNode(nodeValue.consequent)
-            traverseNode(nodeValue.alternate)
-          }
-          if (
-            'expression' in nodeValue &&
-            typeof nodeValue.expression !== 'boolean'
-          ) {
-            traverseNode(nodeValue.expression)
-          }
-          if ('object' in nodeValue) {
-            traverseNode(nodeValue.object)
-          }
-          if ('callee' in nodeValue) {
-            traverseNode(nodeValue.callee)
-          }
-          if ('left' in nodeValue) {
-            traverseNode(nodeValue.left)
-          }
-          if ('right' in nodeValue) {
-            traverseNode(nodeValue.right)
-          }
-          if ('elements' in nodeValue) {
-            let elements = nodeValue.elements.filter(
-              currentNode => currentNode !== null,
-            )
-            for (let element of elements) {
-              traverseNode(element)
-            }
-          }
-          if ('argument' in nodeValue && nodeValue.argument) {
-            traverseNode(nodeValue.argument)
-          }
-          if ('arguments' in nodeValue) {
-            for (let argument of nodeValue.arguments) {
-              traverseNode(argument)
-            }
-          }
-          if ('properties' in nodeValue) {
-            for (let property of nodeValue.properties) {
-              traverseNode(property)
-            }
-          }
-          if ('expressions' in nodeValue) {
-            for (let nodeExpression of nodeValue.expressions) {
-              traverseNode(nodeExpression)
-            }
-          }
-        }
-        let traverseNode = nodeValue => {
-          checkNode(nodeValue)
-        }
-        traverseNode(init)
-        return dependencies
-      }
       let formattedMembers = node.declarations.reduce(
         (accumulator, declaration) => {
           var _a, _b
@@ -126,13 +67,34 @@ const sortVariableDeclarations = createEslintRule.createEslintRule({
           } else {
             ;({ name } = declaration.id)
           }
+          let selector
           let dependencies = []
           if (declaration.init) {
             dependencies = extractDependencies(declaration.init)
+            selector = 'initialized'
+          } else {
+            selector = 'uninitialized'
           }
+          let predefinedGroups =
+            generatePredefinedGroups.generatePredefinedGroups({
+              cache: cachedGroupsByModifiersAndSelectors,
+              selectors: [selector],
+              modifiers: [],
+            })
           let lastSortingNode =
             (_a = accumulator.at(-1)) == null ? void 0 : _a.at(-1)
           let sortingNode = {
+            group: computeGroup.computeGroup({
+              customGroupMatcher: customGroup =>
+                doesCustomGroupMatch.doesCustomGroupMatch({
+                  selectors: [selector],
+                  elementName: name,
+                  modifiers: [],
+                  customGroup,
+                }),
+              predefinedGroups,
+              options,
+            }),
             isEslintDisabled: isNodeEslintDisabled.isNodeEslintDisabled(
               declaration,
               eslintDisabledLines,
@@ -158,24 +120,35 @@ const sortVariableDeclarations = createEslintRule.createEslintRule({
         },
         [[]],
       )
-      let sortNodesExcludingEslintDisabled = ignoreEslintDisabledNodes =>
-        sortNodesByDependencies.sortNodesByDependencies(
-          formattedMembers.flatMap(nodes2 =>
-            sortNodes.sortNodes({
-              ignoreEslintDisabledNodes,
-              options,
-              nodes: nodes2,
-            }),
-          ),
+      let sortNodesExcludingEslintDisabled = ignoreEslintDisabledNodes => {
+        let nodesSortedByGroups = formattedMembers.flatMap(nodes2 =>
+          sortNodesByGroups.sortNodesByGroups({
+            getOptionsByGroupNumber:
+              getCustomGroupsCompareOptions.buildGetCustomGroupOverriddenOptionsFunction(
+                options,
+              ),
+            ignoreEslintDisabledNodes,
+            groups: options.groups,
+            nodes: nodes2,
+          }),
+        )
+        return sortNodesByDependencies.sortNodesByDependencies(
+          nodesSortedByGroups,
           {
             ignoreEslintDisabledNodes,
           },
         )
+      }
       let nodes = formattedMembers.flat()
       reportAllErrors.reportAllErrors({
         availableMessageIds: {
+          missedSpacingBetweenMembers:
+            'missedSpacingBetweenVariableDeclarationsMembers',
+          extraSpacingBetweenMembers:
+            'extraSpacingBetweenVariableDeclarationsMembers',
           unexpectedDependencyOrder:
             'unexpectedVariableDeclarationsDependencyOrder',
+          unexpectedGroupOrder: 'unexpectedVariableDeclarationsGroupOrder',
           unexpectedOrder: 'unexpectedVariableDeclarationsOrder',
         },
         sortNodesExcludingEslintDisabled,
@@ -191,27 +164,109 @@ const sortVariableDeclarations = createEslintRule.createEslintRule({
       {
         properties: {
           ...commonJsonSchemas.commonJsonSchemas,
+          customGroups: commonJsonSchemas.buildCustomGroupsArrayJsonSchema({
+            singleCustomGroupJsonSchema: types.singleCustomGroupJsonSchema,
+          }),
           partitionByComment: commonJsonSchemas.partitionByCommentJsonSchema,
           partitionByNewLine: commonJsonSchemas.partitionByNewLineJsonSchema,
+          newlinesBetween: commonJsonSchemas.newlinesBetweenJsonSchema,
+          groups: commonJsonSchemas.groupsJsonSchema,
         },
         additionalProperties: false,
         type: 'object',
       },
     ],
-    docs: {
-      url: 'https://perfectionist.dev/rules/sort-variable-declarations',
-      description: 'Enforce sorted variable declarations.',
-      recommended: true,
-    },
     messages: {
+      missedSpacingBetweenVariableDeclarationsMembers:
+        reportErrors.MISSED_SPACING_ERROR,
       unexpectedVariableDeclarationsDependencyOrder:
         reportErrors.DEPENDENCY_ORDER_ERROR,
+      extraSpacingBetweenVariableDeclarationsMembers:
+        reportErrors.EXTRA_SPACING_ERROR,
+      unexpectedVariableDeclarationsGroupOrder: reportErrors.GROUP_ORDER_ERROR,
       unexpectedVariableDeclarationsOrder: reportErrors.ORDER_ERROR,
     },
+    docs: {
+      url: 'https://perfectionist.dev/rules/sort-variable-declarations',
+      description: 'Enforce sorted variable declarations.',
+      recommended: true,
+    },
     type: 'suggestion',
     fixable: 'code',
   },
   name: 'sort-variable-declarations',
   defaultOptions: [defaultOptions],
 })
+let extractDependencies = init => {
+  let dependencies = []
+  let checkNode = nodeValue => {
+    if (
+      nodeValue.type === 'ArrowFunctionExpression' ||
+      nodeValue.type === 'FunctionExpression'
+    ) {
+      return
+    }
+    if (nodeValue.type === 'Identifier') {
+      dependencies.push(nodeValue.name)
+    }
+    if (nodeValue.type === 'Property') {
+      traverseNode(nodeValue.key)
+      traverseNode(nodeValue.value)
+    }
+    if (nodeValue.type === 'ConditionalExpression') {
+      traverseNode(nodeValue.test)
+      traverseNode(nodeValue.consequent)
+      traverseNode(nodeValue.alternate)
+    }
+    if (
+      'expression' in nodeValue &&
+      typeof nodeValue.expression !== 'boolean'
+    ) {
+      traverseNode(nodeValue.expression)
+    }
+    if ('object' in nodeValue) {
+      traverseNode(nodeValue.object)
+    }
+    if ('callee' in nodeValue) {
+      traverseNode(nodeValue.callee)
+    }
+    if ('left' in nodeValue) {
+      traverseNode(nodeValue.left)
+    }
+    if ('right' in nodeValue) {
+      traverseNode(nodeValue.right)
+    }
+    if ('elements' in nodeValue) {
+      let elements = nodeValue.elements.filter(
+        currentNode => currentNode !== null,
+      )
+      for (let element of elements) {
+        traverseNode(element)
+      }
+    }
+    if ('argument' in nodeValue && nodeValue.argument) {
+      traverseNode(nodeValue.argument)
+    }
+    if ('arguments' in nodeValue) {
+      for (let argument of nodeValue.arguments) {
+        traverseNode(argument)
+      }
+    }
+    if ('properties' in nodeValue) {
+      for (let property of nodeValue.properties) {
+        traverseNode(property)
+      }
+    }
+    if ('expressions' in nodeValue) {
+      for (let nodeExpression of nodeValue.expressions) {
+        traverseNode(nodeExpression)
+      }
+    }
+  }
+  let traverseNode = nodeValue => {
+    checkNode(nodeValue)
+  }
+  traverseNode(init)
+  return dependencies
+}
 module.exports = sortVariableDeclarations

package/dist/utils/common-json-schemas.js

@@ -7,12 +7,13 @@ let typeJsonSchema = {
 }
 let orderJsonSchema = {
   description:
-    'Determines whether the sorted items should be in ascending or descending order.',
+    'Specifies whether to sort items in ascending or descending order.',
   enum: ['asc', 'desc'],
   type: 'string',
 }
 let alphabetJsonSchema = {
-  description: 'Alphabet to use for the `custom` sort type.',
+  description:
+    "Used only when the `type` option is set to `'custom'`. Specifies the custom alphabet for sorting.",
   type: 'string',
 }
 let localesJsonSchema = {
@@ -35,7 +36,7 @@ let ignoreCaseJsonSchema = {
 }
 let specialCharactersJsonSchema = {
   description:
-    'Controls how special characters should be handled before sorting.',
+    'Specifies whether to trim, remove, or keep special characters before sorting.',
   enum: ['remove', 'trim', 'keep'],
   type: 'string',
 }
@@ -46,10 +47,14 @@ let buildFallbackSortJsonSchema = ({ additionalProperties } = {}) => ({
     ...additionalProperties,
   },
   description: 'Fallback sort order.',
+  additionalProperties: false,
+  minProperties: 1,
   type: 'object',
 })
 let buildCommonJsonSchemas = ({ additionalFallbackSortProperties } = {}) => ({
-  fallbackSort: buildFallbackSortJsonSchema(additionalFallbackSortProperties),
+  fallbackSort: buildFallbackSortJsonSchema({
+    additionalProperties: additionalFallbackSortProperties,
+  }),
   specialCharacters: specialCharactersJsonSchema,
   ignoreCase: ignoreCaseJsonSchema,
   alphabet: alphabetJsonSchema,
@@ -59,7 +64,7 @@ let buildCommonJsonSchemas = ({ additionalFallbackSortProperties } = {}) => ({
 })
 let commonJsonSchemas = buildCommonJsonSchemas()
 let newlinesBetweenJsonSchema = {
-  description: 'Specifies how new lines should be handled between groups.',
+  description: 'Specifies how to handle new lines between groups.',
   enum: ['ignore', 'always', 'never'],
   type: 'string',
 }
@@ -79,15 +84,16 @@ let groupsJsonSchema = {
         properties: {
           newlinesBetween: newlinesBetweenJsonSchema,
         },
+        required: ['newlinesBetween'],
         additionalProperties: false,
         type: 'object',
       },
     ],
   },
-  description: 'Specifies the order of the groups.',
+  description: 'Specifies a list of groups for sorting.',
   type: 'array',
 }
-let customGroupsJsonSchema = {
+let deprecatedCustomGroupsJsonSchema = {
   additionalProperties: {
     oneOf: [
       {
@@ -109,13 +115,16 @@ let singleRegexJsonSchema = {
     {
       properties: {
         pattern: {
+          description: 'Regular expression pattern.',
           type: 'string',
         },
         flags: {
+          description: 'Regular expression flags.',
           type: 'string',
         },
       },
       additionalProperties: false,
+      required: ['pattern'],
       // https://github.com/azat-io/eslint-plugin-perfectionist/pull/490#issuecomment-2720969705
       // Uncomment the code below in the next major version (v5)
       // To uncomment: required: ['pattern'],
@@ -149,25 +158,30 @@ let partitionByCommentJsonSchema = {
     {
       properties: {
         block: {
+          description: 'Enables specific block comments to separate the nodes.',
           oneOf: allowedPartitionByCommentJsonSchemas,
         },
         line: {
+          description: 'Enables specific line comments to separate the nodes.',
           oneOf: allowedPartitionByCommentJsonSchemas,
         },
       },
       additionalProperties: false,
+      minProperties: 1,
       type: 'object',
     },
   ],
   description:
-    'Allows to use comments to separate members into logical groups.',
+    'Enables the use of comments to separate the nodes into logical groups.',
 }
 let partitionByNewLineJsonSchema = {
   description:
-    'Allows to use newlines to separate the nodes into logical groups.',
+    'Enables the use of newlines to separate the nodes into logical groups.',
   type: 'boolean',
 }
 let buildUseConfigurationIfJsonSchema = ({ additionalProperties } = {}) => ({
+  description:
+    'Specifies filters to match a particular options configuration for a given element to sort.',
   properties: {
     allNamesMatchPattern: regexJsonSchema,
     ...additionalProperties,
@@ -180,7 +194,7 @@ let buildCommonCustomGroupJsonSchemas = ({
 } = {}) => ({
   newlinesInside: {
     description:
-      'Specifies how new lines should be handled between members of the custom group.',
+      'Specifies how to handle new lines between members of the custom group.',
     enum: ['always', 'never'],
     type: 'string',
   },
@@ -219,6 +233,7 @@ let buildCustomGroupsArrayJsonSchema = ({
         },
         description: 'Custom group block.',
         additionalProperties: false,
+        required: ['groupName'],
         type: 'object',
       },
       {
@@ -230,11 +245,12 @@ let buildCustomGroupsArrayJsonSchema = ({
         },
         description: 'Custom group.',
         additionalProperties: false,
+        required: ['groupName'],
         type: 'object',
       },
     ],
   },
-  description: 'Specifies custom groups.',
+  description: 'Defines custom groups to match specific members.',
   type: 'array',
 })
 let buildCustomGroupModifiersJsonSchema = modifiers => ({
@@ -257,7 +273,7 @@ exports.buildCustomGroupSelectorJsonSchema = buildCustomGroupSelectorJsonSchema
 exports.buildCustomGroupsArrayJsonSchema = buildCustomGroupsArrayJsonSchema
 exports.buildUseConfigurationIfJsonSchema = buildUseConfigurationIfJsonSchema
 exports.commonJsonSchemas = commonJsonSchemas
-exports.customGroupsJsonSchema = customGroupsJsonSchema
+exports.deprecatedCustomGroupsJsonSchema = deprecatedCustomGroupsJsonSchema
 exports.groupsJsonSchema = groupsJsonSchema
 exports.newlinesBetweenJsonSchema = newlinesBetweenJsonSchema
 exports.partitionByCommentJsonSchema = partitionByCommentJsonSchema

package/dist/utils/get-comments-before.js

@@ -1,7 +1,7 @@
 'use strict'
 Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' })
 let getCommentsBefore = ({ tokenValueToIgnoreBefore, sourceCode, node }) => {
-  let commentsBefore = getCommentsBeforeNodeOrToken(sourceCode, node)
+  let commentsBefore = getRelevantCommentsBeforeNodeOrToken(sourceCode, node)
   let tokenBeforeNode = sourceCode.getTokenBefore(node)
   if (
     commentsBefore.length > 0 ||
@@ -11,15 +11,20 @@ let getCommentsBefore = ({ tokenValueToIgnoreBefore, sourceCode, node }) => {
   ) {
     return commentsBefore
   }
-  return getCommentsBeforeNodeOrToken(sourceCode, tokenBeforeNode)
+  return getRelevantCommentsBeforeNodeOrToken(sourceCode, tokenBeforeNode)
 }
-let getCommentsBeforeNodeOrToken = (source, node) =>
-  source.getCommentsBefore(node).filter(comment => {
-    let tokenBeforeComment = source.getTokenBefore(comment)
-    return (
-      (tokenBeforeComment == null
-        ? void 0
-        : tokenBeforeComment.loc.end.line) !== comment.loc.end.line
-    )
-  })
+let getRelevantCommentsBeforeNodeOrToken = (source, node) =>
+  source
+    .getCommentsBefore(node)
+    .filter(comment => !isShebangComment(comment))
+    .filter(comment => {
+      let tokenBeforeComment = source.getTokenBefore(comment)
+      return (
+        (tokenBeforeComment == null
+          ? void 0
+          : tokenBeforeComment.loc.end.line) !== comment.loc.end.line
+      )
+    })
+let isShebangComment = comment =>
+  comment.type === 'Shebang' || comment.type === 'Hashbang'
 exports.getCommentsBefore = getCommentsBefore

package/dist/utils/report-all-errors.js

@@ -28,12 +28,8 @@ let reportAllErrors = ({
         )
       : /* @__PURE__ */ new Set()
   pairwise.pairwise(nodes, (left, right) => {
-    let leftNumber = options.groups
-      ? getGroupNumber.getGroupNumber(options.groups, left)
-      : 0
-    let rightNumber = options.groups
-      ? getGroupNumber.getGroupNumber(options.groups, right)
-      : 0
+    let leftNumber = getGroupNumber.getGroupNumber(options.groups, left)
+    let rightNumber = getGroupNumber.getGroupNumber(options.groups, right)
     let leftIndex = nodeIndexMap.get(left)
     let rightIndex = nodeIndexMap.get(right)
     let indexOfRightExcludingEslintDisabled =
@@ -66,7 +62,6 @@ let reportAllErrors = ({
     }
     if (
       options.newlinesBetween &&
-      options.groups &&
       availableMessageIds.missedSpacingBetweenMembers &&
       availableMessageIds.extraSpacingBetweenMembers
     ) {
@@ -76,7 +71,6 @@ let reportAllErrors = ({
           options: {
             ...options,
             newlinesBetween: options.newlinesBetween,
-            groups: options.groups,
           },
           missedSpacingError: availableMessageIds.missedSpacingBetweenMembers,
           extraSpacingError: availableMessageIds.extraSpacingBetweenMembers,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-perfectionist",
-  "version": "4.12.2",
+  "version": "4.13.0",
   "description": "ESLint plugin for sorting various data such as objects, imports, types, enums, JSX props, etc.",
   "keywords": [
     "eslint",
@@ -27,8 +27,8 @@
     "./dist"
   ],
   "dependencies": {
-    "@typescript-eslint/types": "^8.31.0",
-    "@typescript-eslint/utils": "^8.31.0",
+    "@typescript-eslint/types": "^8.32.1",
+    "@typescript-eslint/utils": "^8.32.1",
     "natural-orderby": "^5.0.0"
   },
   "peerDependencies": {

package/dist/utils/validate-groups-configuration.js

@@ -1,37 +0,0 @@
-'use strict'
-Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' })
-const validateNewlinesBetweenInsideGroups = require('./validate-newlines-between-inside-groups.js')
-const validateNoDuplicatedGroups = require('./validate-no-duplicated-groups.js')
-const isNewlinesBetweenOption = require('./is-newlines-between-option.js')
-let validateGroupsConfiguration = ({
-  allowedPredefinedGroups,
-  allowedCustomGroups,
-  options,
-}) => {
-  let allowedGroupsSet = /* @__PURE__ */ new Set([
-    ...allowedPredefinedGroups,
-    ...allowedCustomGroups,
-  ])
-  let invalidGroups = []
-  for (let groupElement of options.groups) {
-    if (isNewlinesBetweenOption.isNewlinesBetweenOption(groupElement)) {
-      continue
-    }
-    let groupElements = Array.isArray(groupElement)
-      ? groupElement
-      : [groupElement]
-    for (let group of groupElements) {
-      if (!allowedGroupsSet.has(group)) {
-        invalidGroups.push(group)
-      }
-    }
-  }
-  if (invalidGroups.length > 0) {
-    throw new Error(`Invalid group(s): ${invalidGroups.join(', ')}`)
-  }
-  validateNoDuplicatedGroups.validateNoDuplicatedGroups(options)
-  validateNewlinesBetweenInsideGroups.validateNewlinesBetweenInsideGroups(
-    options,
-  )
-}
-exports.validateGroupsConfiguration = validateGroupsConfiguration