eslint-plugin-perfectionist 4.10.1 → 4.12.0

package/dist/index.d.ts

@@ -36,7 +36,10 @@ declare interface PluginConfig {
     'recommended-natural': Linter.Config
     'recommended-custom': Linter.Config
   }
-  name: string
+  meta: {
+    version: string
+    name: string
+  }
 }
 
 export {}

package/dist/index.js

@@ -1,4 +1,5 @@
 'use strict'
+const _package = require('./package.json.js')
 const sortVariableDeclarations = require('./rules/sort-variable-declarations.js')
 const sortIntersectionTypes = require('./rules/sort-intersection-types.js')
 const sortHeritageClauses = require('./rules/sort-heritage-clauses.js')
@@ -19,7 +20,7 @@ const sortModules = require('./rules/sort-modules.js')
 const sortEnums = require('./rules/sort-enums.js')
 const sortMaps = require('./rules/sort-maps.js')
 const sortSets = require('./rules/sort-sets.js')
-let name = 'perfectionist'
+let pluginName = 'perfectionist'
 let plugin = {
   rules: {
     'sort-variable-declarations': sortVariableDeclarations,
@@ -43,24 +44,27 @@ let plugin = {
     'sort-sets': sortSets,
     'sort-maps': sortMaps,
   },
-  name,
+  meta: {
+    version: _package.version,
+    name: _package.name,
+  },
 }
 let getRules = options =>
   Object.fromEntries(
     Object.keys(plugin.rules).map(ruleName => [
-      `${name}/${ruleName}`,
+      `${pluginName}/${ruleName}`,
       ['error', options],
     ]),
   )
 let createConfig = options => ({
   plugins: {
-    [name]: plugin,
+    [pluginName]: plugin,
   },
   rules: getRules(options),
 })
 let createLegacyConfig = options => ({
   rules: getRules(options),
-  plugins: [name],
+  plugins: [pluginName],
 })
 const index = {
   ...plugin,

package/dist/package.json.js

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

package/dist/rules/sort-array-includes.js

@@ -10,19 +10,19 @@ const getCustomGroupsCompareOptions = require('../utils/get-custom-groups-compar
 const validateGeneratedGroupsConfiguration = require('../utils/validate-generated-groups-configuration.js')
 const validateCustomSortConfiguration = require('../utils/validate-custom-sort-configuration.js')
 const types = require('./sort-array-includes/types.js')
-const doesCustomGroupMatch = require('./sort-array-includes/does-custom-group-match.js')
 const getMatchingContextOptions = require('../utils/get-matching-context-options.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 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 useGroups = require('../utils/use-groups.js')
 const complete = require('../utils/complete.js')
 let cachedGroupsByModifiersAndSelectors = /* @__PURE__ */ new Map()
 let defaultOptions = {
@@ -46,8 +46,8 @@ let jsonSchema = {
     properties: {
       ...commonJsonSchemas.commonJsonSchemas,
       groupKind: {
+        description: '[DEPRECATED] Specifies top-level groups.',
         enum: ['mixed', 'literals-first', 'spreads-first'],
-        description: 'Specifies top-level groups.',
         type: 'string',
       },
       customGroups: commonJsonSchemas.buildCustomGroupsArrayJsonSchema({
@@ -150,7 +150,6 @@ let sortArray = ({ availableMessageIds, elements, context }) => {
       if (element === null) {
         return accumulator
       }
-      let { defineGroup, getGroup } = useGroups.useGroups(options)
       let groupKind
       let selector
       if (element.type === 'SpreadElement') {
@@ -160,38 +159,32 @@ let sortArray = ({ availableMessageIds, elements, context }) => {
         groupKind = 'literal'
         selector = 'literal'
       }
+      let name = getNodeName({ sourceCode, element })
       let predefinedGroups = generatePredefinedGroups.generatePredefinedGroups({
         cache: cachedGroupsByModifiersAndSelectors,
         selectors: [selector],
         modifiers: [],
       })
-      for (let predefinedGroup of predefinedGroups) {
-        defineGroup(predefinedGroup)
-      }
-      let name = getNodeName({ sourceCode, element })
-      for (let customGroup of options.customGroups) {
-        if (
+      let group = computeGroup.computeGroup({
+        customGroupMatcher: customGroup =>
           doesCustomGroupMatch.doesCustomGroupMatch({
             selectors: [selector],
             elementName: name,
+            modifiers: [],
             customGroup,
-          })
-        ) {
-          defineGroup(customGroup.groupName, true)
-          if (getGroup() === customGroup.groupName) {
-            break
-          }
-        }
-      }
+          }),
+        predefinedGroups,
+        options,
+      })
       let sortingNode = {
         isEslintDisabled: isNodeEslintDisabled.isNodeEslintDisabled(
           element,
           eslintDisabledLines,
         ),
         size: rangeToDiff.rangeToDiff(element, sourceCode),
-        group: getGroup(),
         node: element,
         groupKind,
+        group,
         name,
       }
       let lastSortingNode =

package/dist/rules/sort-classes.js

@@ -9,9 +9,9 @@ const validateCustomSortConfiguration = require('../utils/validate-custom-sort-c
 const getOverloadSignatureGroups = require('./sort-classes/get-overload-signature-groups.js')
 const generatePredefinedGroups = require('../utils/generate-predefined-groups.js')
 const sortNodesByDependencies = require('../utils/sort-nodes-by-dependencies.js')
-const doesCustomGroupMatch = require('./sort-classes/does-custom-group-match.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 getNodeDecorators = require('../utils/get-node-decorators.js')
 const createEslintRule = require('../utils/create-eslint-rule.js')
@@ -19,10 +19,10 @@ const getDecoratorName = require('../utils/get-decorator-name.js')
 const reportAllErrors = require('../utils/report-all-errors.js')
 const shouldPartition = require('../utils/should-partition.js')
 const getGroupNumber = require('../utils/get-group-number.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 useGroups = require('../utils/use-groups.js')
 const complete = require('../utils/complete.js')
 const matches = require('../utils/matches.js')
 let cachedGroupsByModifiersAndSelectors = /* @__PURE__ */ new Map()
@@ -233,7 +233,6 @@ const sortClasses = createEslintRule.createEslintRule({
           var _a2, _b, _c, _d, _e
           let name
           let dependencies = []
-          let { defineGroup, getGroup } = useGroups.useGroups(options)
           if (member.type === 'StaticBlock') {
             name = 'static'
           } else if (member.type === 'TSIndexSignature') {
@@ -402,11 +401,8 @@ const sortClasses = createEslintRule.createEslintRule({
               selectors,
               modifiers,
             })
-          for (let predefinedGroup of predefinedGroups) {
-            defineGroup(predefinedGroup)
-          }
-          for (let customGroup of options.customGroups) {
-            if (
+          let group = computeGroup.computeGroup({
+            customGroupMatcher: customGroup =>
               doesCustomGroupMatch.doesCustomGroupMatch({
                 elementValue: memberValue,
                 elementName: name,
@@ -414,14 +410,10 @@ const sortClasses = createEslintRule.createEslintRule({
                 decorators,
                 modifiers,
                 selectors,
-              })
-            ) {
-              defineGroup(customGroup.groupName, true)
-              if (getGroup() === customGroup.groupName) {
-                break
-              }
-            }
-          }
+              }),
+            predefinedGroups,
+            options,
+          })
           let overloadSignatureGroupMemberIndex =
             overloadSignatureGroups.findIndex(overloadSignatures =>
               overloadSignatures.includes(member),
@@ -432,13 +424,15 @@ const sortClasses = createEslintRule.createEslintRule({
               ? void 0
               : _d.at(-1)
           let sortingNode = {
-            dependencyName: getDependencyName({
-              nodeNameWithoutStartingHash: name.startsWith('#')
-                ? name.slice(1)
-                : name,
-              isStatic: modifiers.includes('static'),
-              isPrivateHash,
-            }),
+            dependencyNames: [
+              getDependencyName({
+                nodeNameWithoutStartingHash: name.startsWith('#')
+                  ? name.slice(1)
+                  : name,
+                isStatic: modifiers.includes('static'),
+                isPrivateHash,
+              }),
+            ],
             overloadSignaturesGroupId:
               overloadSignatureGroupMemberIndex === -1
                 ? null
@@ -454,9 +448,9 @@ const sortClasses = createEslintRule.createEslintRule({
               eslintDisabledLines,
             ),
             addSafetySemicolonWhenInline,
-            group: getGroup(),
             node: member,
             dependencies,
+            group,
             name,
           }
           let lastSortingNode =

package/dist/rules/sort-decorators.js

@@ -11,10 +11,10 @@ const getDecoratorName = require('../utils/get-decorator-name.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 useGroups = require('../utils/use-groups.js')
 const complete = require('../utils/complete.js')
 let defaultOptions = {
   fallbackSort: { type: 'unsorted' },
@@ -163,20 +163,23 @@ let sortDecorators$1 = (context, options, decorators) => {
   let formattedMembers = decorators.reduce(
     (accumulator, decorator) => {
       var _a
-      let { setCustomGroups, getGroup } = useGroups.useGroups(options)
       let name = getDecoratorName.getDecoratorName({
         sourceCode,
         decorator,
       })
-      setCustomGroups(options.customGroups, name)
+      let group = computeGroup.computeGroup({
+        predefinedGroups: [],
+        options,
+        name,
+      })
       let sortingNode = {
         isEslintDisabled: isNodeEslintDisabled.isNodeEslintDisabled(
           decorator,
           eslintDisabledLines,
         ),
         size: rangeToDiff.rangeToDiff(decorator, sourceCode),
-        group: getGroup(),
         node: decorator,
+        group,
         name,
       }
       let lastSortingNode =

package/dist/rules/sort-enums.js

@@ -7,18 +7,18 @@ const validateCustomSortConfiguration = require('../utils/validate-custom-sort-c
 const getCustomGroupsCompareOptions = require('../utils/get-custom-groups-compare-options.js')
 const sortNodesByDependencies = require('../utils/sort-nodes-by-dependencies.js')
 const getEslintDisabledLines = require('../utils/get-eslint-disabled-lines.js')
-const doesCustomGroupMatch = require('./sort-enums/does-custom-group-match.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 types = require('./sort-enums/types.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 getEnumMembers = require('../utils/get-enum-members.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 useGroups = require('../utils/use-groups.js')
 const complete = require('../utils/complete.js')
 let defaultOptions = {
   fallbackSort: { type: 'unsorted' },
@@ -109,21 +109,18 @@ const sortEnums = createEslintRule.createEslintRule({
             member.id.type === 'Literal'
               ? `${member.id.value}`
               : sourceCode.getText(member.id)
-          let { defineGroup, getGroup } = useGroups.useGroups(options)
-          for (let customGroup of options.customGroups) {
-            if (
+          let group = computeGroup.computeGroup({
+            customGroupMatcher: customGroup =>
               doesCustomGroupMatch.doesCustomGroupMatch({
                 elementValue: sourceCode.getText(member.initializer),
                 elementName: name,
+                selectors: [],
+                modifiers: [],
                 customGroup,
-              })
-            ) {
-              defineGroup(customGroup.groupName, true)
-              if (getGroup() === customGroup.groupName) {
-                break
-              }
-            }
-          }
+              }),
+            predefinedGroups: [],
+            options,
+          })
           let lastSortingNode =
             (_a = accumulator.at(-1)) == null ? void 0 : _a.at(-1)
           let sortingNode = {
@@ -142,9 +139,10 @@ const sortEnums = createEslintRule.createEslintRule({
               eslintDisabledLines,
             ),
             size: rangeToDiff.rangeToDiff(member, sourceCode),
-            group: getGroup(),
+            dependencyNames: [name],
             node: member,
             dependencies,
+            group,
             name,
           }
           if (

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

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

package/dist/rules/sort-exports.js

@@ -1,27 +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 validateGeneratedGroupsConfiguration = require('../utils/validate-generated-groups-configuration.js')
 const validateCustomSortConfiguration = require('../utils/validate-custom-sort-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-exports/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')
 const shouldPartition = require('../utils/should-partition.js')
+const computeGroup = require('../utils/compute-group.js')
 const rangeToDiff = require('../utils/range-to-diff.js')
-const reportErrors = require('../utils/report-errors.js')
 const getSettings = require('../utils/get-settings.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',
   partitionByComment: false,
+  newlinesBetween: 'ignore',
   partitionByNewLine: false,
   type: 'alphabetical',
   groupKind: 'mixed',
+  customGroups: [],
   ignoreCase: true,
   locales: 'en-US',
   alphabet: '',
   order: 'asc',
+  groups: [],
 }
 const sortExports = createEslintRule.createEslintRule({
   create: context => {
@@ -32,14 +43,46 @@ const sortExports = createEslintRule.createEslintRule({
       defaultOptions,
     )
     validateCustomSortConfiguration.validateCustomSortConfiguration(options)
+    validateGeneratedGroupsConfiguration.validateGeneratedGroupsConfiguration({
+      modifiers: types.allModifiers,
+      selectors: types.allSelectors,
+      options,
+    })
+    validateNewlinesAndPartitionConfiguration.validateNewlinesAndPartitionConfiguration(
+      options,
+    )
     let { sourceCode, id } = context
     let eslintDisabledLines = getEslintDisabledLines.getEslintDisabledLines({
       ruleName: id,
       sourceCode,
     })
-    let parts = [[]]
+    let formattedMembers = [[]]
     let registerNode = node => {
       var _a
+      let selector = 'export'
+      let modifiers = []
+      if (node.exportKind === 'value') {
+        modifiers.push('value')
+      } else {
+        modifiers.push('type')
+      }
+      let name = node.source.value
+      let predefinedGroups = generatePredefinedGroups.generatePredefinedGroups({
+        cache: cachedGroupsByModifiersAndSelectors,
+        selectors: [selector],
+        modifiers,
+      })
+      let group = computeGroup.computeGroup({
+        customGroupMatcher: customGroup =>
+          doesCustomGroupMatch.doesCustomGroupMatch({
+            selectors: [selector],
+            elementName: name,
+            customGroup,
+            modifiers,
+          }),
+        predefinedGroups,
+        options,
+      })
       let sortingNode = {
         isEslintDisabled: isNodeEslintDisabled.isNodeEslintDisabled(
           node,
@@ -48,10 +91,11 @@ const sortExports = createEslintRule.createEslintRule({
         groupKind: node.exportKind === 'value' ? 'value' : 'type',
         size: rangeToDiff.rangeToDiff(node, sourceCode),
         addSafetySemicolonWhenInline: true,
-        name: node.source.value,
+        group,
+        name,
         node,
       }
-      let lastNode = (_a = parts.at(-1)) == null ? void 0 : _a.at(-1)
+      let lastNode = (_a = formattedMembers.at(-1)) == null ? void 0 : _a.at(-1)
       if (
         shouldPartition.shouldPartition({
           lastSortingNode: lastNode,
@@ -60,9 +104,9 @@ const sortExports = createEslintRule.createEslintRule({
           options,
         })
       ) {
-        parts.push([])
+        formattedMembers.push([])
       }
-      parts.at(-1).push(sortingNode)
+      formattedMembers.at(-1).push(sortingNode)
     }
     return {
       'Program:exit': () => {
@@ -74,7 +118,7 @@ const sortExports = createEslintRule.createEslintRule({
         } else {
           groupKindOrder = ['any']
         }
-        for (let nodes of parts) {
+        for (let nodes of formattedMembers) {
           let filteredGroupKindNodes = groupKindOrder.map(groupKind =>
             nodes.filter(
               currentNode =>
@@ -83,14 +127,21 @@ const sortExports = createEslintRule.createEslintRule({
           )
           let sortNodesExcludingEslintDisabled = ignoreEslintDisabledNodes =>
             filteredGroupKindNodes.flatMap(groupedNodes =>
-              sortNodes.sortNodes({
+              sortNodesByGroups.sortNodesByGroups({
+                getOptionsByGroupNumber:
+                  getCustomGroupsCompareOptions.buildGetCustomGroupOverriddenOptionsFunction(
+                    options,
+                  ),
                 ignoreEslintDisabledNodes,
+                groups: options.groups,
                 nodes: groupedNodes,
-                options,
               }),
             )
           reportAllErrors.reportAllErrors({
             availableMessageIds: {
+              missedSpacingBetweenMembers: 'missedSpacingBetweenExports',
+              extraSpacingBetweenMembers: 'extraSpacingBetweenExports',
+              unexpectedGroupOrder: 'unexpectedExportsGroupOrder',
               unexpectedOrder: 'unexpectedExportsOrder',
             },
             sortNodesExcludingEslintDisabled,
@@ -110,30 +161,40 @@ const sortExports = createEslintRule.createEslintRule({
     }
   },
   meta: {
-    schema: [
-      {
+    schema: {
+      items: {
         properties: {
           ...commonJsonSchemas.commonJsonSchemas,
           groupKind: {
+            description: '[DEPRECATED] Specifies top-level groups.',
             enum: ['mixed', 'values-first', 'types-first'],
-            description: 'Specifies top-level groups.',
             type: 'string',
           },
+          customGroups: commonJsonSchemas.buildCustomGroupsArrayJsonSchema({
+            singleCustomGroupJsonSchema: types.singleCustomGroupJsonSchema,
+          }),
           partitionByComment: commonJsonSchemas.partitionByCommentJsonSchema,
           partitionByNewLine: commonJsonSchemas.partitionByNewLineJsonSchema,
+          newlinesBetween: commonJsonSchemas.newlinesBetweenJsonSchema,
+          groups: commonJsonSchemas.groupsJsonSchema,
         },
         additionalProperties: false,
         type: 'object',
       },
-    ],
+      uniqueItems: true,
+      type: 'array',
+    },
+    messages: {
+      missedSpacingBetweenExports: reportErrors.MISSED_SPACING_ERROR,
+      extraSpacingBetweenExports: reportErrors.EXTRA_SPACING_ERROR,
+      unexpectedExportsGroupOrder: reportErrors.GROUP_ORDER_ERROR,
+      unexpectedExportsOrder: reportErrors.ORDER_ERROR,
+    },
     docs: {
       url: 'https://perfectionist.dev/rules/sort-exports',
       description: 'Enforce sorted exports.',
       recommended: true,
     },
-    messages: {
-      unexpectedExportsOrder: reportErrors.ORDER_ERROR,
-    },
     type: 'suggestion',
     fixable: 'code',
   },

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

@@ -8,10 +8,10 @@ const reportErrors = require('../utils/report-errors.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 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 useGroups = require('../utils/use-groups.js')
 const complete = require('../utils/complete.js')
 let defaultOptions = {
   fallbackSort: { type: 'unsorted' },
@@ -83,8 +83,11 @@ let sortHeritageClauses$1 = (context, options, heritageClauses) => {
   })
   let nodes = heritageClauses.map(heritageClause => {
     let name = getHeritageClauseExpressionName(heritageClause.expression)
-    let { setCustomGroups, getGroup } = useGroups.useGroups(options)
-    setCustomGroups(options.customGroups, name)
+    let group = computeGroup.computeGroup({
+      predefinedGroups: [],
+      options,
+      name,
+    })
     return {
       isEslintDisabled: isNodeEslintDisabled.isNodeEslintDisabled(
         heritageClause,
@@ -92,7 +95,7 @@ let sortHeritageClauses$1 = (context, options, heritageClauses) => {
       ),
       size: rangeToDiff.rangeToDiff(heritageClause, sourceCode),
       node: heritageClause,
-      group: getGroup(),
+      group,
       name,
     }
   })