eslint-plugin-perfectionist 4.12.3 → 4.14.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.3'
+const version = '4.14.0'
 exports.name = name
 exports.version = version

package/dist/rules/sort-classes.js

@@ -18,7 +18,7 @@ const createEslintRule = require('../utils/create-eslint-rule.js')
 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 getGroupIndex = require('../utils/get-group-index.js')
 const computeGroup = require('../utils/compute-group.js')
 const rangeToDiff = require('../utils/range-to-diff.js')
 const getSettings = require('../utils/get-settings.js')
@@ -474,7 +474,7 @@ const sortClasses = createEslintRule.createEslintRule({
         let nodesSortedByGroups = formattedNodes.flatMap(nodes2 =>
           sortNodesByGroups.sortNodesByGroups({
             isNodeIgnored: sortingNode =>
-              getGroupNumber.getGroupNumber(options.groups, sortingNode) ===
+              getGroupIndex.getGroupIndex(options.groups, sortingNode) ===
               options.groups.length,
             getOptionsByGroupNumber:
               getCustomGroupsCompareOptions.buildGetCustomGroupOverriddenOptionsFunction(

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-exports.js

@@ -142,6 +142,7 @@ const sortExports = createEslintRule.createEslintRule({
               missedSpacingBetweenMembers: 'missedSpacingBetweenExports',
               extraSpacingBetweenMembers: 'extraSpacingBetweenExports',
               unexpectedGroupOrder: 'unexpectedExportsGroupOrder',
+              missedCommentAbove: 'missedCommentAboveExport',
               unexpectedOrder: 'unexpectedExportsOrder',
             },
             sortNodesExcludingEslintDisabled,
@@ -185,6 +186,7 @@ const sortExports = createEslintRule.createEslintRule({
       type: 'array',
     },
     messages: {
+      missedCommentAboveExport: reportErrors.MISSED_COMMENT_ABOVE_ERROR,
       missedSpacingBetweenExports: reportErrors.MISSED_SPACING_ERROR,
       extraSpacingBetweenExports: reportErrors.EXTRA_SPACING_ERROR,
       unexpectedExportsGroupOrder: reportErrors.GROUP_ORDER_ERROR,

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/compute-common-selectors.js

@@ -65,12 +65,22 @@ let builtinPrefixOnlyModules = /* @__PURE__ */ new Set([
   'node:sea',
 ])
 let isCoreModule = (value, environment) => {
-  let valueToCheck = value.startsWith('node:') ? value.split('node:')[1] : value
-  return (
-    (!!valueToCheck && nodeBuiltinModules.has(valueToCheck)) ||
+  let clean = string_ => string_.replace(/^(?:node:){1,2}/u, '')
+  let [basePath] = value.split('/')
+  let cleanValue = clean(value)
+  let cleanBase = clean(basePath)
+  if (nodeBuiltinModules.has(cleanValue) || nodeBuiltinModules.has(cleanBase)) {
+    return true
+  }
+  if (
     builtinPrefixOnlyModules.has(value) ||
-    (environment === 'bun' ? bunModules.has(value) : false)
-  )
+    builtinPrefixOnlyModules.has(`node:${cleanValue}`) ||
+    builtinPrefixOnlyModules.has(basePath) ||
+    builtinPrefixOnlyModules.has(`node:${cleanBase}`)
+  ) {
+    return true
+  }
+  return environment === 'bun' && bunModules.has(value)
 }
 let isParent = value => value.startsWith('..')
 let isSibling = value => value.startsWith('./')

package/dist/rules/sort-imports/is-side-effect-only-group.js

@@ -1,8 +1,12 @@
 'use strict'
 Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' })
 const isNewlinesBetweenOption = require('../../utils/is-newlines-between-option.js')
+const isCommentAboveOption = require('../../utils/is-comment-above-option.js')
 let isSideEffectOnlyGroup = group => {
-  if (isNewlinesBetweenOption.isNewlinesBetweenOption(group)) {
+  if (
+    isNewlinesBetweenOption.isNewlinesBetweenOption(group) ||
+    isCommentAboveOption.isCommentAboveOption(group)
+  ) {
     return false
   }
   if (typeof group === 'string') {

package/dist/rules/sort-imports/read-closest-ts-config-by-path.js

@@ -29,15 +29,20 @@ const path__namespace = /* @__PURE__ */ _interopNamespaceDefault(path)
 const fs__namespace = /* @__PURE__ */ _interopNamespaceDefault(fs)
 let directoryCacheByPath = /* @__PURE__ */ new Map()
 let contentCacheByPath = /* @__PURE__ */ new Map()
-let readClosestTsConfigByPath = input => {
+let readClosestTsConfigByPath = ({
+  tsconfigFilename,
+  tsconfigRootDir,
+  contextCwd,
+  filePath,
+}) => {
   let typescriptImport = getTypescriptImport.getTypescriptImport()
   if (!typescriptImport) {
     return null
   }
-  let directory = path__namespace.dirname(input.filePath)
+  let directory = path__namespace.dirname(filePath)
   let checkedDirectories = [directory]
   do {
-    let tsconfigPath = path__namespace.join(directory, 'tsconfig.json')
+    let tsconfigPath = path__namespace.join(directory, tsconfigFilename)
     let cachedDirectory = directoryCacheByPath.get(directory)
     if (!cachedDirectory && fs__namespace.existsSync(tsconfigPath)) {
       cachedDirectory = tsconfigPath
@@ -46,20 +51,13 @@ let readClosestTsConfigByPath = input => {
       for (let checkedDirectory of checkedDirectories) {
         directoryCacheByPath.set(checkedDirectory, cachedDirectory)
       }
-      return getCompilerOptions(
-        typescriptImport,
-        input.contextCwd,
-        cachedDirectory,
-      )
+      return getCompilerOptions(typescriptImport, contextCwd, cachedDirectory)
     }
     directory = path__namespace.dirname(directory)
     checkedDirectories.push(directory)
-  } while (
-    directory.length > 1 &&
-    directory.length >= input.tsconfigRootDir.length
-  )
+  } while (directory.length > 1 && directory.length >= tsconfigRootDir.length)
   throw new Error(
-    `Couldn't find any tsconfig.json relative to '${input.filePath}' within '${input.tsconfigRootDir}'.`,
+    `Couldn't find any ${tsconfigFilename} relative to '${filePath}' within '${tsconfigRootDir}'.`,
   )
 }
 let getCompilerOptions = (typescriptImport, contextCwd, filePath) => {

package/dist/rules/sort-imports.js

@@ -26,38 +26,39 @@ const getSettings = require('../utils/get-settings.js')
 const isSortable = require('../utils/is-sortable.js')
 const complete = require('../utils/complete.js')
 let cachedGroupsByModifiersAndSelectors = /* @__PURE__ */ new Map()
-let defaultGroups = [
-  'type-import',
-  ['value-builtin', 'value-external'],
-  'type-internal',
-  'value-internal',
-  ['type-parent', 'type-sibling', 'type-index'],
-  ['value-parent', 'value-sibling', 'value-index'],
-  'ts-equals-import',
-  'unknown',
-]
+let defaultOptions = {
+  groups: [
+    'type-import',
+    ['value-builtin', 'value-external'],
+    'type-internal',
+    'value-internal',
+    ['type-parent', 'type-sibling', 'type-index'],
+    ['value-parent', 'value-sibling', 'value-index'],
+    'ts-equals-import',
+    'unknown',
+  ],
+  internalPattern: ['^~/.+', '^@/.+'],
+  fallbackSort: { type: 'unsorted' },
+  partitionByComment: false,
+  partitionByNewLine: false,
+  newlinesBetween: 'always',
+  specialCharacters: 'keep',
+  sortSideEffects: false,
+  type: 'alphabetical',
+  environment: 'node',
+  customGroups: [],
+  ignoreCase: true,
+  locales: 'en-US',
+  alphabet: '',
+  order: 'asc',
+}
 const sortImports = createEslintRule.createEslintRule({
   create: context => {
+    var _a, _b
     let settings = getSettings.getSettings(context.settings)
     let userOptions = context.options.at(0)
     let options = getOptionsWithCleanGroups.getOptionsWithCleanGroups(
-      complete.complete(userOptions, settings, {
-        fallbackSort: { type: 'unsorted' },
-        internalPattern: ['^~/.+'],
-        partitionByComment: false,
-        partitionByNewLine: false,
-        newlinesBetween: 'always',
-        specialCharacters: 'keep',
-        sortSideEffects: false,
-        groups: defaultGroups,
-        type: 'alphabetical',
-        environment: 'node',
-        customGroups: [],
-        ignoreCase: true,
-        locales: 'en-US',
-        alphabet: '',
-        order: 'asc',
-      }),
+      complete.complete(userOptions, settings, defaultOptions),
     )
     validateGeneratedGroupsConfiguration.validateGeneratedGroupsConfiguration({
       options: {
@@ -77,9 +78,15 @@ const sortImports = createEslintRule.createEslintRule({
       options,
     )
     validateSideEffectsConfiguration.validateSideEffectsConfiguration(options)
-    let tsConfigOutput = options.tsconfigRootDir
+    let tsconfigRootDirectory =
+      ((_a = options.tsconfig) == null ? void 0 : _a.rootDir) ??
+      options.tsconfigRootDir
+    let tsConfigOutput = tsconfigRootDirectory
       ? readClosestTsConfigByPath.readClosestTsConfigByPath({
-          tsconfigRootDir: options.tsconfigRootDir,
+          tsconfigFilename:
+            ((_b = options.tsconfig) == null ? void 0 : _b.filename) ??
+            'tsconfig.json',
+          tsconfigRootDir: tsconfigRootDirectory,
           filePath: context.physicalFilename,
           contextCwd: context.cwd,
         })
@@ -306,6 +313,7 @@ const sortImports = createEslintRule.createEslintRule({
               missedSpacingBetweenMembers: 'missedSpacingBetweenImports',
               extraSpacingBetweenMembers: 'extraSpacingBetweenImports',
               unexpectedGroupOrder: 'unexpectedImportsGroupOrder',
+              missedCommentAbove: 'missedCommentAboveImport',
               unexpectedOrder: 'unexpectedImportsOrder',
             },
             options: {
@@ -322,15 +330,15 @@ const sortImports = createEslintRule.createEslintRule({
         }
       },
       VariableDeclaration: node => {
-        var _a
+        var _a2
         if (
           node.declarations[0].init &&
           node.declarations[0].init.type === 'CallExpression' &&
           node.declarations[0].init.callee.type === 'Identifier' &&
           node.declarations[0].init.callee.name === 'require' &&
-          ((_a = node.declarations[0].init.arguments[0]) == null
+          ((_a2 = node.declarations[0].init.arguments[0]) == null
             ? void 0
-            : _a.type) === 'Literal'
+            : _a2.type) === 'Literal'
         ) {
           registerNode(node)
         }
@@ -349,12 +357,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.',
@@ -366,6 +374,21 @@ const sortImports = createEslintRule.createEslintRule({
               }),
             ],
           },
+          tsconfig: {
+            properties: {
+              rootDir: {
+                description: 'Specifies the tsConfig root directory.',
+                type: 'string',
+              },
+              filename: {
+                description: 'Specifies the tsConfig filename.',
+                type: 'string',
+              },
+            },
+            additionalProperties: false,
+            required: ['rootDir'],
+            type: 'object',
+          },
           maxLineLength: {
             description: 'Specifies the maximum line length.',
             exclusiveMinimum: true,
@@ -392,46 +415,15 @@ 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',
     },
     messages: {
       unexpectedImportsDependencyOrder: reportErrors.DEPENDENCY_ORDER_ERROR,
+      missedCommentAboveImport: reportErrors.MISSED_COMMENT_ABOVE_ERROR,
       missedSpacingBetweenImports: reportErrors.MISSED_SPACING_ERROR,
       extraSpacingBetweenImports: reportErrors.EXTRA_SPACING_ERROR,
       unexpectedImportsGroupOrder: reportErrors.GROUP_ORDER_ERROR,
@@ -445,24 +437,7 @@ const sortImports = createEslintRule.createEslintRule({
     type: 'suggestion',
     fixable: 'code',
   },
-  defaultOptions: [
-    {
-      customGroups: { value: {}, type: {} },
-      internalPattern: ['^~/.+'],
-      partitionByComment: false,
-      partitionByNewLine: false,
-      specialCharacters: 'keep',
-      newlinesBetween: 'always',
-      sortSideEffects: false,
-      groups: defaultGroups,
-      type: 'alphabetical',
-      environment: 'node',
-      ignoreCase: true,
-      locales: 'en-US',
-      alphabet: '',
-      order: 'asc',
-    },
-  ],
+  defaultOptions: [defaultOptions],
   name: 'sort-imports',
 })
 let hasContentBetweenNodes = (sourceCode, left, right) =>

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-modules.js

@@ -18,8 +18,8 @@ const createEslintRule = require('../utils/create-eslint-rule.js')
 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 getEnumMembers = require('../utils/get-enum-members.js')
+const getGroupIndex = require('../utils/get-group-index.js')
 const computeGroup = require('../utils/compute-group.js')
 const rangeToDiff = require('../utils/range-to-diff.js')
 const getSettings = require('../utils/get-settings.js')
@@ -284,7 +284,7 @@ let analyzeModule = ({
     let nodesSortedByGroups = formattedNodes.flatMap(nodes2 =>
       sortNodesByGroups.sortNodesByGroups({
         isNodeIgnored: sortingNode =>
-          getGroupNumber.getGroupNumber(options.groups, sortingNode) ===
+          getGroupIndex.getGroupIndex(options.groups, sortingNode) ===
           options.groups.length,
         getOptionsByGroupNumber:
           getCustomGroupsCompareOptions.buildGetCustomGroupOverriddenOptionsFunction(

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-switch-case.js

@@ -77,6 +77,9 @@ const sortSwitchCase = createEslintRule.createEslintRule({
           sortedCaseNameSortingNodes,
         )
         pairwise.pairwise(caseNodesSortingNodeGroup, (left, right) => {
+          if (!left) {
+            return
+          }
           let leftIndex = nodeIndexMap.get(left)
           let rightIndex = nodeIndexMap.get(right)
           if (leftIndex < rightIndex) {
@@ -198,6 +201,9 @@ const sortSwitchCase = createEslintRule.createEslintRule({
       let sortingNodeGroupsForBlockSortFlat =
         sortingNodeGroupsForBlockSort.flat()
       pairwise.pairwise(sortingNodeGroupsForBlockSortFlat, (left, right) => {
+        if (!left) {
+          return
+        }
         let indexOfLeft = sortedSortingNodeGroupsForBlockSort.indexOf(left)
         let indexOfRight = sortedSortingNodeGroupsForBlockSort.indexOf(right)
         if (indexOfLeft < indexOfRight) {
@@ -210,6 +216,7 @@ const sortSwitchCase = createEslintRule.createEslintRule({
               : makeFixes.makeFixes({
                   sortedNodes: sortedSortingNodeGroupsForBlockSort,
                   nodes: sortingNodeGroupsForBlockSortFlat,
+                  hasCommentAboveMissing: false,
                   sourceCode,
                   fixer,
                 }),

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