eslint-plugin-perfectionist 4.1.2 → 4.3.0

package/dist/alphabet.d.ts

@@ -0,0 +1,176 @@
+/**
+ * Utility class to build alphabets
+ */
+export declare class Alphabet {
+  private _characters
+  private constructor()
+  /**
+   * Generates an alphabet from the given characters.
+   * @param {string|string[]} values - The characters to generate the alphabet from
+   * @returns {Alphabet} - The wrapped alphabet
+   */
+  static generateFrom(values: string[] | string): Alphabet
+  /**
+   * Generates an alphabet containing relevant characters from the Unicode
+   * standard. Contains the Unicode planes 0 and 1.
+   * @returns {Alphabet} - The generated alphabet
+   */
+  static generateRecommendedAlphabet(): Alphabet
+  /**
+   * Generates an alphabet containing all characters from the Unicode standard
+   * except for irrelevant Unicode planes.
+   * Contains the Unicode planes 0, 1, 2 and 3.
+   * @returns {Alphabet} - The generated alphabet
+   */
+  static generateCompleteAlphabet(): Alphabet
+  private static _convertCodepointToCharacter
+  /**
+   * Generates an alphabet containing relevant characters from the Unicode
+   * standard.
+   * @param {number} maxCodePoint - The maximum code point to generate the
+   * alphabet to
+   * @returns {Alphabet} - The generated alphabet
+   */
+  private static _generateAlphabetToRange
+  /**
+   * For each character with a lower and upper case, permutes the two cases
+   * so that the alphabet is ordered by the case priority entered.
+   * @param {string} casePriority - The case to prioritize
+   * @returns {Alphabet} - The same alphabet instance with the cases prioritized
+   * @example
+   * Alphabet.generateFrom('aAbBcdCD')
+   * .prioritizeCase('uppercase')
+   * // Returns 'AaBbCDcd'
+   */
+  prioritizeCase(casePriority: 'lowercase' | 'uppercase'): this
+  /**
+   * Adds specific characters to the end of the alphabet.
+   * @param {string|string[]} values - The characters to push to the alphabet
+   * @returns {Alphabet} - The same alphabet instance without the specified
+   * characters
+   * @example
+   * Alphabet.generateFrom('ab')
+   * .pushCharacters('cd')
+   * // Returns 'abcd'
+   */
+  pushCharacters(values: string[] | string): this
+  /**
+   * Permutes characters with cases so that all characters with the entered case
+   * are put before the other characters.
+   * @param {string} caseToComeFirst - The case to put before the other
+   * characters
+   * @returns {Alphabet} - The same alphabet instance with all characters with
+   * case before all the characters with the other case
+   */
+  placeAllWithCaseBeforeAllWithOtherCase(
+    caseToComeFirst: 'uppercase' | 'lowercase',
+  ): this
+  /**
+   * Places a specific character right before another character in the alphabet.
+   * @param {object} params - The parameters for the operation
+   * @param {string} params.characterBefore - The character to come before
+   * characterAfter
+   * @param {string} params.characterAfter - The target character
+   * @returns {Alphabet} - The same alphabet instance with the specific
+   * character prioritized
+   * @example
+   * Alphabet.generateFrom('ab-cd/')
+   * .placeCharacterBefore({ characterBefore: '/', characterAfter: '-' })
+   * // Returns 'ab/-cd'
+   */
+  placeCharacterBefore({
+    characterBefore,
+    characterAfter,
+  }: {
+    characterBefore: string
+    characterAfter: string
+  }): this
+  /**
+   * Places a specific character right after another character in the alphabet.
+   * @param {object} params - The parameters for the operation
+   * @param {string} params.characterBefore - The target character
+   * @param {string} params.characterAfter - The character to come after
+   * characterBefore
+   * @returns {Alphabet} - The same alphabet instance with the specific
+   * character prioritized
+   * @example
+   * Alphabet.generateFrom('ab-cd/')
+   * .placeCharacterAfter({ characterBefore: '/', characterAfter: '-' })
+   * // Returns 'abcd/-'
+   */
+  placeCharacterAfter({
+    characterBefore,
+    characterAfter,
+  }: {
+    characterBefore: string
+    characterAfter: string
+  }): this
+  /**
+   * Removes specific characters from the alphabet by their range.
+   * @param {object} range - The Unicode range to remove characters from
+   * @param {number} range.start - The starting Unicode codepoint
+   * @param {number} range.end - The ending Unicode codepoint
+   * @returns {Alphabet} - The same alphabet instance without the characters
+   * from the specified range
+   */
+  removeUnicodeRange({ start, end }: { start: number; end: number }): this
+  /**
+   * Sorts the alphabet by the sorting function provided.
+   * @param {Function} sortingFunction - The sorting function to use
+   * @returns {Alphabet} - The same alphabet instance sorted by the sorting function provided
+   */
+  sortBy(
+    sortingFunction: (characterA: string, characterB: string) => number,
+  ): this
+  /**
+   * Removes specific characters from the alphabet.
+   * @param {string|string[]} values - The characters to remove from the
+   * alphabet
+   * @returns {Alphabet} - The same alphabet instance without the specified
+   * characters
+   * @example
+   * Alphabet.generateFrom('abcd')
+   * .removeCharacters('dcc')
+   * // Returns 'ab'
+   */
+  removeCharacters(values: string[] | string): this
+  /**
+   * Sorts the alphabet by the natural order of the characters using
+   * `natural-orderby`.
+   * @param {string} locale - The locale to use for sorting
+   * @returns {Alphabet} - The same alphabet instance sorted by the natural
+   * order of the characters
+   */
+  sortByNaturalSort(locale?: string): this
+  /**
+   * Sorts the alphabet by the character code point.
+   * @returns {Alphabet} - The same alphabet instance sorted by the character
+   * code point
+   */
+  sortByCharCodeAt(): this
+  /**
+   * Sorts the alphabet by the locale order of the characters.
+   * @param {Intl.LocalesArgument} locales - The locales to use for sorting
+   * @returns {Alphabet} - The same alphabet instance sorted by the locale
+   * order of the characters
+   */
+  sortByLocaleCompare(locales?: Intl.LocalesArgument): this
+  /**
+   * Retrieves the characters from the alphabet.
+   * @returns {string} The characters from the alphabet
+   */
+  getCharacters(): string
+  /**
+   * Reverses the alphabet.
+   * @returns {Alphabet} - The same alphabet instance reversed
+   * @example
+   * Alphabet.generateFrom('ab')
+   * .reverse()
+   * // Returns 'ba'
+   */
+  reverse(): this
+  private _placeCharacterBeforeOrAfter
+  private _getCharactersWithCase
+}
+
+export {}

package/dist/index.d.ts

@@ -30,9 +30,11 @@ declare interface PluginConfig {
     'recommended-alphabetical-legacy': Linter.LegacyConfig
     'recommended-line-length-legacy': Linter.LegacyConfig
     'recommended-natural-legacy': Linter.LegacyConfig
+    'recommended-custom-legacy': Linter.LegacyConfig
     'recommended-alphabetical': Linter.Config
     'recommended-line-length': Linter.Config
     'recommended-natural': Linter.Config
+    'recommended-custom': Linter.Config
   }
   name: string
 }

package/dist/index.js

@@ -28,7 +28,7 @@ let plugin = {
     'sort-array-includes': sortArrayIncludes.default,
     'sort-named-imports': sortNamedImports,
     'sort-named-exports': sortNamedExports,
-    'sort-object-types': sortObjectTypes,
+    'sort-object-types': sortObjectTypes.default,
     'sort-union-types': sortUnionTypes,
     'sort-switch-case': sortSwitchCase,
     'sort-decorators': sortDecorators,
@@ -77,6 +77,10 @@ const index = {
       type: 'natural',
       order: 'asc',
     }),
+    'recommended-custom-legacy': createLegacyConfig({
+      type: 'custom',
+      order: 'asc',
+    }),
     'recommended-alphabetical': createConfig({
       type: 'alphabetical',
       order: 'asc',
@@ -89,6 +93,10 @@ const index = {
       type: 'natural',
       order: 'asc',
     }),
+    'recommended-custom': createConfig({
+      type: 'custom',
+      order: 'asc',
+    }),
   },
 }
 module.exports = index

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

@@ -27,6 +27,7 @@ let defaultOptions = {
   type: 'alphabetical',
   ignoreCase: true,
   locales: 'en-US',
+  alphabet: '',
   order: 'asc',
 }
 let jsonSchema = {
@@ -48,6 +49,7 @@ let jsonSchema = {
     },
     specialCharacters: commonJsonSchemas.specialCharactersJsonSchema,
     ignoreCase: commonJsonSchemas.ignoreCaseJsonSchema,
+    alphabet: commonJsonSchemas.alphabetJsonSchema,
     locales: commonJsonSchemas.localesJsonSchema,
     order: commonJsonSchemas.orderJsonSchema,
     type: commonJsonSchemas.typeJsonSchema,
@@ -129,7 +131,10 @@ let sortArray = (context, messageId, elements) => {
         (options.partitionByComment &&
           isPartitionComment.hasPartitionComment(
             options.partitionByComment,
-            getCommentsBefore.getCommentsBefore(element, sourceCode),
+            getCommentsBefore.getCommentsBefore({
+              node: element,
+              sourceCode,
+            }),
           )) ||
         (options.partitionByNewLine &&
           lastSortingNode &&

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

@@ -89,28 +89,5 @@ let customGroupMatches = props => {
   }
   return true
 }
-let getCompareOptions = (options, groupNumber) => {
-  let group = options.groups[groupNumber]
-  let customGroup =
-    typeof group === 'string'
-      ? options.customGroups.find(
-          currentGroup => group === currentGroup.groupName,
-        )
-      : null
-  if ((customGroup == null ? void 0 : customGroup.type) === 'unsorted') {
-    return null
-  }
-  return {
-    order:
-      customGroup && 'order' in customGroup && customGroup.order
-        ? customGroup.order
-        : options.order,
-    specialCharacters: options.specialCharacters,
-    type: (customGroup == null ? void 0 : customGroup.type) ?? options.type,
-    ignoreCase: options.ignoreCase,
-    locales: options.locales,
-  }
-}
 exports.customGroupMatches = customGroupMatches
-exports.getCompareOptions = getCompareOptions
 exports.getOverloadSignatureGroups = getOverloadSignatureGroups

package/dist/rules/sort-classes.js

@@ -1,10 +1,12 @@
 'use strict'
 const commonJsonSchemas = require('../utils/common-json-schemas.js')
-const sortClasses_types = require('./sort-classes.types.js')
 const sortNodesByDependencies = require('../utils/sort-nodes-by-dependencies.js')
 const validateNewlinesAndPartitionConfiguration = require('../utils/validate-newlines-and-partition-configuration.js')
+const validateGeneratedGroupsConfiguration = require('../utils/validate-generated-groups-configuration.js')
+const sortClasses_types = require('./sort-classes.types.js')
+const validateCustomSortConfiguration = require('../utils/validate-custom-sort-configuration.js')
 const sortClassesUtils = require('./sort-classes-utils.js')
-const validateGeneratedGroupsConfiguration = require('./validate-generated-groups-configuration.js')
+const getCustomGroupsCompareOptions = require('../utils/get-custom-groups-compare-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')
@@ -61,6 +63,7 @@ let defaultOptions = {
   ignoreCase: true,
   customGroups: [],
   locales: 'en-US',
+  alphabet: '',
   order: 'asc',
 }
 const sortClasses = createEslintRule.createEslintRule({
@@ -76,6 +79,7 @@ const sortClasses = createEslintRule.createEslintRule({
         settings,
         defaultOptions,
       )
+      validateCustomSortConfiguration.validateCustomSortConfiguration(options)
       validateGeneratedGroupsConfiguration.validateGeneratedGroupsConfiguration(
         {
           customGroups: options.customGroups,
@@ -446,7 +450,6 @@ const sortClasses = createEslintRule.createEslintRule({
             dependencies,
             name,
           }
-          let comments = getCommentsBefore.getCommentsBefore(member, sourceCode)
           let lastMember =
             (_e = accumulator.at(-1)) == null ? void 0 : _e.at(-1)
           if (
@@ -460,7 +463,10 @@ const sortClasses = createEslintRule.createEslintRule({
             (options.partitionByComment &&
               isPartitionComment.hasPartitionComment(
                 options.partitionByComment,
-                comments,
+                getCommentsBefore.getCommentsBefore({
+                  node: member,
+                  sourceCode,
+                }),
               ))
           ) {
             accumulator.push([])
@@ -478,7 +484,10 @@ const sortClasses = createEslintRule.createEslintRule({
                 getGroupNumber.getGroupNumber(options.groups, sortingNode) ===
                 options.groups.length,
               getGroupCompareOptions: groupNumber =>
-                sortClassesUtils.getCompareOptions(options, groupNumber),
+                getCustomGroupsCompareOptions.getCustomGroupsCompareOptions(
+                  options,
+                  groupNumber,
+                ),
               ignoreEslintDisabledNodes,
             }),
           ),
@@ -567,44 +576,6 @@ const sortClasses = createEslintRule.createEslintRule({
     schema: [
       {
         properties: {
-          customGroups: {
-            items: {
-              oneOf: [
-                {
-                  properties: {
-                    ...sortClasses_types.customGroupNameJsonSchema,
-                    ...sortClasses_types.customGroupSortJsonSchema,
-                    anyOf: {
-                      items: {
-                        properties: {
-                          ...sortClasses_types.singleCustomGroupJsonSchema,
-                        },
-                        description: 'Custom group.',
-                        additionalProperties: false,
-                        type: 'object',
-                      },
-                      type: 'array',
-                    },
-                  },
-                  description: 'Custom group block.',
-                  additionalProperties: false,
-                  type: 'object',
-                },
-                {
-                  properties: {
-                    ...sortClasses_types.customGroupNameJsonSchema,
-                    ...sortClasses_types.customGroupSortJsonSchema,
-                    ...sortClasses_types.singleCustomGroupJsonSchema,
-                  },
-                  description: 'Custom group.',
-                  additionalProperties: false,
-                  type: 'object',
-                },
-              ],
-            },
-            description: 'Specifies custom groups.',
-            type: 'array',
-          },
           ignoreCallbackDependenciesPatterns: {
             description:
               'Patterns that should be ignored when detecting dependencies in method callbacks.',
@@ -618,10 +589,15 @@ const sortClasses = createEslintRule.createEslintRule({
             description:
               'Allows to use comments to separate the class members into logical groups.',
           },
+          customGroups: commonJsonSchemas.buildCustomGroupsArrayJsonSchema({
+            singleCustomGroupJsonSchema:
+              sortClasses_types.singleCustomGroupJsonSchema,
+          }),
           partitionByNewLine: commonJsonSchemas.partitionByNewLineJsonSchema,
           specialCharacters: commonJsonSchemas.specialCharactersJsonSchema,
           newlinesBetween: commonJsonSchemas.newlinesBetweenJsonSchema,
           ignoreCase: commonJsonSchemas.ignoreCaseJsonSchema,
+          alphabet: commonJsonSchemas.alphabetJsonSchema,
           locales: commonJsonSchemas.localesJsonSchema,
           groups: commonJsonSchemas.groupsJsonSchema,
           order: commonJsonSchemas.orderJsonSchema,

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

@@ -1,5 +1,6 @@
 'use strict'
 Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' })
+const commonJsonSchemas = require('../utils/common-json-schemas.js')
 let allSelectors = [
   'accessor-property',
   'index-signature',
@@ -24,33 +25,7 @@ let allModifiers = [
   'declare',
   'optional',
 ]
-let customGroupSortJsonSchema = {
-  type: {
-    enum: ['alphabetical', 'line-length', 'natural', 'unsorted'],
-    description: 'Custom group sort type.',
-    type: 'string',
-  },
-  order: {
-    description: 'Custom group sort order.',
-    enum: ['desc', 'asc'],
-    type: 'string',
-  },
-}
-let customGroupNameJsonSchema = {
-  groupName: {
-    description: 'Custom group name.',
-    type: 'string',
-  },
-}
 let singleCustomGroupJsonSchema = {
-  modifiers: {
-    items: {
-      enum: allModifiers,
-      type: 'string',
-    },
-    description: 'Modifier filters.',
-    type: 'array',
-  },
   elementValuePattern: {
     description: 'Element value pattern filter for properties.',
     type: 'string',
@@ -59,18 +34,11 @@ let singleCustomGroupJsonSchema = {
     description: 'Decorator name pattern filter.',
     type: 'string',
   },
-  selector: {
-    description: 'Selector filter.',
-    enum: allSelectors,
-    type: 'string',
-  },
-  elementNamePattern: {
-    description: 'Element name pattern filter.',
-    type: 'string',
-  },
+  modifiers:
+    commonJsonSchemas.buildCustomGroupModifiersJsonSchema(allModifiers),
+  selector: commonJsonSchemas.buildCustomGroupSelectorJsonSchema(allSelectors),
+  elementNamePattern: commonJsonSchemas.elementNamePatternJsonSchema,
 }
 exports.allModifiers = allModifiers
 exports.allSelectors = allSelectors
-exports.customGroupNameJsonSchema = customGroupNameJsonSchema
-exports.customGroupSortJsonSchema = customGroupSortJsonSchema
 exports.singleCustomGroupJsonSchema = singleCustomGroupJsonSchema

package/dist/rules/sort-decorators.js

@@ -1,5 +1,6 @@
 'use strict'
 const commonJsonSchemas = require('../utils/common-json-schemas.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')
@@ -31,6 +32,7 @@ let defaultOptions = {
   ignoreCase: true,
   customGroups: {},
   locales: 'en-US',
+  alphabet: '',
   order: 'asc',
   groups: [],
 }
@@ -72,6 +74,7 @@ const sortDecorators = createEslintRule.createEslintRule({
           specialCharacters: commonJsonSchemas.specialCharactersJsonSchema,
           customGroups: commonJsonSchemas.customGroupsJsonSchema,
           ignoreCase: commonJsonSchemas.ignoreCaseJsonSchema,
+          alphabet: commonJsonSchemas.alphabetJsonSchema,
           locales: commonJsonSchemas.localesJsonSchema,
           groups: commonJsonSchemas.groupsJsonSchema,
           order: commonJsonSchemas.orderJsonSchema,
@@ -102,6 +105,7 @@ const sortDecorators = createEslintRule.createEslintRule({
       settings,
       defaultOptions,
     )
+    validateCustomSortConfiguration.validateCustomSortConfiguration(options)
     validateGroupsConfiguration.validateGroupsConfiguration(
       options.groups,
       ['unknown'],
@@ -176,7 +180,10 @@ let sortDecorators$1 = (context, options, decorators) => {
         options.partitionByComment &&
         isPartitionComment.hasPartitionComment(
           options.partitionByComment,
-          getCommentsBefore.getCommentsBefore(decorator, sourceCode),
+          getCommentsBefore.getCommentsBefore({
+            node: decorator,
+            sourceCode,
+          }),
         )
       ) {
         accumulator.push([])
@@ -226,6 +233,7 @@ let sortDecorators$1 = (context, options, decorators) => {
       fix: fixer =>
         makeFixes.makeFixes({
           sortedNodes: sortedNodesExcludingEslintDisabled,
+          ignoreFirstNodeHighestBlockComment: true,
           sourceCode,
           options,
           fixer,

package/dist/rules/sort-enums.js

@@ -1,6 +1,7 @@
 'use strict'
 const commonJsonSchemas = require('../utils/common-json-schemas.js')
 const sortNodesByDependencies = require('../utils/sort-nodes-by-dependencies.js')
+const validateCustomSortConfiguration = require('../utils/validate-custom-sort-configuration.js')
 const getEslintDisabledLines = require('../utils/get-eslint-disabled-lines.js')
 const isNodeEslintDisabled = require('../utils/is-node-eslint-disabled.js')
 const isPartitionComment = require('../utils/is-partition-comment.js')
@@ -26,6 +27,7 @@ let defaultOptions = {
   sortByValue: false,
   ignoreCase: true,
   locales: 'en-US',
+  alphabet: '',
   order: 'asc',
 }
 const sortEnums = createEslintRule.createEslintRule({
@@ -44,6 +46,7 @@ const sortEnums = createEslintRule.createEslintRule({
         settings,
         defaultOptions,
       )
+      validateCustomSortConfiguration.validateCustomSortConfiguration(options)
       let sourceCode = getSourceCode.getSourceCode(context)
       let eslintDisabledLines = getEslintDisabledLines.getEslintDisabledLines({
         ruleName: context.id,
@@ -109,7 +112,10 @@ const sortEnums = createEslintRule.createEslintRule({
             (options.partitionByComment &&
               isPartitionComment.hasPartitionComment(
                 options.partitionByComment,
-                getCommentsBefore.getCommentsBefore(member, sourceCode),
+                getCommentsBefore.getCommentsBefore({
+                  node: member,
+                  sourceCode,
+                }),
               )) ||
             (options.partitionByNewLine &&
               lastSortingNode &&
@@ -162,6 +168,7 @@ const sortEnums = createEslintRule.createEslintRule({
             : options.type,
         specialCharacters: options.specialCharacters,
         ignoreCase: options.ignoreCase,
+        alphabet: options.alphabet,
         locales: options.locales,
         order: options.order,
       }
@@ -241,6 +248,7 @@ const sortEnums = createEslintRule.createEslintRule({
           partitionByNewLine: commonJsonSchemas.partitionByNewLineJsonSchema,
           specialCharacters: commonJsonSchemas.specialCharactersJsonSchema,
           ignoreCase: commonJsonSchemas.ignoreCaseJsonSchema,
+          alphabet: commonJsonSchemas.alphabetJsonSchema,
           locales: commonJsonSchemas.localesJsonSchema,
           order: commonJsonSchemas.orderJsonSchema,
           type: commonJsonSchemas.typeJsonSchema,
@@ -295,6 +303,7 @@ let getUnaryExpressionNumberValue = (argumentExpression, operator) => {
       return -argument
     case '~':
       return ~argument
+    /* v8 ignore next 2 - Unsure if we can reach it */
     default:
       return Number.NaN
   }
@@ -329,6 +338,7 @@ let getBinaryExpressionNumberValue = (
       return left & right
     case '^':
       return left ^ right
+    /* v8 ignore next 2 - Unsure if we can reach it */
     default:
       return Number.NaN
   }

package/dist/rules/sort-exports.js

@@ -1,5 +1,6 @@
 'use strict'
 const commonJsonSchemas = require('../utils/common-json-schemas.js')
+const validateCustomSortConfiguration = require('../utils/validate-custom-sort-configuration.js')
 const getEslintDisabledLines = require('../utils/get-eslint-disabled-lines.js')
 const isNodeEslintDisabled = require('../utils/is-node-eslint-disabled.js')
 const isPartitionComment = require('../utils/is-partition-comment.js')
@@ -21,6 +22,7 @@ let defaultOptions = {
   groupKind: 'mixed',
   ignoreCase: true,
   locales: 'en-US',
+  alphabet: '',
   order: 'asc',
 }
 const sortExports = createEslintRule.createEslintRule({
@@ -31,6 +33,7 @@ const sortExports = createEslintRule.createEslintRule({
       settings,
       defaultOptions,
     )
+    validateCustomSortConfiguration.validateCustomSortConfiguration(options)
     let sourceCode = getSourceCode.getSourceCode(context)
     let partitionComment = options.partitionByComment
     let eslintDisabledLines = getEslintDisabledLines.getEslintDisabledLines({
@@ -56,7 +59,10 @@ const sortExports = createEslintRule.createEslintRule({
         (partitionComment &&
           isPartitionComment.hasPartitionComment(
             partitionComment,
-            getCommentsBefore.getCommentsBefore(node, sourceCode),
+            getCommentsBefore.getCommentsBefore({
+              sourceCode,
+              node,
+            }),
           )) ||
         (options.partitionByNewLine &&
           lastNode &&
@@ -147,6 +153,7 @@ const sortExports = createEslintRule.createEslintRule({
           partitionByNewLine: commonJsonSchemas.partitionByNewLineJsonSchema,
           specialCharacters: commonJsonSchemas.specialCharactersJsonSchema,
           ignoreCase: commonJsonSchemas.ignoreCaseJsonSchema,
+          alphabet: commonJsonSchemas.alphabetJsonSchema,
           locales: commonJsonSchemas.localesJsonSchema,
           order: commonJsonSchemas.orderJsonSchema,
           type: commonJsonSchemas.typeJsonSchema,

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

@@ -1,5 +1,6 @@
 'use strict'
 const commonJsonSchemas = require('../utils/common-json-schemas.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')
@@ -21,6 +22,7 @@ let defaultOptions = {
   ignoreCase: true,
   customGroups: {},
   locales: 'en-US',
+  alphabet: '',
   order: 'asc',
   groups: [],
 }
@@ -32,6 +34,7 @@ const sortHeritageClauses = createEslintRule.createEslintRule({
           specialCharacters: commonJsonSchemas.specialCharactersJsonSchema,
           customGroups: commonJsonSchemas.customGroupsJsonSchema,
           ignoreCase: commonJsonSchemas.ignoreCaseJsonSchema,
+          alphabet: commonJsonSchemas.alphabetJsonSchema,
           locales: commonJsonSchemas.localesJsonSchema,
           groups: commonJsonSchemas.groupsJsonSchema,
           order: commonJsonSchemas.orderJsonSchema,
@@ -62,6 +65,7 @@ const sortHeritageClauses = createEslintRule.createEslintRule({
       settings,
       defaultOptions,
     )
+    validateCustomSortConfiguration.validateCustomSortConfiguration(options)
     validateGroupsConfiguration.validateGroupsConfiguration(
       options.groups,
       ['unknown'],