chore: enable sort-type-constituents internally (#7028)

typescript-eslint · Jun 24, 2023 · 3cdf5c9 · 3cdf5c9
1 parent e2a0a76
commit 3cdf5c9
Show file tree

Hide file tree

Showing 153 changed files with 723 additions and 718 deletions.
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -98,6 +98,7 @@ module.exports = {
         allowRegExp: true,
       },
     ],
+    '@typescript-eslint/sort-type-constituents': 'error',
     '@typescript-eslint/no-unused-vars': [
       'error',
       { varsIgnorePattern: '^_', argsIgnorePattern: '^_' },

diff --git a/packages/ast-spec/tests/util/parsers/parser-types.ts b/packages/ast-spec/tests/util/parsers/parser-types.ts
@@ -45,4 +45,4 @@ export interface ParserResponseError {
   readonly type: ParserResponseType.Error;
   readonly error: unknown;
 }
-export type ParserResponse = ParserResponseSuccess | ParserResponseError;
+export type ParserResponse = ParserResponseError | ParserResponseSuccess;
diff --git a/packages/eslint-plugin-internal/src/rules/plugin-test-formatting.ts b/packages/eslint-plugin-internal/src/rules/plugin-test-formatting.ts
@@ -67,7 +67,7 @@ function doIndent(line: string, indent: number): string {
   return line;
 }
 
-function getQuote(code: string): "'" | '"' | null {
+function getQuote(code: string): '"' | "'" | null {
   const hasSingleQuote = code.includes("'");
   const hasDoubleQuote = code.includes('"');
   if (hasSingleQuote && hasDoubleQuote) {
@@ -95,12 +95,12 @@ type Options = [
 type MessageIds =
   | 'invalidFormatting'
   | 'invalidFormattingErrorTest'
+  | 'prettierException'
   | 'singleLineQuotes'
   | 'templateLiteralEmptyEnds'
   | 'templateLiteralLastLineIndent'
-  | 'templateStringRequiresIndent'
   | 'templateStringMinimumIndent'
-  | 'prettierException';
+  | 'templateStringRequiresIndent';
 
 export default createRule<Options, MessageIds>({
   name: 'plugin-test-formatting',

diff --git a/packages/eslint-plugin-tslint/src/rules/config.ts b/packages/eslint-plugin-tslint/src/rules/config.ts
@@ -32,14 +32,14 @@ const createRule = ESLintUtils.RuleCreator(
 );
 export type RawRulesConfig = Record<
   string,
-  | null
-  | undefined
-  | boolean
   | unknown[]
+  | boolean
   | {
-      severity?: RuleSeverity | 'warn' | 'none' | 'default';
+      severity?: RuleSeverity | 'default' | 'none' | 'warn';
       options?: unknown;
     }
+  | null
+  | undefined
 >;
 
 export type MessageIds = 'failure';

diff --git a/packages/eslint-plugin/src/rules/adjacent-overload-signatures.ts b/packages/eslint-plugin/src/rules/adjacent-overload-signatures.ts
@@ -4,12 +4,12 @@ import { AST_NODE_TYPES } from '@typescript-eslint/utils';
 import * as util from '../util';
 
 type RuleNode =
+  | TSESTree.BlockStatement
   | TSESTree.ClassBody
   | TSESTree.Program
-  | TSESTree.TSModuleBlock
-  | TSESTree.TSTypeLiteral
   | TSESTree.TSInterfaceBody
-  | TSESTree.BlockStatement;
+  | TSESTree.TSModuleBlock
+  | TSESTree.TSTypeLiteral;
 type Member =
   | TSESTree.ClassElement
   | TSESTree.ProgramStatement

diff --git a/packages/eslint-plugin/src/rules/array-type.ts b/packages/eslint-plugin/src/rules/array-type.ts
@@ -72,17 +72,17 @@ function typeNeedsParentheses(node: TSESTree.Node): boolean {
   }
 }
 
-export type OptionString = 'array' | 'generic' | 'array-simple';
+export type OptionString = 'array-simple' | 'array' | 'generic';
 type Options = [
   {
     default: OptionString;
     readonly?: OptionString;
   },
 ];
 type MessageIds =
-  | 'errorStringGeneric'
   | 'errorStringArray'
   | 'errorStringArraySimple'
+  | 'errorStringGeneric'
   | 'errorStringGenericSimple';
 
 export default util.createRule<Options, MessageIds>({

diff --git a/packages/eslint-plugin/src/rules/ban-ts-comment.ts b/packages/eslint-plugin/src/rules/ban-ts-comment.ts
@@ -19,8 +19,8 @@ export const defaultMinimumDescriptionLength = 3;
 
 type MessageIds =
   | 'tsDirectiveComment'
-  | 'tsDirectiveCommentRequiresDescription'
-  | 'tsDirectiveCommentDescriptionNotMatchPattern';
+  | 'tsDirectiveCommentDescriptionNotMatchPattern'
+  | 'tsDirectiveCommentRequiresDescription';
 
 export default util.createRule<[Options], MessageIds>({
   name: 'ban-ts-comment',

diff --git a/packages/eslint-plugin/src/rules/ban-tslint-comment.ts b/packages/eslint-plugin/src/rules/ban-tslint-comment.ts
@@ -9,7 +9,7 @@ const ENABLE_DISABLE_REGEX =
 
 const toText = (
   text: string,
-  type: AST_TOKEN_TYPES.Line | AST_TOKEN_TYPES.Block,
+  type: AST_TOKEN_TYPES.Block | AST_TOKEN_TYPES.Line,
 ): string =>
   type === AST_TOKEN_TYPES.Line
     ? ['//', text.trim()].join(' ')

diff --git a/packages/eslint-plugin/src/rules/ban-types.ts b/packages/eslint-plugin/src/rules/ban-types.ts
@@ -5,14 +5,14 @@ import * as util from '../util';
 
 type Types = Record<
   string,
-  | null
   | boolean
   | string
   | {
       message: string;
       fixWith?: string;
       suggest?: readonly string[];
     }
+  | null
 >;
 
 export type Options = [
@@ -35,7 +35,7 @@ function stringifyNode(
 }
 
 function getCustomMessage(
-  bannedType: null | true | string | { message?: string; fixWith?: string },
+  bannedType: string | true | { message?: string; fixWith?: string } | null,
 ): string {
   if (bannedType == null || bannedType === true) {
     return '';

diff --git a/packages/eslint-plugin/src/rules/brace-style.ts b/packages/eslint-plugin/src/rules/brace-style.ts
@@ -119,7 +119,7 @@ export default createRule<Options, MessageIds>({
     return {
       ...rules,
       'TSInterfaceBody, TSModuleBlock'(
-        node: TSESTree.TSModuleBlock | TSESTree.TSInterfaceBody,
+        node: TSESTree.TSInterfaceBody | TSESTree.TSModuleBlock,
       ): void {
         const openingCurly = sourceCode.getFirstToken(node)!;
         const closingCurly = sourceCode.getLastToken(node)!;

diff --git a/packages/eslint-plugin/src/rules/class-literal-property-style.ts b/packages/eslint-plugin/src/rules/class-literal-property-style.ts
@@ -13,7 +13,7 @@ interface NodeWithModifiers {
 
 const printNodeModifiers = (
   node: NodeWithModifiers,
-  final: 'readonly' | 'get',
+  final: 'get' | 'readonly',
 ): string =>
   `${node.accessibility ?? ''}${
     node.static ? ' static' : ''

diff --git a/packages/eslint-plugin/src/rules/comma-spacing.ts b/packages/eslint-plugin/src/rules/comma-spacing.ts
@@ -14,7 +14,7 @@ type Options = [
     after: boolean;
   },
 ];
-type MessageIds = 'unexpected' | 'missing';
+type MessageIds = 'missing' | 'unexpected';
 
 export default createRule<Options, MessageIds>({
   name: 'comma-spacing',

diff --git a/packages/eslint-plugin/src/rules/consistent-generic-constructors.ts b/packages/eslint-plugin/src/rules/consistent-generic-constructors.ts
@@ -3,8 +3,8 @@ import { AST_NODE_TYPES } from '@typescript-eslint/utils';
 
 import { createRule } from '../util';
 
-type MessageIds = 'preferTypeAnnotation' | 'preferConstructor';
-type Options = ['type-annotation' | 'constructor'];
+type MessageIds = 'preferConstructor' | 'preferTypeAnnotation';
+type Options = ['constructor' | 'type-annotation'];
 
 export default createRule<Options, MessageIds>({
   name: 'consistent-generic-constructors',
@@ -35,9 +35,9 @@ export default createRule<Options, MessageIds>({
     return {
       'VariableDeclarator,PropertyDefinition,:matches(FunctionDeclaration,FunctionExpression) > AssignmentPattern'(
         node:
-          | TSESTree.VariableDeclarator
+          | TSESTree.AssignmentPattern
           | TSESTree.PropertyDefinition
-          | TSESTree.AssignmentPattern,
+          | TSESTree.VariableDeclarator,
       ): void {
         function getLHSRHS(): [
           TSESTree.BindingName | TSESTree.PropertyDefinition,
@@ -84,8 +84,8 @@ export default createRule<Options, MessageIds>({
               messageId: 'preferTypeAnnotation',
               fix(fixer) {
                 function getIDToAttachAnnotation():
-                  | TSESTree.Token
-                  | TSESTree.Node {
+                  | TSESTree.Node
+                  | TSESTree.Token {
                   if (node.type !== AST_NODE_TYPES.PropertyDefinition) {
                     return lhsName;
                   }

diff --git a/packages/eslint-plugin/src/rules/consistent-indexed-object-style.ts b/packages/eslint-plugin/src/rules/consistent-indexed-object-style.ts
@@ -3,8 +3,8 @@ import { AST_NODE_TYPES, ASTUtils } from '@typescript-eslint/utils';
 
 import { createRule } from '../util';
 
-type MessageIds = 'preferRecord' | 'preferIndexSignature';
-type Options = ['record' | 'index-signature'];
+type MessageIds = 'preferIndexSignature' | 'preferRecord';
+type Options = ['index-signature' | 'record'];
 
 export default createRule<Options, MessageIds>({
   name: 'consistent-indexed-object-style',
@@ -32,7 +32,7 @@ export default createRule<Options, MessageIds>({
 
     function checkMembers(
       members: TSESTree.TypeElement[],
-      node: TSESTree.TSTypeLiteral | TSESTree.TSInterfaceDeclaration,
+      node: TSESTree.TSInterfaceDeclaration | TSESTree.TSTypeLiteral,
       parentId: TSESTree.Identifier | undefined,
       prefix: string,
       postfix: string,

diff --git a/packages/eslint-plugin/src/rules/consistent-type-assertions.ts b/packages/eslint-plugin/src/rules/consistent-type-assertions.ts
@@ -5,16 +5,16 @@ import * as util from '../util';
 
 // intentionally mirroring the options
 export type MessageIds =
-  | 'as'
   | 'angle-bracket'
+  | 'as'
   | 'never'
-  | 'unexpectedObjectTypeAssertion'
   | 'replaceObjectTypeAssertionWithAnnotation'
-  | 'replaceObjectTypeAssertionWithSatisfies';
+  | 'replaceObjectTypeAssertionWithSatisfies'
+  | 'unexpectedObjectTypeAssertion';
 type OptUnion =
   | {
-      assertionStyle: 'as' | 'angle-bracket';
-      objectLiteralTypeAssertions?: 'allow' | 'allow-as-parameter' | 'never';
+      assertionStyle: 'angle-bracket' | 'as';
+      objectLiteralTypeAssertions?: 'allow-as-parameter' | 'allow' | 'never';
     }
   | {
       assertionStyle: 'never';
@@ -117,7 +117,7 @@ export default util.createRule<Options, MessageIds>({
     }
 
     function reportIncorrectAssertionType(
-      node: TSESTree.TSTypeAssertion | TSESTree.TSAsExpression,
+      node: TSESTree.TSAsExpression | TSESTree.TSTypeAssertion,
     ): void {
       const messageId = options.assertionStyle;
 
@@ -168,7 +168,7 @@ export default util.createRule<Options, MessageIds>({
     }
 
     function checkExpression(
-      node: TSESTree.TSTypeAssertion | TSESTree.TSAsExpression,
+      node: TSESTree.TSAsExpression | TSESTree.TSTypeAssertion,
     ): void {
       if (
         options.assertionStyle === 'never' ||

diff --git a/packages/eslint-plugin/src/rules/consistent-type-exports.ts b/packages/eslint-plugin/src/rules/consistent-type-exports.ts
@@ -25,9 +25,9 @@ interface ReportValueExport {
 }
 
 type MessageIds =
-  | 'typeOverValue'
+  | 'multipleExportsAreTypes'
   | 'singleExportIsType'
-  | 'multipleExportsAreTypes';
+  | 'typeOverValue';
 
 export default util.createRule<Options, MessageIds>({
   name: 'consistent-type-exports',

diff --git a/packages/eslint-plugin/src/rules/consistent-type-imports.ts b/packages/eslint-plugin/src/rules/consistent-type-imports.ts
@@ -3,8 +3,8 @@ import { AST_NODE_TYPES } from '@typescript-eslint/utils';
 
 import * as util from '../util';
 
-type Prefer = 'type-imports' | 'no-type-imports';
-type FixStyle = 'separate-type-imports' | 'inline-type-imports';
+type Prefer = 'no-type-imports' | 'type-imports';
+type FixStyle = 'inline-type-imports' | 'separate-type-imports';
 
 type Options = [
   {
@@ -33,13 +33,13 @@ interface ReportValueImport {
 }
 
 type MessageIds =
-  | 'typeOverValue'
-  | 'someImportsAreOnlyTypes'
+  | 'aImportInDecoMeta'
   | 'aImportIsOnlyTypes'
-  | 'valueOverType'
   | 'noImportTypeAnnotations'
+  | 'someImportsAreOnlyTypes'
   | 'someImportsInDecoMeta'
-  | 'aImportInDecoMeta';
+  | 'typeOverValue'
+  | 'valueOverType';
 export default util.createRule<Options, MessageIds>({
   name: 'consistent-type-imports',
   meta: {

diff --git a/packages/eslint-plugin/src/rules/explicit-function-return-type.ts b/packages/eslint-plugin/src/rules/explicit-function-return-type.ts
@@ -102,8 +102,8 @@ export default util.createRule<Options, MessageIds>({
     function isAllowedFunction(
       node:
         | TSESTree.ArrowFunctionExpression
-        | TSESTree.FunctionExpression
-        | TSESTree.FunctionDeclaration,
+        | TSESTree.FunctionDeclaration
+        | TSESTree.FunctionExpression,
     ): boolean {
       if (options.allowFunctionsWithoutTypeParameters && !node.typeParameters) {
         return true;
@@ -164,8 +164,8 @@ export default util.createRule<Options, MessageIds>({
     function isIIFE(
       node:
         | TSESTree.ArrowFunctionExpression
-        | TSESTree.FunctionExpression
-        | TSESTree.FunctionDeclaration,
+        | TSESTree.FunctionDeclaration
+        | TSESTree.FunctionExpression,
     ): boolean {
       return node.parent.type === AST_NODE_TYPES.CallExpression;
     }

diff --git a/packages/eslint-plugin/src/rules/explicit-member-accessibility.ts b/packages/eslint-plugin/src/rules/explicit-member-accessibility.ts
@@ -23,9 +23,9 @@ interface Config {
 type Options = [Config];
 
 type MessageIds =
-  | 'unwantedPublicAccessibility'
+  | 'addExplicitAccessibility'
   | 'missingAccessibility'
-  | 'addExplicitAccessibility';
+  | 'unwantedPublicAccessibility';
 
 export default util.createRule<Options, MessageIds>({
   name: 'explicit-member-accessibility',

diff --git a/packages/eslint-plugin/src/rules/explicit-module-boundary-types.ts b/packages/eslint-plugin/src/rules/explicit-module-boundary-types.ts
@@ -25,11 +25,11 @@ type Options = [
   },
 ];
 type MessageIds =
-  | 'missingReturnType'
+  | 'anyTypedArg'
+  | 'anyTypedArgUnnamed'
   | 'missingArgType'
   | 'missingArgTypeUnnamed'
-  | 'anyTypedArg'
-  | 'anyTypedArgUnnamed';
+  | 'missingReturnType';
 
 export default util.createRule<Options, MessageIds>({
   name: 'explicit-module-boundary-types',
@@ -154,7 +154,7 @@ export default util.createRule<Options, MessageIds>({
     };
 
     function checkParameters(
-      node: TSESTree.TSEmptyBodyFunctionExpression | FunctionNode,
+      node: FunctionNode | TSESTree.TSEmptyBodyFunctionExpression,
     ): void {
       function checkParameter(param: TSESTree.Parameter): void {
         function report(

diff --git a/packages/eslint-plugin/src/rules/func-call-spacing.ts b/packages/eslint-plugin/src/rules/func-call-spacing.ts
@@ -3,15 +3,15 @@ import type { TSESTree } from '@typescript-eslint/utils';
 import * as util from '../util';
 
 export type Options = [
-  'never' | 'always',
+  'always' | 'never',
   {
     allowNewlines?: boolean;
   }?,
 ];
 export type MessageIds =
-  | 'unexpectedWhitespace'
+  | 'missing'
   | 'unexpectedNewline'
-  | 'missing';
+  | 'unexpectedWhitespace';
 
 export default util.createRule<Options, MessageIds>({
   name: 'func-call-spacing',

diff --git a/packages/eslint-plugin/src/rules/indent.ts b/packages/eslint-plugin/src/rules/indent.ts
@@ -130,12 +130,12 @@ export default util.createRule<Options, MessageIds>({
      */
     function TSPropertySignatureToProperty(
       node:
-        | TSESTree.TSPropertySignature
         | TSESTree.TSEnumMember
+        | TSESTree.TSPropertySignature
         | TSESTree.TypeElement,
       type:
-        | AST_NODE_TYPES.PropertyDefinition
-        | AST_NODE_TYPES.Property = AST_NODE_TYPES.Property,
+        | AST_NODE_TYPES.Property
+        | AST_NODE_TYPES.PropertyDefinition = AST_NODE_TYPES.Property,
     ): TSESTree.Node | null {
       const base = {
         // indent doesn't actually use these