-
Notifications
You must be signed in to change notification settings - Fork 39
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
239 additions
and
20 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,216 @@ | ||
| import type { RuleContext } from '@typescript-eslint/utils/ts-eslint' | ||
| import type { TSESTree } from '@typescript-eslint/types' | ||
|
|
||
| import type { SortingNode } from '../typings' | ||
|
|
||
| import { validateGroupsConfiguration } from '../utils/validate-groups-configuration' | ||
| import { sortNodesByGroups } from '../utils/sort-nodes-by-groups' | ||
| import { createEslintRule } from '../utils/create-eslint-rule' | ||
| import { getGroupNumber } from '../utils/get-group-number' | ||
| import { getSourceCode } from '../utils/get-source-code' | ||
| import { toSingleLine } from '../utils/to-single-line' | ||
| import { rangeToDiff } from '../utils/range-to-diff' | ||
| import { getSettings } from '../utils/get-settings' | ||
| import { useGroups } from '../utils/use-groups' | ||
| import { makeFixes } from '../utils/make-fixes' | ||
| import { complete } from '../utils/complete' | ||
| import { pairwise } from '../utils/pairwise' | ||
|
|
||
| type MESSAGE_ID = | ||
| | 'unexpectedHeritageClausesGroupOrder' | ||
| | 'unexpectedHeritageClausesOrder' | ||
|
|
||
| type Group<T extends string[]> = 'unknown' | T[number] | ||
|
|
||
| export type Options<T extends string[]> = [ | ||
| Partial<{ | ||
| customGroups: { [key in T[number]]: string[] | string } | ||
| type: 'alphabetical' | 'line-length' | 'natural' | ||
| specialCharacters: 'remove' | 'trim' | 'keep' | ||
| groups: (Group<T>[] | Group<T>)[] | ||
| matcher: 'minimatch' | 'regex' | ||
| order: 'desc' | 'asc' | ||
| ignoreCase: boolean | ||
| }>, | ||
| ] | ||
|
|
||
| export default createEslintRule<Options<string[]>, MESSAGE_ID>({ | ||
| name: 'sort-heritage-clauses', | ||
| meta: { | ||
| type: 'suggestion', | ||
| docs: { | ||
| description: 'Enforce sorted heritage clauses.', | ||
| }, | ||
| fixable: 'code', | ||
| schema: [ | ||
| { | ||
| type: 'object', | ||
| properties: { | ||
| type: { | ||
| description: 'Specifies the sorting method.', | ||
| type: 'string', | ||
| enum: ['alphabetical', 'natural', 'line-length'], | ||
| }, | ||
| order: { | ||
| description: | ||
| 'Determines whether the sorted items should be in ascending or descending order.', | ||
| type: 'string', | ||
| enum: ['asc', 'desc'], | ||
| }, | ||
| matcher: { | ||
| description: 'Specifies the string matcher.', | ||
| type: 'string', | ||
| enum: ['minimatch', 'regex'], | ||
| }, | ||
| ignoreCase: { | ||
| 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'], | ||
| }, | ||
| groups: { | ||
| description: 'Specifies the order of the groups.', | ||
| type: 'array', | ||
| items: { | ||
| oneOf: [ | ||
| { | ||
| type: 'string', | ||
| }, | ||
| { | ||
| type: 'array', | ||
| items: { | ||
| type: 'string', | ||
| }, | ||
| }, | ||
| ], | ||
| }, | ||
| }, | ||
| customGroups: { | ||
| description: 'Specifies custom groups.', | ||
| type: 'object', | ||
| additionalProperties: { | ||
| oneOf: [ | ||
| { | ||
| type: 'string', | ||
| }, | ||
| { | ||
| type: 'array', | ||
| items: { | ||
| type: 'string', | ||
| }, | ||
| }, | ||
| ], | ||
| }, | ||
| }, | ||
| }, | ||
| additionalProperties: false, | ||
| }, | ||
| ], | ||
| messages: { | ||
| unexpectedHeritageClausesGroupOrder: | ||
| 'Expected "{{right}}" ({{rightGroup}}) to come before "{{left}}" ({{leftGroup}}).', | ||
| unexpectedHeritageClausesOrder: | ||
| 'Expected "{{right}}" to come before "{{left}}".', | ||
| }, | ||
| }, | ||
| defaultOptions: [ | ||
| { | ||
| type: 'alphabetical', | ||
| order: 'asc', | ||
| ignoreCase: true, | ||
| specialCharacters: 'keep', | ||
| matcher: 'minimatch', | ||
| groups: [], | ||
| customGroups: {}, | ||
| }, | ||
| ], | ||
| create: context => { | ||
| let settings = getSettings(context.settings) | ||
|
|
||
| let options = complete(context.options.at(0), settings, { | ||
| type: 'alphabetical', | ||
| matcher: 'minimatch', | ||
| ignoreCase: true, | ||
| specialCharacters: 'keep', | ||
| customGroups: {}, | ||
| order: 'asc', | ||
| groups: [], | ||
| } as const) | ||
|
|
||
| validateGroupsConfiguration( | ||
| options.groups, | ||
| ['unknown'], | ||
| Object.keys(options.customGroups), | ||
| ) | ||
|
|
||
| return { | ||
| ClassDeclaration: declaration => | ||
| sortHeritageClauses(context, options, declaration.implements), | ||
| TSInterfaceDeclaration: declaration => | ||
| sortHeritageClauses(context, options, declaration.extends), | ||
| } | ||
| }, | ||
| }) | ||
|
|
||
| const sortHeritageClauses = ( | ||
| context: Readonly<RuleContext<MESSAGE_ID, Options<string[]>>>, | ||
| options: Required<Options<string[]>[0]>, | ||
| heritageClauses: | ||
| | TSESTree.TSInterfaceHeritage[] | ||
| | TSESTree.TSClassImplements[], | ||
| ) => { | ||
| if (heritageClauses.length < 2) { | ||
| return | ||
| } | ||
| let sourceCode = getSourceCode(context) | ||
|
|
||
| let formattedMembers: SortingNode[] = heritageClauses | ||
| .map(heritageClause => { | ||
| if (heritageClause.expression.type !== 'Identifier') { | ||
| return null | ||
| } | ||
| let { name } = heritageClause.expression | ||
|
|
||
| let { getGroup, setCustomGroups } = useGroups(options) | ||
| setCustomGroups(options.customGroups, name) | ||
|
|
||
| return { | ||
| size: rangeToDiff(heritageClause.range), | ||
| node: heritageClause, | ||
| group: getGroup(), | ||
| name, | ||
| } | ||
| }) | ||
| .filter(sortingNode => !!sortingNode) | ||
|
|
||
| let sortedNodes = sortNodesByGroups(formattedMembers, options) | ||
| let nodes = formattedMembers.flat() | ||
| pairwise(nodes, (left, right) => { | ||
| let indexOfLeft = sortedNodes.indexOf(left) | ||
| let indexOfRight = sortedNodes.indexOf(right) | ||
| if (indexOfLeft <= indexOfRight) { | ||
| return | ||
| } | ||
| let leftNum = getGroupNumber(options.groups, left) | ||
| let rightNum = getGroupNumber(options.groups, right) | ||
| context.report({ | ||
| messageId: | ||
| leftNum !== rightNum | ||
| ? 'unexpectedHeritageClausesGroupOrder' | ||
| : 'unexpectedHeritageClausesOrder', | ||
| data: { | ||
| left: toSingleLine(left.name), | ||
| leftGroup: left.group, | ||
| right: toSingleLine(right.name), | ||
| rightGroup: right.group, | ||
| }, | ||
| node: right.node, | ||
| fix: fixer => makeFixes(fixer, nodes, sortedNodes, sourceCode), | ||
| }) | ||
| }) | ||
| } |