eslint-plugin-perfectionist 3.8.0 → 3.9.0

package/dist/index.d.ts

@@ -12,6 +12,7 @@ declare type AccessorPropertySelector = 'accessor-property'
 
 declare type AdvancedSingleCustomGroup<T extends Selector> = {
   decoratorNamePattern?: string
+  elementValuePattern?: string
   elementNamePattern?: string
 } & BaseSingleCustomGroup<T>
 
@@ -114,6 +115,7 @@ declare const _default: {
         Partial<{
           type: 'alphabetical' | 'line-length' | 'natural'
           partitionByComment: string[] | boolean | string
+          specialCharacters: 'remove' | 'trim' | 'keep'
           matcher: 'minimatch' | 'regex'
           partitionByNewLine: boolean
           order: 'desc' | 'asc'
@@ -130,6 +132,7 @@ declare const _default: {
         Partial<{
           type: 'alphabetical' | 'line-length' | 'natural'
           partitionByComment: string[] | boolean | string
+          specialCharacters: 'remove' | 'trim' | 'keep'
           matcher: 'minimatch' | 'regex'
           groups: (
             | (
@@ -180,6 +183,7 @@ declare const _default: {
             [x: string]: string | string[]
           }
           type: 'alphabetical' | 'line-length' | 'natural'
+          specialCharacters: 'remove' | 'trim' | 'keep'
           groups: (string | string[])[]
           matcher: 'minimatch' | 'regex'
           order: 'desc' | 'asc'
@@ -197,6 +201,7 @@ declare const _default: {
             [x: string]: string | string[]
           }
           type: 'alphabetical' | 'line-length' | 'natural'
+          specialCharacters: 'remove' | 'trim' | 'keep'
           groups: (string | string[])[]
           matcher: 'minimatch' | 'regex'
           order: 'desc' | 'asc'
@@ -214,6 +219,7 @@ declare const _default: {
             [x: string]: string | string[]
           }
           type: 'alphabetical' | 'line-length' | 'natural'
+          specialCharacters: 'remove' | 'trim' | 'keep'
           groups: (string | string[])[]
           matcher: 'minimatch' | 'regex'
           order: 'desc' | 'asc'
@@ -236,6 +242,7 @@ declare const _default: {
           groupKind: 'values-first' | 'types-first' | 'mixed'
           type: 'alphabetical' | 'line-length' | 'natural'
           partitionByComment: string[] | boolean | string
+          specialCharacters: 'remove' | 'trim' | 'keep'
           matcher: 'minimatch' | 'regex'
           partitionByNewLine: boolean
           order: 'desc' | 'asc'
@@ -253,6 +260,7 @@ declare const _default: {
           groupKind: 'values-first' | 'types-first' | 'mixed'
           type: 'alphabetical' | 'line-length' | 'natural'
           partitionByComment: string[] | boolean | string
+          specialCharacters: 'remove' | 'trim' | 'keep'
           matcher: 'minimatch' | 'regex'
           partitionByNewLine: boolean
           order: 'desc' | 'asc'
@@ -272,6 +280,7 @@ declare const _default: {
           }
           type: 'alphabetical' | 'line-length' | 'natural'
           partitionByComment: string[] | boolean | string
+          specialCharacters: 'remove' | 'trim' | 'keep'
           groups: (string | string[])[]
           matcher: 'minimatch' | 'regex'
           partitionByNewLine: boolean
@@ -288,6 +297,7 @@ declare const _default: {
         Partial<{
           type: 'alphabetical' | 'line-length' | 'natural'
           partitionByComment: string[] | boolean | string
+          specialCharacters: 'remove' | 'trim' | 'keep'
           matcher: 'minimatch' | 'regex'
           groups: (
             | (
@@ -334,6 +344,7 @@ declare const _default: {
       [
         Partial<{
           type: 'alphabetical' | 'line-length' | 'natural'
+          specialCharacters: 'remove' | 'trim' | 'keep'
           order: 'desc' | 'asc'
           ignoreCase: boolean
         }>,
@@ -352,6 +363,7 @@ declare const _default: {
           }
           type: 'alphabetical' | 'line-length' | 'natural'
           partitionByComment: string[] | boolean | string
+          specialCharacters: 'remove' | 'trim' | 'keep'
           groups: (string | string[])[]
           matcher: 'minimatch' | 'regex'
           partitionByNewLine: boolean
@@ -371,6 +383,7 @@ declare const _default: {
             [x: string]: string | string[]
           }
           type: 'alphabetical' | 'line-length' | 'natural'
+          specialCharacters: 'remove' | 'trim' | 'keep'
           groups: (string | string[])[]
           matcher: 'minimatch' | 'regex'
           ignorePattern: string[]
@@ -390,36 +403,8 @@ declare const _default: {
       RuleListener
     >
     'sort-imports': RuleModule<
-      | 'missedSpacingBetweenImports'
-      | 'unexpectedImportsGroupOrder'
-      | 'extraSpacingBetweenImports'
-      | 'unexpectedImportsOrder',
-      [
-        Partial<{
-          customGroups: {
-            value?:
-              | {
-                  [x: string]: string | string[]
-                }
-              | undefined
-            type?:
-              | {
-                  [x: string]: string | string[]
-                }
-              | undefined
-          }
-          type: 'alphabetical' | 'line-length' | 'natural'
-          newlinesBetween: 'ignore' | 'always' | 'never'
-          groups: (string | string[])[]
-          matcher: 'minimatch' | 'regex'
-          environment: 'node' | 'bun'
-          internalPattern: string[]
-          sortSideEffects: boolean
-          maxLineLength?: number
-          order: 'desc' | 'asc'
-          ignoreCase: boolean
-        }>,
-      ],
+      MESSAGE_ID,
+      Options_2<string[]>,
       unknown,
       RuleListener
     >
@@ -430,6 +415,7 @@ declare const _default: {
           groupKind: 'values-first' | 'types-first' | 'mixed'
           type: 'alphabetical' | 'line-length' | 'natural'
           partitionByComment: string[] | boolean | string
+          specialCharacters: 'remove' | 'trim' | 'keep'
           matcher: 'minimatch' | 'regex'
           partitionByNewLine: boolean
           order: 'desc' | 'asc'
@@ -450,6 +436,7 @@ declare const _default: {
           }
           type: 'alphabetical' | 'line-length' | 'natural'
           partitionByComment: string[] | boolean | string
+          specialCharacters: 'remove' | 'trim' | 'keep'
           matcher: 'minimatch' | 'regex'
           groups: (string[] | string)[]
           partitionByNewLine: boolean
@@ -465,7 +452,7 @@ declare const _default: {
     >
     'sort-enums': RuleModule<
       'unexpectedEnumsDependencyOrder' | 'unexpectedEnumsOrder',
-      Options_2,
+      Options_3,
       unknown,
       RuleListener
     >
@@ -481,6 +468,7 @@ declare const _default: {
         Partial<{
           type: 'alphabetical' | 'line-length' | 'natural'
           partitionByComment: string[] | boolean | string
+          specialCharacters: 'remove' | 'trim' | 'keep'
           matcher: 'minimatch' | 'regex'
           partitionByNewLine: boolean
           order: 'desc' | 'asc'
@@ -527,11 +515,38 @@ declare type Group =
   | 'unknown'
   | string
 
+declare type Group_2<T extends string[]> =
+  | 'side-effect-style'
+  | 'external-type'
+  | 'internal-type'
+  | 'builtin-type'
+  | 'sibling-type'
+  | 'parent-type'
+  | 'side-effect'
+  | 'index-type'
+  | 'internal'
+  | 'external'
+  | T[number]
+  | 'sibling'
+  | 'unknown'
+  | 'builtin'
+  | 'parent'
+  | 'object'
+  | 'index'
+  | 'style'
+  | 'type'
+
 declare type IndexSignatureGroup =
   `${StaticModifierPrefix}${ReadonlyModifierPrefix}${IndexSignatureSelector}`
 
 declare type IndexSignatureSelector = 'index-signature'
 
+declare type MESSAGE_ID =
+  | 'missedSpacingBetweenImports'
+  | 'unexpectedImportsGroupOrder'
+  | 'extraSpacingBetweenImports'
+  | 'unexpectedImportsOrder'
+
 declare type MethodGroup =
   `${PublicOrProtectedOrPrivateModifierPrefix}${StaticOrAbstractModifierPrefix}${OverrideModifierPrefix}${DecoratedModifierPrefix}${OptionalModifierPrefix}${MethodSelector}`
 
@@ -549,6 +564,7 @@ declare type Options = [
     groupKind: 'literals-first' | 'spreads-first' | 'mixed'
     type: 'alphabetical' | 'line-length' | 'natural'
     partitionByComment: string[] | boolean | string
+    specialCharacters: 'remove' | 'trim' | 'keep'
     matcher: 'minimatch' | 'regex'
     partitionByNewLine: boolean
     order: 'desc' | 'asc'
@@ -556,10 +572,35 @@ declare type Options = [
   }>,
 ]
 
-declare type Options_2 = [
+declare type Options_2<T extends string[]> = [
+  Partial<{
+    customGroups: {
+      value?: {
+        [key in T[number]]: string[] | string
+      }
+      type?: {
+        [key in T[number]]: string[] | string
+      }
+    }
+    type: 'alphabetical' | 'line-length' | 'natural'
+    newlinesBetween: 'ignore' | 'always' | 'never'
+    specialCharacters: 'remove' | 'trim' | 'keep'
+    groups: (Group_2<T>[] | Group_2<T>)[]
+    matcher: 'minimatch' | 'regex'
+    environment: 'node' | 'bun'
+    internalPattern: string[]
+    sortSideEffects: boolean
+    maxLineLength?: number
+    order: 'desc' | 'asc'
+    ignoreCase: boolean
+  }>,
+]
+
+declare type Options_3 = [
   Partial<{
     type: 'alphabetical' | 'line-length' | 'natural'
     partitionByComment: string[] | boolean | string
+    specialCharacters: 'remove' | 'trim' | 'keep'
     matcher: 'minimatch' | 'regex'
     partitionByNewLine: boolean
     forceNumericSort: boolean
@@ -627,6 +668,7 @@ declare type SortClassesOptions = [
       | CustomGroup[]
     type: 'alphabetical' | 'line-length' | 'natural'
     partitionByComment: string[] | boolean | string
+    specialCharacters: 'remove' | 'trim' | 'keep'
     matcher: 'minimatch' | 'regex'
     groups: (Group[] | Group)[]
     order: 'desc' | 'asc'

package/dist/index.js

@@ -47,10 +47,13 @@ let plugin = {
 }
 let getRules = options =>
   Object.fromEntries(
-    Object.keys(plugin.rules).map(rule => [
-      `${name}/${rule}`,
-      ['error', options],
-    ]),
+    Object.entries(plugin.rules).reduce(
+      (accumulator, [ruleName, ruleValue]) =>
+        ruleValue.meta.deprecated
+          ? accumulator
+          : [...accumulator, [`${name}/${ruleName}`, ['error', options]]],
+      [],
+    ),
   )
 let createConfig = options => ({
   plugins: {

package/dist/index.mjs

@@ -46,10 +46,13 @@ let plugin = {
 }
 let getRules = options =>
   Object.fromEntries(
-    Object.keys(plugin.rules).map(rule => [
-      `${name}/${rule}`,
-      ['error', options],
-    ]),
+    Object.entries(plugin.rules).reduce(
+      (accumulator, [ruleName, ruleValue]) =>
+        ruleValue.meta.deprecated
+          ? accumulator
+          : [...accumulator, [`${name}/${ruleName}`, ['error', options]]],
+      [],
+    ),
   )
 let createConfig = options => ({
   plugins: {

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

@@ -41,6 +41,12 @@ let jsonSchema = {
       description: 'Controls whether sorting should be case-sensitive or not.',
       type: 'boolean',
     },
+    specialCharacters: {
+      description:
+        'Controls how special characters should be handled before sorting.',
+      type: 'string',
+      enum: ['remove', 'trim', 'keep'],
+    },
     groupKind: {
       description: 'Specifies top-level groups.',
       enum: ['mixed', 'literals-first', 'spreads-first'],
@@ -91,6 +97,7 @@ const sortArrayIncludes = createEslintRule.createEslintRule({
       type: 'alphabetical',
       order: 'asc',
       ignoreCase: true,
+      specialCharacters: 'keep',
       matcher: 'minimatch',
       groupKind: 'literals-first',
       partitionByComment: false,
@@ -121,6 +128,7 @@ let sortArray = (context, messageId, elements) => {
       groupKind: 'literals-first',
       type: 'alphabetical',
       ignoreCase: true,
+      specialCharacters: 'keep',
       matcher: 'minimatch',
       order: 'asc',
       partitionByComment: false,

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

@@ -36,6 +36,12 @@ let jsonSchema = {
       description: 'Controls whether sorting should be case-sensitive or not.',
       type: 'boolean',
     },
+    specialCharacters: {
+      description:
+        'Controls how special characters should be handled before sorting.',
+      type: 'string',
+      enum: ['remove', 'trim', 'keep'],
+    },
     groupKind: {
       description: 'Specifies top-level groups.',
       enum: ['mixed', 'literals-first', 'spreads-first'],
@@ -86,6 +92,7 @@ const sortArrayIncludes = createEslintRule({
       type: 'alphabetical',
       order: 'asc',
       ignoreCase: true,
+      specialCharacters: 'keep',
       matcher: 'minimatch',
       groupKind: 'literals-first',
       partitionByComment: false,
@@ -116,6 +123,7 @@ let sortArray = (context, messageId, elements) => {
       groupKind: 'literals-first',
       type: 'alphabetical',
       ignoreCase: true,
+      specialCharacters: 'keep',
       matcher: 'minimatch',
       order: 'asc',
       partitionByComment: false,

package/dist/rules/sort-astro-attributes.js

@@ -19,6 +19,8 @@ const sortAstroAttributes = createEslintRule.createEslintRule({
       description: 'Enforce sorted Astro attributes.',
     },
     fixable: 'code',
+    deprecated: true,
+    replacedBy: ['astro/sort-attributes'],
     schema: [
       {
         type: 'object',
@@ -44,6 +46,12 @@ const sortAstroAttributes = createEslintRule.createEslintRule({
               'Controls whether sorting should be case-sensitive or not.',
             type: 'boolean',
           },
+          specialCharacters: {
+            description:
+              'Controls how special characters should be handled before sorting.',
+            type: 'string',
+            enum: ['remove', 'trim', 'keep'],
+          },
           groups: {
             description: 'Specifies the order of the groups.',
             type: 'array',
@@ -94,6 +102,7 @@ const sortAstroAttributes = createEslintRule.createEslintRule({
       type: 'alphabetical',
       order: 'asc',
       ignoreCase: true,
+      specialCharacters: 'keep',
       matcher: 'minimatch',
       groups: [],
       customGroups: {},
@@ -112,6 +121,7 @@ const sortAstroAttributes = createEslintRule.createEslintRule({
           let options = complete.complete(context.options.at(0), settings, {
             type: 'alphabetical',
             ignoreCase: true,
+            specialCharacters: 'keep',
             matcher: 'minimatch',
             customGroups: {},
             order: 'asc',

package/dist/rules/sort-astro-attributes.mjs

@@ -18,6 +18,8 @@ const sortAstroAttributes = createEslintRule({
       description: 'Enforce sorted Astro attributes.',
     },
     fixable: 'code',
+    deprecated: true,
+    replacedBy: ['astro/sort-attributes'],
     schema: [
       {
         type: 'object',
@@ -43,6 +45,12 @@ const sortAstroAttributes = createEslintRule({
               'Controls whether sorting should be case-sensitive or not.',
             type: 'boolean',
           },
+          specialCharacters: {
+            description:
+              'Controls how special characters should be handled before sorting.',
+            type: 'string',
+            enum: ['remove', 'trim', 'keep'],
+          },
           groups: {
             description: 'Specifies the order of the groups.',
             type: 'array',
@@ -93,6 +101,7 @@ const sortAstroAttributes = createEslintRule({
       type: 'alphabetical',
       order: 'asc',
       ignoreCase: true,
+      specialCharacters: 'keep',
       matcher: 'minimatch',
       groups: [],
       customGroups: {},
@@ -111,6 +120,7 @@ const sortAstroAttributes = createEslintRule({
           let options = complete(context.options.at(0), settings, {
             type: 'alphabetical',
             ignoreCase: true,
+            specialCharacters: 'keep',
             matcher: 'minimatch',
             customGroups: {},
             order: 'asc',

package/dist/rules/sort-classes-utils.js

@@ -1,5 +1,7 @@
 'use strict'
 Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' })
+const validateGroupsConfiguration$1 = require('../utils/validate-groups-configuration.js')
+const sortClasses_types = require('./sort-classes.types.js')
 const matches = require('../utils/matches.js')
 const cachedGroupsByModifiersAndSelectors = /* @__PURE__ */ new Map()
 const generateOfficialGroups = (modifiers, selectors) => {
@@ -128,6 +130,19 @@ const customGroupMatches = props => {
       return false
     }
   }
+  if (
+    'elementValuePattern' in props.customGroup &&
+    props.customGroup.elementValuePattern
+  ) {
+    let matchesElementValuePattern = matches.matches(
+      props.elementValue ?? '',
+      props.customGroup.elementValuePattern,
+      props.matcher,
+    )
+    if (!matchesElementValuePattern) {
+      return false
+    }
+  }
   if (
     'decoratorNamePattern' in props.customGroup &&
     props.customGroup.decoratorNamePattern
@@ -157,10 +172,53 @@ const getCompareOptions = (options, groupNumber) => {
       customGroup && 'order' in customGroup && customGroup.order
         ? customGroup.order
         : options.order,
+    specialCharacters: options.specialCharacters,
     ignoreCase: options.ignoreCase,
   }
 }
+let validateGroupsConfiguration = (groups, customGroups) => {
+  let availableCustomGroupNames = Array.isArray(customGroups)
+    ? customGroups.map(customGroup => customGroup.groupName)
+    : Object.keys(customGroups)
+  let invalidGroups = groups
+    .flat()
+    .filter(
+      group =>
+        !isPredefinedGroup(group) && !availableCustomGroupNames.includes(group),
+    )
+  if (invalidGroups.length) {
+    throw new Error('Invalid group(s): ' + invalidGroups.join(', '))
+  }
+  validateGroupsConfiguration$1.validateNoDuplicatedGroups(groups)
+}
+const isPredefinedGroup = input => {
+  if (input === 'unknown') {
+    return true
+  }
+  let singleWordSelector = input.split('-').at(-1)
+  if (!singleWordSelector) {
+    return false
+  }
+  let twoWordsSelector = input.split('-').slice(-2).join('-')
+  let isTwoWordSelectorValid =
+    sortClasses_types.allSelectors.includes(twoWordsSelector)
+  if (
+    !sortClasses_types.allSelectors.includes(singleWordSelector) &&
+    !isTwoWordSelectorValid
+  ) {
+    return false
+  }
+  let modifiers = input.split('-').slice(0, isTwoWordSelectorValid ? -2 : -1)
+  return (
+    new Set(modifiers).size === modifiers.length &&
+    modifiers.every(modifier =>
+      sortClasses_types.allModifiers.includes(modifier),
+    )
+  )
+}
 exports.customGroupMatches = customGroupMatches
 exports.generateOfficialGroups = generateOfficialGroups
+exports.getCombinations = getCombinations
 exports.getCompareOptions = getCompareOptions
 exports.getOverloadSignatureGroups = getOverloadSignatureGroups
+exports.validateGroupsConfiguration = validateGroupsConfiguration

package/dist/rules/sort-classes-utils.mjs

@@ -1,3 +1,5 @@
+import { validateNoDuplicatedGroups } from '../utils/validate-groups-configuration.mjs'
+import { allSelectors, allModifiers } from './sort-classes.types.mjs'
 import { matches } from '../utils/matches.mjs'
 const cachedGroupsByModifiersAndSelectors = /* @__PURE__ */ new Map()
 const generateOfficialGroups = (modifiers, selectors) => {
@@ -126,6 +128,19 @@ const customGroupMatches = props => {
       return false
     }
   }
+  if (
+    'elementValuePattern' in props.customGroup &&
+    props.customGroup.elementValuePattern
+  ) {
+    let matchesElementValuePattern = matches(
+      props.elementValue ?? '',
+      props.customGroup.elementValuePattern,
+      props.matcher,
+    )
+    if (!matchesElementValuePattern) {
+      return false
+    }
+  }
   if (
     'decoratorNamePattern' in props.customGroup &&
     props.customGroup.decoratorNamePattern
@@ -155,12 +170,49 @@ const getCompareOptions = (options, groupNumber) => {
       customGroup && 'order' in customGroup && customGroup.order
         ? customGroup.order
         : options.order,
+    specialCharacters: options.specialCharacters,
     ignoreCase: options.ignoreCase,
   }
 }
+let validateGroupsConfiguration = (groups, customGroups) => {
+  let availableCustomGroupNames = Array.isArray(customGroups)
+    ? customGroups.map(customGroup => customGroup.groupName)
+    : Object.keys(customGroups)
+  let invalidGroups = groups
+    .flat()
+    .filter(
+      group =>
+        !isPredefinedGroup(group) && !availableCustomGroupNames.includes(group),
+    )
+  if (invalidGroups.length) {
+    throw new Error('Invalid group(s): ' + invalidGroups.join(', '))
+  }
+  validateNoDuplicatedGroups(groups)
+}
+const isPredefinedGroup = input => {
+  if (input === 'unknown') {
+    return true
+  }
+  let singleWordSelector = input.split('-').at(-1)
+  if (!singleWordSelector) {
+    return false
+  }
+  let twoWordsSelector = input.split('-').slice(-2).join('-')
+  let isTwoWordSelectorValid = allSelectors.includes(twoWordsSelector)
+  if (!allSelectors.includes(singleWordSelector) && !isTwoWordSelectorValid) {
+    return false
+  }
+  let modifiers = input.split('-').slice(0, isTwoWordSelectorValid ? -2 : -1)
+  return (
+    new Set(modifiers).size === modifiers.length &&
+    modifiers.every(modifier => allModifiers.includes(modifier))
+  )
+}
 export {
   customGroupMatches,
   generateOfficialGroups,
+  getCombinations,
   getCompareOptions,
   getOverloadSignatureGroups,
+  validateGroupsConfiguration,
 }