Feb 12, 2024 · Feb 12, 2024 · Feb 12, 2024 · Feb 13, 2024 · Feb 13, 2024 · Feb 13, 2024
diff --git a/packages/ast-spec/src/declaration/ExportAndImportKind.ts b/packages/ast-spec/src/declaration/ExportAndImportKind.ts
 type ExportAndImportKind = 'type' | 'value';
 exporttype ExportAndImportKind = 'type' | 'value';

 export type ExportKind = ExportAndImportKind;
 export type ImportKind = ExportAndImportKind;
diff --git a/packages/ast-spec/tests/util/parsers/parser-types.ts b/packages/ast-spec/tests/util/parsers/parser-types.ts
 type SnapshotPathFn = (i: number) => string;
 exporttype SnapshotPathFn = (i: number) => string;

 interface SuccessSnapshotPaths {
 exportinterface SuccessSnapshotPaths {
  readonly ast: SnapshotPathFn;
  readonly tokens: SnapshotPathFn;
 }
diff --git a/packages/eslint-plugin-internal/src/rules/plugin-test-formatting.ts b/packages/eslint-plugin-internal/src/rules/plugin-test-formatting.ts
  return fixed;
 }

 type Options = [
 exporttype Options = [
  {
    // This option exists so that rules like type-annotation-spacing can exist without every test needing a prettier-ignore
    formatWithPrettier?: boolean;
  },
 ];

 type MessageIds =
 exporttype MessageIds =
  | 'invalidFormatting'
  | 'invalidFormattingErrorTest'
  | 'noUnnecessaryNoFormat'
diff --git a/packages/eslint-plugin/docs/rules/require-types-exports.mdx b/packages/eslint-plugin/docs/rules/require-types-exports.mdx
 ---
 description: 'Require exporting types that are used in exported entities.'
 ---

 import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';

 > 🛑 This file is source code, not the primary documentation location! 🛑
 >
 > See **https://typescript-eslint.io/rules/require-types-exports** for documentation.

 When exporting entities from a file, it is often useful to export also all the types that are used in their declarations.
 Doing so ensures consumers of the file can directly import and use those types when using those entities.

 Otherwise, consumers may have to use utility types like [`Parameters`](https://www.typescriptlang.org/docs/handbook/utility-types.html#parameterstype) or [`ReturnType`](https://www.typescriptlang.org/docs/handbook/utility-types.html#returntypetype) in order to extract the types from the entities.

 ## Examples

 <Tabs>
 <TabItem value="❌ Incorrect">

 ```ts
 interface Fruit {
  name: string;
  color: string;
 }

 export const getFruitName = (fruit: Fruit) => fruit.name;
 ```

 ```ts
 const fruits = {
  apple: '🍏',
  banana: '🍌',
 };

 export const getFruit = (key: keyof typeof fruits) => fruits[key];
 ```

 ```ts
 enum Color {
  Red = 'red',
  Green = 'green',
  Blue = 'blue',
 }

 export declare function getRandomColor(): Color;
 ```

 </TabItem>
 <TabItem value="✅ Correct">

 ```ts
 export interface Fruit {
  name: string;
  color: string;
 }

 export const getFruitName = (fruit: Fruit) => fruit.name;
 ```

 ```ts
 export const fruits = {
  apple: '🍏',
  banana: '🍌',
 };

 export const getFruit = (key: keyof typeof fruits) => fruits[key];
 ```

 ```ts
 export enum Color {
  Red = 'red',
  Green = 'green',
  Blue = 'blue',
 }

 export declare function getRandomColor(): Color;
 ```

 </TabItem>
 </Tabs>

 ## When Not To Use It

 If your files utilize many complex self-referential types that you don't want external consumers to reference, you may want to avoid this rule for those cases.
 You might consider using [ESLint disable comments](https://eslint.org/docs/latest/use/configure/rules#using-configuration-comments-1) for those specific situations instead of completely disabling this rule.
diff --git a/packages/eslint-plugin/src/configs/all.ts b/packages/eslint-plugin/src/configs/all.ts
    '@typescript-eslint/require-array-sort-compare': 'error',
    'require-await': 'off',
    '@typescript-eslint/require-await': 'error',
    '@typescript-eslint/require-types-exports': 'error',
    '@typescript-eslint/restrict-plus-operands': 'error',
    '@typescript-eslint/restrict-template-expressions': 'error',
    'no-return-await': 'off',
diff --git a/packages/eslint-plugin/src/configs/disable-type-checked.ts b/packages/eslint-plugin/src/configs/disable-type-checked.ts
 importtype{ClassicConfig}from'@typescript-eslint/utils/ts-eslint';

 export={
 parserOptions:{project:false,program:null,projectService:false},
 parserOptions:{program:null,project:false,projectService:false},
 rules:{
 '@typescript-eslint/await-thenable':'off',
 '@typescript-eslint/consistent-return':'off',
diff --git a/packages/eslint-plugin/src/configs/strict-type-checked-only.ts b/packages/eslint-plugin/src/configs/strict-type-checked-only.ts
 {
 allowAny:false,
 allowBoolean:false,
 allowNever:false,
 allowNullish:false,
 allowNumber:false,
 allowRegExp:false,
 allowNever:false,
 },
 ],
 'no-return-await':'off',
diff --git a/packages/eslint-plugin/src/configs/strict-type-checked.ts b/packages/eslint-plugin/src/configs/strict-type-checked.ts
    '@typescript-eslint/related-getter-setter-pairs': 'error',
    'require-await': 'off',
    '@typescript-eslint/require-await': 'error',
    '@typescript-eslint/require-types-exports': 'error',
    '@typescript-eslint/restrict-plus-operands': [
      'error',
      {
diff --git a/packages/eslint-plugin/src/configs/strict.ts b/packages/eslint-plugin/src/configs/strict.ts
    '@typescript-eslint/prefer-as-const': 'error',
    '@typescript-eslint/prefer-literal-enum-member': 'error',
    '@typescript-eslint/prefer-namespace-keyword': 'error',
    '@typescript-eslint/require-types-exports': 'error',
    '@typescript-eslint/triple-slash-reference': 'error',
    '@typescript-eslint/unified-signatures': 'error',
  },
diff --git a/packages/eslint-plugin/src/rules/array-type.ts b/packages/eslint-plugin/src/rules/array-type.ts
 }

 export type OptionString = 'array' | 'array-simple' | 'generic';
 type Options = [
 exporttype Options = [
  {
    default: OptionString;
    readonly?: OptionString;
  },
 ];
 type MessageIds =
 exporttype MessageIds =
  | 'errorStringArray'
  | 'errorStringArrayReadonly'
  | 'errorStringArraySimple'
diff --git a/packages/eslint-plugin/src/rules/await-thenable.ts b/packages/eslint-plugin/src/rules/await-thenable.ts
 } from '../util';
 import { getForStatementHeadLoc } from '../util/getForStatementHeadLoc';

 type MessageId =
 exporttype MessageId =
  | 'await'
  | 'awaitUsingOfNonAsyncDisposable'
  | 'convertToOrdinaryFor'
diff --git a/packages/eslint-plugin/src/rules/ban-ts-comment.ts b/packages/eslint-plugin/src/rules/ban-ts-comment.ts

 import { createRule, getStringLength, nullThrows } from '../util';

 type DirectiveConfig =
 exporttype DirectiveConfig =
  | boolean
  | 'allow-with-description'
  | { descriptionFormat: string };

 interface Options {
 exportinterface Options {
  minimumDescriptionLength?: number;
  'ts-check'?: DirectiveConfig;
  'ts-expect-error'?: DirectiveConfig;

 const defaultMinimumDescriptionLength = 3;

 type MessageIds =
 exporttype MessageIds =
  | 'replaceTsIgnoreWithTsExpectError'
  | 'tsDirectiveComment'
  | 'tsDirectiveCommentDescriptionNotMatchPattern'
diff --git a/packages/eslint-plugin/src/rules/class-literal-property-style.ts b/packages/eslint-plugin/src/rules/class-literal-property-style.ts
 nullThrows,
 }from'../util';

 typeOptions=['fields'|'getters'];
 typeMessageIds=
 exporttypeOptions=['fields'|'getters'];
 exporttypeMessageIds=
 |'preferFieldStyle'
 |'preferFieldStyleSuggestion'
 |'preferGetterStyle'
diff --git a/packages/eslint-plugin/src/rules/class-methods-use-this.ts b/packages/eslint-plugin/src/rules/class-methods-use-this.ts
  getStaticMemberAccessValue,
 } from '../util';

 type Options = [
 exporttype Options = [
  {
    enforceForClassFields?: boolean;
    exceptMethods?: string[];
    ignoreClassesThatImplementAnInterface?: boolean | 'public-fields';
    ignoreOverrideMethods?: boolean;
  },
 ];
 type MessageIds = 'missingThis';
 exporttype MessageIds = 'missingThis';

 export default createRule<Options, MessageIds>({
  name: 'class-methods-use-this',
diff --git a/packages/eslint-plugin/src/rules/consistent-generic-constructors.ts b/packages/eslint-plugin/src/rules/consistent-generic-constructors.ts

 import{createRule,nullThrows,NullThrowsReasons}from'../util';

 typeMessageIds='preferConstructor'|'preferTypeAnnotation';
 typeOptions=['constructor'|'type-annotation'];
 exporttypeMessageIds='preferConstructor'|'preferTypeAnnotation';
 exporttypeOptions=['constructor'|'type-annotation'];

 exportdefaultcreateRule<Options,MessageIds>({
 name:'consistent-generic-constructors',
diff --git a/packages/eslint-plugin/src/rules/consistent-indexed-object-style.ts b/packages/eslint-plugin/src/rules/consistent-indexed-object-style.ts
  nullThrows,
 } from '../util';

 type MessageIds =
 exporttype MessageIds =
  | 'preferIndexSignature'
  | 'preferIndexSignatureSuggestion'
  | 'preferRecord';
 type Options = ['index-signature' | 'record'];
 exporttype Options = ['index-signature' | 'record'];

 export default createRule<Options, MessageIds>({
  name: 'consistent-indexed-object-style',
diff --git a/packages/eslint-plugin/src/rules/consistent-return.ts b/packages/eslint-plugin/src/rules/consistent-return.ts

 const baseRule = getESLintCoreRule('consistent-return');

 type Options = InferOptionsTypeFromRule<typeof baseRule>;
 type MessageIds = InferMessageIdsTypeFromRule<typeof baseRule>;
 exporttype Options = InferOptionsTypeFromRule<typeof baseRule>;
 exporttype MessageIds = InferMessageIdsTypeFromRule<typeof baseRule>;

 type FunctionNode =
 exporttype FunctionNode =
  | TSESTree.ArrowFunctionExpression
  | TSESTree.FunctionDeclaration
  | TSESTree.FunctionExpression;
diff --git a/packages/eslint-plugin/src/rules/consistent-type-assertions.ts b/packages/eslint-plugin/src/rules/consistent-type-assertions.ts
  | 'replaceObjectTypeAssertionWithAnnotation'
  | 'replaceObjectTypeAssertionWithSatisfies'
  | 'unexpectedObjectTypeAssertion';
 type OptUnion =
 exporttype OptUnion =
  | {
      assertionStyle: 'angle-bracket' | 'as';
      objectLiteralTypeAssertions?: 'allow' | 'allow-as-parameter' | 'never';
diff --git a/packages/eslint-plugin/src/rules/consistent-type-exports.ts b/packages/eslint-plugin/src/rules/consistent-type-exports.ts
  NullThrowsReasons,
 } from '../util';

 type Options = [
 exporttype Options = [
  {
    fixMixedExportsWithInlineTypeSpecifier: boolean;
  },
  valueSpecifiers: TSESTree.ExportSpecifier[];
 }

 type MessageIds =
 exporttype MessageIds =
  | 'multipleExportsAreTypes'
  | 'singleExportIsType'
  | 'typeOverValue';
diff --git a/packages/eslint-plugin/src/rules/consistent-type-imports.ts b/packages/eslint-plugin/src/rules/consistent-type-imports.ts
  NullThrowsReasons,
 } from '../util';

 type Prefer = 'no-type-imports' | 'type-imports';
 type FixStyle = 'inline-type-imports' | 'separate-type-imports';
 exporttype Prefer = 'no-type-imports' | 'type-imports';
 exporttype FixStyle = 'inline-type-imports' | 'separate-type-imports';

 type Options = [
 exporttype Options = [
  {
    disallowTypeAnnotations?: boolean;
    fixStyle?: FixStyle;
  valueSpecifiers: TSESTree.ImportClause[];
 }

 type MessageIds =
 exporttype MessageIds =
  | 'avoidImportType'
  | 'noImportTypeAnnotations'
  | 'someImportsAreOnlyTypes'
diff --git a/packages/eslint-plugin/src/rules/explicit-function-return-type.ts b/packages/eslint-plugin/src/rules/explicit-function-return-type.ts
 isValidFunctionExpressionReturnType,
 }from'../util/explicitReturnTypeUtils';

 typeOptions=[
 exporttypeOptions=[
 {
 allowConciseArrowFunctionExpressionsStartingWithVoid?:boolean;
 allowDirectConstAssertionInArrowFunctions?:boolean;
 allowTypedFunctionExpressions?:boolean;
 },
 ];
 typeMessageIds='missingReturnType';
 exporttypeMessageIds='missingReturnType';

 typeFunctionNode=
 |TSESTree.ArrowFunctionExpression
diff --git a/packages/eslint-plugin/src/rules/explicit-member-accessibility.ts b/packages/eslint-plugin/src/rules/explicit-member-accessibility.ts
 } from '../util/getMemberHeadLoc';
 import { rangeToLoc } from '../util/rangeToLoc';

 type AccessibilityLevel =
 exporttype AccessibilityLevel =
  | 'explicit' // require an accessor (including public)
  | 'no-public' // don't require public
  | 'off'; // don't check

 interface Config {
 exportinterface Config {
  accessibility?: AccessibilityLevel;
  ignoredMethodNames?: string[];
  overrides?: {
  };
 }

 type Options = [Config];
 exporttype Options = [Config];

 type MessageIds =
 exporttype MessageIds =
  | 'addExplicitAccessibility'
  | 'missingAccessibility'
  | 'unwantedPublicAccessibility';
diff --git a/packages/eslint-plugin/src/rules/explicit-module-boundary-types.ts b/packages/eslint-plugin/src/rules/explicit-module-boundary-types.ts
  isTypedFunctionExpression,
 } from '../util/explicitReturnTypeUtils';

 type Options = [
 exporttype Options = [
  {
    allowArgumentsExplicitlyTypedAsAny?: boolean;
    allowDirectConstAssertionInArrowFunctions?: boolean;
    allowTypedFunctionExpressions?: boolean;
  },
 ];
 type MessageIds =
 exporttype MessageIds =
  | 'anyTypedArg'
  | 'anyTypedArgUnnamed'
  | 'missingArgType'
Original file line number	Diff line number	Diff line change
		@@ -1,4 +1,4 @@
		type ExportAndImportKind = 'type' \| 'value';
		exporttype ExportAndImportKind = 'type' \| 'value';

		export type ExportKind = ExportAndImportKind;
		export type ImportKind = ExportAndImportKind;
Original file line number	Diff line number	Diff line change
		@@ -1,6 +1,6 @@
		type SnapshotPathFn = (i: number) => string;
		exporttype SnapshotPathFn = (i: number) => string;

		interface SuccessSnapshotPaths {
		exportinterface SuccessSnapshotPaths {
		readonly ast: SnapshotPathFn;
		readonly tokens: SnapshotPathFn;
		}
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -87,14 +87,14 @@ function escapeTemplateString(code: string): string {
		return fixed;
		}

		type Options = [
		exporttype Options = [
		{
		// This option exists so that rules like type-annotation-spacing can exist without every test needing a prettier-ignore
		formatWithPrettier?: boolean;
		},
		];

		type MessageIds =
		exporttype MessageIds =
		\| 'invalidFormatting'
		\| 'invalidFormattingErrorTest'
		\| 'noUnnecessaryNoFormat'
Expand Down
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,87 @@
		---
		description: 'Require exporting types that are used in exported entities.'
		---

		import Tabs from '@theme/Tabs';
		import TabItem from '@theme/TabItem';

		> 🛑 This file is source code, not the primary documentation location! 🛑
		>
		> See https://typescript-eslint.io/rules/require-types-exports for documentation.

		When exporting entities from a file, it is often useful to export also all the types that are used in their declarations.
		Doing so ensures consumers of the file can directly import and use those types when using those entities.

		Otherwise, consumers may have to use utility types like [`Parameters`](https://www.typescriptlang.org/docs/handbook/utility-types.html#parameterstype) or [`ReturnType`](https://www.typescriptlang.org/docs/handbook/utility-types.html#returntypetype) in order to extract the types from the entities.

		## Examples

		<Tabs>
		<TabItem value="❌ Incorrect">

		```ts
		interface Fruit {
		name: string;
		color: string;
		}

		export const getFruitName = (fruit: Fruit) => fruit.name;
		```

		```ts
		const fruits = {
		apple: '🍏',
		banana: '🍌',
		};

		export const getFruit = (key: keyof typeof fruits) => fruits[key];
		```

		```ts
		enum Color {
		Red = 'red',
		Green = 'green',
		Blue = 'blue',
		}

		export declare function getRandomColor(): Color;
		```

		</TabItem>
		<TabItem value="✅ Correct">

		```ts
		export interface Fruit {
		name: string;
		color: string;
		}

		export const getFruitName = (fruit: Fruit) => fruit.name;
		```

		```ts
		export const fruits = {
		apple: '🍏',
		banana: '🍌',
		};

		export const getFruit = (key: keyof typeof fruits) => fruits[key];
		```

		```ts
		export enum Color {
		Red = 'red',
		Green = 'green',
		Blue = 'blue',
		}

		export declare function getRandomColor(): Color;
		```

		</TabItem>
		</Tabs>

		## When Not To Use It

		If your files utilize many complex self-referential types that you don't want external consumers to reference, you may want to avoid this rule for those cases.
		You might consider using [ESLint disable comments](https://eslint.org/docs/latest/use/configure/rules#using-configuration-comments-1) for those specific situations instead of completely disabling this rule.
Original file line number	Diff line number	Diff line change
Expand Up		@@ -147,6 +147,7 @@ export = {
		'@typescript-eslint/require-array-sort-compare': 'error',
		'require-await': 'off',
		'@typescript-eslint/require-await': 'error',
		'@typescript-eslint/require-types-exports': 'error',
		'@typescript-eslint/restrict-plus-operands': 'error',
		'@typescript-eslint/restrict-template-expressions': 'error',
		'no-return-await': 'off',
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -8,7 +8,7 @@
		importtype{ClassicConfig}from'@typescript-eslint/utils/ts-eslint';

		export={
		parserOptions:{project:false,program:null,projectService:false},
		parserOptions:{program:null,project:false,projectService:false},
		rules:{
		'@typescript-eslint/await-thenable':'off',
		'@typescript-eslint/consistent-return':'off',
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -61,10 +61,10 @@ export = {
		{
		allowAny:false,
		allowBoolean:false,
		allowNever:false,
		allowNullish:false,
		allowNumber:false,
		allowRegExp:false,
		allowNever:false,
		},
		],
		'no-return-await':'off',
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -79,6 +79,7 @@ export = {
		'@typescript-eslint/related-getter-setter-pairs': 'error',
		'require-await': 'off',
		'@typescript-eslint/require-await': 'error',
		'@typescript-eslint/require-types-exports': 'error',
		'@typescript-eslint/restrict-plus-operands': [
		'error',
		{
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -43,6 +43,7 @@ export = {
		'@typescript-eslint/prefer-as-const': 'error',
		'@typescript-eslint/prefer-literal-enum-member': 'error',
		'@typescript-eslint/prefer-namespace-keyword': 'error',
		'@typescript-eslint/require-types-exports': 'error',
		'@typescript-eslint/triple-slash-reference': 'error',
		'@typescript-eslint/unified-signatures': 'error',
		},
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -73,13 +73,13 @@ function typeNeedsParentheses(node: TSESTree.Node): boolean {
		}

		export type OptionString = 'array' \| 'array-simple' \| 'generic';
		type Options = [
		exporttype Options = [
		{
		default: OptionString;
		readonly?: OptionString;
		},
		];
		type MessageIds =
		exporttype MessageIds =
		\| 'errorStringArray'
		\| 'errorStringArrayReadonly'
		\| 'errorStringArraySimple'
Expand Down