eslint-plugin-perfectionist 5.12.1 → 5.13.0

package/dist/index.d.ts

@@ -18,6 +18,7 @@ declare const _default: {
   configs: PluginConfigs
 } & ESLint.Plugin
 export default _default
+export type { Options as SortConstructorParametersOptions } from './rules/sort-constructor-parameters/types.js'
 export type { Options as SortVariableDeclarationsOptions } from './rules/sort-variable-declarations/types.js'
 export type { Options as SortIntersectionTypesOptions } from './rules/sort-intersection-types/types.js'
 export type { Options as SortImportAttributesOptions } from './rules/sort-import-attributes/types.js'

package/dist/index.js

@@ -1,4 +1,5 @@
 import { name, version } from './package.json.js'
+import sort_constructor_parameters_default from './rules/sort-constructor-parameters.js'
 import sort_variable_declarations_default from './rules/sort-variable-declarations.js'
 import sort_intersection_types_default from './rules/sort-intersection-types.js'
 import sort_import_attributes_default from './rules/sort-import-attributes.js'
@@ -49,6 +50,7 @@ let recommendedRules = {
 }
 let rules = {
   ...recommendedRules,
+  'sort-constructor-parameters': sort_constructor_parameters_default,
   'sort-arrays': sort_arrays_default,
 }
 let plugin = {
@@ -112,8 +114,10 @@ let configs = {
     order: 'asc',
   }),
 }
-var eslint_plugin_perfectionist_default = {
-  ...plugin,
-  configs,
-}
-export { configs, eslint_plugin_perfectionist_default as default, rules }
+/**
+ * The configs register `plugin` under its name, so the default export must be
+ * the same object. ESLint compares plugins by reference and throws "Cannot
+ * redefine plugin" when a user config registers a copy.
+ */
+plugin.configs = configs
+export { configs, plugin as default, rules }

package/dist/package.json.js

@@ -1,3 +1,3 @@
 const name = 'eslint-plugin-perfectionist'
-const version = '5.12.1'
+const version = '5.13.0'
 export { name, version }

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

@@ -1,19 +1,19 @@
-import {
-  buildCommonJsonSchemas,
-  buildUseConfigIfJsonSchema,
-  matchesAstSelectorJsonSchema,
-} from '../utils/json-schemas/common-json-schemas.js'
-import { buildCommonGroupsJsonSchemas } from '../utils/json-schemas/common-groups-json-schemas.js'
 import {
   EXTRA_SPACING_ERROR,
   GROUP_ORDER_ERROR,
   MISSED_SPACING_ERROR,
   ORDER_ERROR,
 } from '../utils/report-errors.js'
+import {
+  buildCommonJsonSchemas,
+  buildUseConfigIfJsonSchema,
+  matchesAstSelectorJsonSchema,
+} from '../utils/json-schemas/common-json-schemas.js'
 import {
   partitionByCommentJsonSchema,
   partitionByNewlineJsonSchema,
 } from '../utils/json-schemas/common-partition-json-schemas.js'
+import { buildCommonGroupsJsonSchemas } from '../utils/json-schemas/common-groups-json-schemas.js'
 import { buildAstListeners } from '../utils/build-ast-listeners.js'
 import { createEslintRule } from '../utils/create-eslint-rule.js'
 import { additionalCustomGroupMatchOptionsJsonSchema } from './sort-arrays/types.js'

package/dist/rules/sort-arrays/sort-array.d.ts

@@ -1,6 +1,20 @@
 import { RuleContext } from '@typescript-eslint/utils/ts-eslint'
 import { TSESTree } from '@typescript-eslint/types'
 import { Options } from './types.js'
+/**
+ * Sorts the elements of an array-like expression.
+ *
+ * @param params - Parameters.
+ * @param params.cachedGroupsByModifiersAndSelectors - Cache of predefined
+ *   groups.
+ * @param params.mustHaveMatchedContextOptions - Whether to skip nodes matching
+ *   no option.
+ * @param params.availableMessageIds - The message IDs to report with.
+ * @param params.matchedAstSelectors - The AST selectors the node matched.
+ * @param params.defaultOptions - The rule default options.
+ * @param params.context - The rule context.
+ * @param params.node - Array or `new` expression whose elements are sorted.
+ */
 export declare function sortArray<MessageIds extends string>({
   cachedGroupsByModifiersAndSelectors,
   mustHaveMatchedContextOptions,

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

@@ -15,11 +15,26 @@ import { rangeToDiff } from '../../utils/range-to-diff.js'
 import { getSettings } from '../../utils/get-settings.js'
 import { isSortable } from '../../utils/is-sortable.js'
 import { complete } from '../../utils/complete.js'
+import { canReportErrors } from '../../utils/can-report-errors.js'
 import { allSelectors } from './types.js'
 import { computeNodeName } from './compute-node-name.js'
 import { computeMatchedContextOptions } from './compute-matched-context-options.js'
 import { computeArrayElements } from './compute-array-elements.js'
 import { AST_NODE_TYPES } from '@typescript-eslint/types'
+/**
+ * Sorts the elements of an array-like expression.
+ *
+ * @param params - Parameters.
+ * @param params.cachedGroupsByModifiersAndSelectors - Cache of predefined
+ *   groups.
+ * @param params.mustHaveMatchedContextOptions - Whether to skip nodes matching
+ *   no option.
+ * @param params.availableMessageIds - The message IDs to report with.
+ * @param params.matchedAstSelectors - The AST selectors the node matched.
+ * @param params.defaultOptions - The rule default options.
+ * @param params.context - The rule context.
+ * @param params.node - Array or `new` expression whose elements are sorted.
+ */
 function sortArray({
   cachedGroupsByModifiersAndSelectors,
   mustHaveMatchedContextOptions,
@@ -46,7 +61,11 @@ function sortArray({
   if (mustHaveMatchedContextOptions && !matchedContextOptions) {
     return
   }
-  let options = complete(matchedContextOptions, settings, defaultOptions)
+  let options = complete({
+    options: matchedContextOptions,
+    defaults: defaultOptions,
+    settings,
+  })
   validateCustomSortConfig(options)
   validateGroupsConfig({
     selectors: allSelectors,
@@ -54,6 +73,17 @@ function sortArray({
     options,
   })
   validateNewlinesAndPartitionConfig(options)
+  if (
+    !canReportErrors({
+      comparatorByOptionsComputer: defaultComparatorByOptionsComputer,
+      newlinesBetweenValueGetter: void 0,
+      canHaveDependencies: false,
+      availableMessageIds,
+      options,
+    })
+  ) {
+    return
+  }
   let eslintDisabledLines = getEslintDisabledLines({
     ruleName: id,
     sourceCode,

package/dist/rules/sort-arrays.js

@@ -1,19 +1,19 @@
-import {
-  buildCommonJsonSchemas,
-  buildUseConfigIfJsonSchema,
-  matchesAstSelectorJsonSchema,
-} from '../utils/json-schemas/common-json-schemas.js'
-import { buildCommonGroupsJsonSchemas } from '../utils/json-schemas/common-groups-json-schemas.js'
 import {
   EXTRA_SPACING_ERROR,
   GROUP_ORDER_ERROR,
   MISSED_SPACING_ERROR,
   ORDER_ERROR,
 } from '../utils/report-errors.js'
+import {
+  buildCommonJsonSchemas,
+  buildUseConfigIfJsonSchema,
+  matchesAstSelectorJsonSchema,
+} from '../utils/json-schemas/common-json-schemas.js'
 import {
   partitionByCommentJsonSchema,
   partitionByNewlineJsonSchema,
 } from '../utils/json-schemas/common-partition-json-schemas.js'
+import { buildCommonGroupsJsonSchemas } from '../utils/json-schemas/common-groups-json-schemas.js'
 import { buildAstListeners } from '../utils/build-ast-listeners.js'
 import { createEslintRule } from '../utils/create-eslint-rule.js'
 import { additionalCustomGroupMatchOptionsJsonSchema } from './sort-arrays/types.js'

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

@@ -10,8 +10,10 @@ import { getEslintDisabledLines } from '../../utils/get-eslint-disabled-lines.js
 import { doesCustomGroupMatch } from '../../utils/does-custom-group-match.js'
 import { isNodeEslintDisabled } from '../../utils/is-node-eslint-disabled.js'
 import { validateGroupsConfig } from '../../utils/validate-groups-config.js'
+import { getNodeDecorators } from '../../utils/get-node-decorators.js'
 import { getGroupIndex } from '../../utils/get-group-index.js'
 import { sortNodesByGroups } from '../../utils/sort-nodes-by-groups.js'
+import { getDecoratorName } from '../../utils/get-decorator-name.js'
 import { reportAllErrors } from '../../utils/report-all-errors.js'
 import { shouldPartition } from '../../utils/should-partition.js'
 import { computeGroup } from '../../utils/compute-group.js'
@@ -19,8 +21,6 @@ import { rangeToDiff } from '../../utils/range-to-diff.js'
 import { getSettings } from '../../utils/get-settings.js'
 import { isSortable } from '../../utils/is-sortable.js'
 import { complete } from '../../utils/complete.js'
-import { getNodeDecorators } from '../../utils/get-node-decorators.js'
-import { getDecoratorName } from '../../utils/get-decorator-name.js'
 import {
   DEPENDENCY_ORDER_ERROR_ID,
   EXTRA_SPACING_ERROR_ID,
@@ -99,7 +99,11 @@ function sortClass({ matchedAstSelectors, context, node }) {
     classElements,
     context,
   })
-  let options = complete(matchedContextOptions, settings, defaultOptions)
+  let options = complete({
+    options: matchedContextOptions,
+    defaults: defaultOptions,
+    settings,
+  })
   validateCustomSortConfig(options)
   validateGroupsConfig({
     modifiers: allModifiers,

package/dist/rules/sort-classes.js

@@ -1,14 +1,3 @@
-import {
-  buildCommonJsonSchemas,
-  buildRegexJsonSchema,
-  buildUseConfigIfJsonSchema,
-  matchesAstSelectorJsonSchema,
-  useExperimentalDependencyDetectionJsonSchema,
-} from '../utils/json-schemas/common-json-schemas.js'
-import {
-  buildCommonGroupsJsonSchemas,
-  newlinesBetweenJsonSchema,
-} from '../utils/json-schemas/common-groups-json-schemas.js'
 import {
   DEPENDENCY_ORDER_ERROR,
   EXTRA_SPACING_ERROR,
@@ -16,10 +5,21 @@ import {
   MISSED_SPACING_ERROR,
   ORDER_ERROR,
 } from '../utils/report-errors.js'
+import {
+  buildCommonJsonSchemas,
+  buildRegexJsonSchema,
+  buildUseConfigIfJsonSchema,
+  matchesAstSelectorJsonSchema,
+  useExperimentalDependencyDetectionJsonSchema,
+} from '../utils/json-schemas/common-json-schemas.js'
 import {
   partitionByCommentJsonSchema,
   partitionByNewlineJsonSchema,
 } from '../utils/json-schemas/common-partition-json-schemas.js'
+import {
+  buildCommonGroupsJsonSchemas,
+  newlinesBetweenJsonSchema,
+} from '../utils/json-schemas/common-groups-json-schemas.js'
 import { buildAstListeners } from '../utils/build-ast-listeners.js'
 import { createEslintRule } from '../utils/create-eslint-rule.js'
 import {

package/dist/rules/sort-constructor-parameters/compute-matched-context-options.d.ts

@@ -0,0 +1,25 @@
+import { RuleContext } from '@typescript-eslint/utils/ts-eslint'
+import { TSESTree } from '@typescript-eslint/types'
+import { Options } from './types.js'
+/**
+ * Computes the matched context options for a given constructor node.
+ *
+ * @param params - Parameters.
+ * @param params.matchedAstSelectors - The matched AST selectors for a
+ *   constructor node.
+ * @param params.params - The constructor parameters to compute the context
+ *   options for.
+ * @param params.context - The rule context.
+ * @returns The matched context options or undefined if none match.
+ */
+export declare function computeMatchedContextOptions<
+  MessageIds extends string,
+>({
+  matchedAstSelectors,
+  context,
+  params,
+}: {
+  context: Readonly<RuleContext<MessageIds, Options>>
+  matchedAstSelectors: ReadonlySet<string>
+  params: TSESTree.Parameter[]
+}): Options[number] | undefined

package/dist/rules/sort-constructor-parameters/compute-matched-context-options.js

@@ -0,0 +1,53 @@
+import { passesAllNamesMatchPatternFilter } from '../../utils/context-matching/passes-all-names-match-pattern-filter.js'
+import { passesAstSelectorFilter } from '../../utils/context-matching/passes-ast-selector-filter.js'
+import { computeNodeName } from './compute-node-name.js'
+import { AST_NODE_TYPES } from '@typescript-eslint/types'
+/**
+ * Computes the matched context options for a given constructor node.
+ *
+ * @param params - Parameters.
+ * @param params.matchedAstSelectors - The matched AST selectors for a
+ *   constructor node.
+ * @param params.params - The constructor parameters to compute the context
+ *   options for.
+ * @param params.context - The rule context.
+ * @returns The matched context options or undefined if none match.
+ */
+function computeMatchedContextOptions({
+  matchedAstSelectors,
+  context,
+  params,
+}) {
+  let nodeNames = params
+    .filter(parameter => parameter.type !== AST_NODE_TYPES.RestElement)
+    .map(parameter =>
+      computeNodeName({
+        sourceCode: context.sourceCode,
+        node: parameter,
+      }),
+    )
+  return context.options.find(options =>
+    isContextOptionMatching({
+      matchedAstSelectors,
+      nodeNames,
+      options,
+    }),
+  )
+}
+function isContextOptionMatching({ matchedAstSelectors, nodeNames, options }) {
+  /* v8 ignore if -- Filtered at validation level */
+  if (!options.useConfigurationIf) {
+    return true
+  }
+  return (
+    passesAllNamesMatchPatternFilter({
+      allNamesMatchPattern: options.useConfigurationIf.allNamesMatchPattern,
+      nodeNames,
+    }) &&
+    passesAstSelectorFilter({
+      matchesAstSelector: options.useConfigurationIf.matchesAstSelector,
+      matchedAstSelectors,
+    })
+  )
+}
+export { computeMatchedContextOptions }

package/dist/rules/sort-constructor-parameters/compute-node-name.d.ts

@@ -0,0 +1,17 @@
+import { TSESTree } from '@typescript-eslint/types'
+import { TSESLint } from '@typescript-eslint/utils'
+/**
+ * Computes the name of a constructor parameter.
+ *
+ * @param props - The parameters object.
+ * @param props.sourceCode - ESLint source code object for text extraction.
+ * @param props.node - The AST node representing a constructor parameter.
+ * @returns The name of the constructor parameter.
+ */
+export declare function computeNodeName({
+  sourceCode,
+  node,
+}: {
+  node: Exclude<TSESTree.Parameter, TSESTree.RestElement>
+  sourceCode: TSESLint.SourceCode
+}): string

package/dist/rules/sort-constructor-parameters/compute-node-name.js

@@ -0,0 +1,38 @@
+import { UnreachableCaseError } from '../../utils/unreachable-case-error.js'
+import { AST_NODE_TYPES } from '@typescript-eslint/types'
+/**
+ * Computes the name of a constructor parameter.
+ *
+ * @param props - The parameters object.
+ * @param props.sourceCode - ESLint source code object for text extraction.
+ * @param props.node - The AST node representing a constructor parameter.
+ * @returns The name of the constructor parameter.
+ */
+function computeNodeName({ sourceCode, node }) {
+  let nonParameterNorAssignmentNode =
+    extractFirstNonParameterNorAssignmentNode(node)
+  switch (nonParameterNorAssignmentNode.type) {
+    case AST_NODE_TYPES.ObjectPattern:
+    case AST_NODE_TYPES.ArrayPattern:
+      return sourceCode.getText(nonParameterNorAssignmentNode)
+    case AST_NODE_TYPES.Identifier:
+      return nonParameterNorAssignmentNode.name
+    /* v8 ignore next 2 -- @preserve Exhaustive guard. */
+    default:
+      throw new UnreachableCaseError(nonParameterNorAssignmentNode)
+  }
+}
+function extractFirstNonParameterNorAssignmentNode(node) {
+  let currentNode = node
+  while (
+    currentNode.type === AST_NODE_TYPES.TSParameterProperty ||
+    currentNode.type === AST_NODE_TYPES.AssignmentPattern
+  ) {
+    currentNode =
+      currentNode.type === AST_NODE_TYPES.TSParameterProperty ?
+        currentNode.parameter
+      : currentNode.left
+  }
+  return currentNode
+}
+export { computeNodeName }

package/dist/rules/sort-constructor-parameters/compute-parameter-modifiers.d.ts

@@ -0,0 +1,18 @@
+import { TSESTree } from '@typescript-eslint/types'
+import { Modifier } from './types.js'
+type Parameter = Exclude<TSESTree.Parameter, TSESTree.RestElement>
+/**
+ * Computes the modifiers carried by a constructor parameter, ordered from most
+ * to least important.
+ *
+ * Every parameter receives an accessibility modifier, defaulting to `public`
+ * when none is declared (including plain parameters that are not parameter
+ * properties).
+ *
+ * @param parameter - The constructor parameter node.
+ * @returns The modifiers, ordered from most to least important.
+ */
+export declare function computeParameterModifiers(
+  parameter: Parameter,
+): Modifier[]
+export {}

package/dist/rules/sort-constructor-parameters/compute-parameter-modifiers.js

@@ -0,0 +1,59 @@
+import { UnreachableCaseError } from '../../utils/unreachable-case-error.js'
+import { getNodeDecorators } from '../../utils/get-node-decorators.js'
+import { AST_NODE_TYPES } from '@typescript-eslint/types'
+/**
+ * Computes the modifiers carried by a constructor parameter, ordered from most
+ * to least important.
+ *
+ * Every parameter receives an accessibility modifier, defaulting to `public`
+ * when none is declared (including plain parameters that are not parameter
+ * properties).
+ *
+ * @param parameter - The constructor parameter node.
+ * @returns The modifiers, ordered from most to least important.
+ */
+function computeParameterModifiers(parameter) {
+  return [
+    ...computeDecoratedModifier(parameter),
+    ...computeOverrideModifier(parameter),
+    ...computeReadonlyModifier(parameter),
+    ...computeAccessibilityModifier(parameter),
+  ]
+}
+function computeAccessibilityModifier(parameter) {
+  if (parameter.type !== AST_NODE_TYPES.TSParameterProperty) {
+    return ['public']
+  }
+  switch (parameter.accessibility) {
+    case 'protected':
+      return ['protected']
+    case 'private':
+      return ['private']
+    case void 0:
+    case 'public':
+      return ['public']
+    /* v8 ignore next 2 -- @preserve Exhaustive guard. */
+    default:
+      throw new UnreachableCaseError(parameter.accessibility)
+  }
+}
+function computeOverrideModifier(parameter) {
+  return (
+      parameter.type === AST_NODE_TYPES.TSParameterProperty &&
+        parameter.override
+    ) ?
+      ['override']
+    : []
+}
+function computeReadonlyModifier(parameter) {
+  return (
+      parameter.type === AST_NODE_TYPES.TSParameterProperty &&
+        parameter.readonly
+    ) ?
+      ['readonly']
+    : []
+}
+function computeDecoratedModifier(parameter) {
+  return getNodeDecorators(parameter).length > 0 ? ['decorated'] : []
+}
+export { computeParameterModifiers }

package/dist/rules/sort-constructor-parameters/is-constructor-overloaded.d.ts

@@ -0,0 +1,11 @@
+import { TSESTree } from '@typescript-eslint/types'
+/**
+ * Checks whether a constructor is part of an overload set or is a bodiless
+ * signature.
+ *
+ * @param node - The constructor method definition to check.
+ * @returns Whether the constructor is overloaded or bodiless.
+ */
+export declare function isConstructorOverloaded(
+  node: TSESTree.MethodDefinition,
+): boolean

package/dist/rules/sort-constructor-parameters/is-constructor-overloaded.js

@@ -0,0 +1,26 @@
+import { UnreachableCaseError } from '../../utils/unreachable-case-error.js'
+import { AST_NODE_TYPES } from '@typescript-eslint/types'
+/**
+ * Checks whether a constructor is part of an overload set or is a bodiless
+ * signature.
+ *
+ * @param node - The constructor method definition to check.
+ * @returns Whether the constructor is overloaded or bodiless.
+ */
+function isConstructorOverloaded(node) {
+  switch (node.value.type) {
+    case AST_NODE_TYPES.TSEmptyBodyFunctionExpression:
+      return true
+    case AST_NODE_TYPES.FunctionExpression:
+      return node.parent.body.some(
+        member =>
+          member !== node &&
+          member.type === AST_NODE_TYPES.MethodDefinition &&
+          member.kind === 'constructor',
+      )
+    /* v8 ignore next 2 -- @preserve Exhaustive guard. */
+    default:
+      throw new UnreachableCaseError(node.value)
+  }
+}
+export { isConstructorOverloaded }

package/dist/rules/sort-constructor-parameters/sort-constructor-parameters.d.ts

@@ -0,0 +1,26 @@
+import { RuleContext } from '@typescript-eslint/utils/ts-eslint'
+import { TSESTree } from '@typescript-eslint/types'
+import { Options } from './types.js'
+export declare function sortConstructorParameters<MessageIds extends string>({
+  cachedGroupsByModifiersAndSelectors,
+  mustHaveMatchedContextOptions,
+  availableMessageIds,
+  matchedAstSelectors,
+  defaultOptions,
+  context,
+  node,
+}: {
+  availableMessageIds: {
+    missedSpacingBetweenMembers: MessageIds
+    extraSpacingBetweenMembers: MessageIds
+    unexpectedDependencyOrder: MessageIds
+    unexpectedGroupOrder: MessageIds
+    unexpectedOrder: MessageIds
+  }
+  cachedGroupsByModifiersAndSelectors: Map<string, string[]>
+  context: Readonly<RuleContext<MessageIds, Options>>
+  defaultOptions: Required<Options[number]>
+  matchedAstSelectors: ReadonlySet<string>
+  mustHaveMatchedContextOptions: boolean
+  node: TSESTree.MethodDefinition
+}): void