Feb 3, 2024 · Feb 1, 2024 · Feb 3, 2024 · Feb 3, 2024
diff --git a/packages/eslint-plugin-internal/src/index.ts b/packages/eslint-plugin-internal/src/index.ts
 import type { Linter } from '@typescript-eslint/utils/ts-eslint';

 import rules from './rules';

 // note - cannot migrate this to an import statement because it will make TSC copy the package.json to the dist folder
 const { name, version } = require('../package.json') as {
  name: string;
  version: string;
 };

 export = {
  rules,
 };
  meta: {
    name,
    version,
  },
 } satisfies Linter.Plugin;
diff --git a/packages/eslint-plugin-internal/src/rules/index.ts b/packages/eslint-plugin-internal/src/rules/index.ts
 import type { Linter } from '@typescript-eslint/utils/ts-eslint';

 import noPoorlyTypedTsProps from './no-poorly-typed-ts-props';
 import noTypescriptDefaultImport from './no-typescript-default-import';
 import noTypescriptEstreeImport from './no-typescript-estree-import';
  'no-typescript-estree-import': noTypescriptEstreeImport,
  'plugin-test-formatting': pluginTestFormatting,
  'prefer-ast-types-enum': preferASTTypesEnum,
 };
 } satisfies Linter.PluginRules;
diff --git a/packages/eslint-plugin-tslint/src/index.ts b/packages/eslint-plugin-tslint/src/index.ts
 import type { Linter } from '@typescript-eslint/utils/ts-eslint';

 import configRule from './rules/config';

 // note - cannot migrate this to an import statement because it will make TSC copy the package.json to the dist folder
 const { name, version } = require('../package.json') as {
  name: string;
  version: string;
 };

 export const meta: Linter.PluginMeta = {
  name,
  version,
 };

 /**
 * Expose a single rule called "config", which will be accessed in the user's eslint config files
 * via "tslint/config"
 */
 export const rules = {
 export const rules: Linter.PluginRules = {
  config: configRule,
 };
diff --git a/packages/eslint-plugin/src/configs/all.ts b/packages/eslint-plugin/src/configs/all.ts
 // For developers working in the typescript-eslint monorepo:
 // You can regenerate it using `yarn generate:configs`

 import type { ClassicConfig } from '@typescript-eslint/utils/ts-eslint';

 export = {
  extends: ['./configs/base', './configs/eslint-recommended'],
  rules: {
    '@typescript-eslint/unbound-method': 'error',
    '@typescript-eslint/unified-signatures': 'error',
  },
 };
 } satisfies ClassicConfig.Config;
diff --git a/packages/eslint-plugin/src/configs/base.ts b/packages/eslint-plugin/src/configs/base.ts
 // For developers working in the typescript-eslint monorepo:
 // You can regenerate it using `yarn generate:configs`

 import type { ClassicConfig } from '@typescript-eslint/utils/ts-eslint';

 export = {
  parser: '@typescript-eslint/parser',
  parserOptions: { sourceType: 'module' },
  plugins: ['@typescript-eslint'],
 };
 } satisfies ClassicConfig.Config;
diff --git a/packages/eslint-plugin/src/configs/disable-type-checked.ts b/packages/eslint-plugin/src/configs/disable-type-checked.ts
 // For developers working in the typescript-eslint monorepo:
 // You can regenerate it using `yarn generate:configs`

 import type { ClassicConfig } from '@typescript-eslint/utils/ts-eslint';

 export = {
  parserOptions: { project: null, program: null },
  rules: {
    '@typescript-eslint/switch-exhaustiveness-check': 'off',
    '@typescript-eslint/unbound-method': 'off',
  },
 };
 } satisfies ClassicConfig.Config;
diff --git a/packages/eslint-plugin/src/configs/eslint-recommended.ts b/packages/eslint-plugin/src/configs/eslint-recommended.ts
 * - disables rules from eslint:recommended which are already handled by TypeScript.
 * - enables rules that make sense due to TS's typechecking / transpilation.
 */
 import type { ClassicConfig } from '@typescript-eslint/utils/ts-eslint';

 export = {
  overrides: [
    {
      },
    },
  ],
 };
 } satisfies ClassicConfig.Config;
diff --git a/packages/eslint-plugin/src/configs/recommended-type-checked.ts b/packages/eslint-plugin/src/configs/recommended-type-checked.ts
 // For developers working in the typescript-eslint monorepo:
 // You can regenerate it using `yarn generate:configs`

 import type { ClassicConfig } from '@typescript-eslint/utils/ts-eslint';

 export = {
  extends: ['./configs/base', './configs/eslint-recommended'],
  rules: {
    '@typescript-eslint/triple-slash-reference': 'error',
    '@typescript-eslint/unbound-method': 'error',
  },
 };
 } satisfies ClassicConfig.Config;
diff --git a/packages/eslint-plugin/src/configs/recommended.ts b/packages/eslint-plugin/src/configs/recommended.ts
 // For developers working in the typescript-eslint monorepo:
 // You can regenerate it using `yarn generate:configs`

 import type { ClassicConfig } from '@typescript-eslint/utils/ts-eslint';

 export = {
  extends: ['./configs/base', './configs/eslint-recommended'],
  rules: {
    '@typescript-eslint/prefer-as-const': 'error',
    '@typescript-eslint/triple-slash-reference': 'error',
  },
 };
 } satisfies ClassicConfig.Config;
diff --git a/packages/eslint-plugin/src/configs/strict-type-checked.ts b/packages/eslint-plugin/src/configs/strict-type-checked.ts
 // For developers working in the typescript-eslint monorepo:
 // You can regenerate it using `yarn generate:configs`

 import type { ClassicConfig } from '@typescript-eslint/utils/ts-eslint';

 export = {
  extends: ['./configs/base', './configs/eslint-recommended'],
  rules: {
    '@typescript-eslint/unbound-method': 'error',
    '@typescript-eslint/unified-signatures': 'error',
  },
 };
 } satisfies ClassicConfig.Config;
diff --git a/packages/eslint-plugin/src/configs/strict.ts b/packages/eslint-plugin/src/configs/strict.ts
 // For developers working in the typescript-eslint monorepo:
 // You can regenerate it using `yarn generate:configs`

 import type { ClassicConfig } from '@typescript-eslint/utils/ts-eslint';

 export = {
  extends: ['./configs/base', './configs/eslint-recommended'],
  rules: {
    '@typescript-eslint/triple-slash-reference': 'error',
    '@typescript-eslint/unified-signatures': 'error',
  },
 };
 } satisfies ClassicConfig.Config;
diff --git a/packages/eslint-plugin/src/configs/stylistic-type-checked.ts b/packages/eslint-plugin/src/configs/stylistic-type-checked.ts
 // For developers working in the typescript-eslint monorepo:
 // You can regenerate it using `yarn generate:configs`

 import type { ClassicConfig } from '@typescript-eslint/utils/ts-eslint';

 export = {
  extends: ['./configs/base', './configs/eslint-recommended'],
  rules: {
    '@typescript-eslint/prefer-optional-chain': 'error',
    '@typescript-eslint/prefer-string-starts-ends-with': 'error',
  },
 };
 } satisfies ClassicConfig.Config;
diff --git a/packages/eslint-plugin/src/configs/stylistic.ts b/packages/eslint-plugin/src/configs/stylistic.ts
 // For developers working in the typescript-eslint monorepo:
 // You can regenerate it using `yarn generate:configs`

 import type { ClassicConfig } from '@typescript-eslint/utils/ts-eslint';

 export = {
  extends: ['./configs/base', './configs/eslint-recommended'],
  rules: {
    '@typescript-eslint/prefer-function-type': 'error',
    '@typescript-eslint/prefer-namespace-keyword': 'error',
  },
 };
 } satisfies ClassicConfig.Config;
diff --git a/packages/eslint-plugin/src/index.ts b/packages/eslint-plugin/src/index.ts
 import type { Linter } from '@typescript-eslint/utils/ts-eslint';

 import all from './configs/all';
 import base from './configs/base';
 import disableTypeChecked from './configs/disable-type-checked';
 import stylisticTypeChecked from './configs/stylistic-type-checked';
 import rules from './rules';

 // note - cannot migrate this to an import statement because it will make TSC copy the package.json to the dist folder
 const { name, version } = require('../package.json') as {
  name: string;
  version: string;
 };

 export = {
  configs: {
    all,
    stylistic,
    'stylistic-type-checked': stylisticTypeChecked,
  },
  meta: {
    name,
    version,
  },
  rules,
 };
 } satisfies Linter.Plugin;
diff --git a/packages/eslint-plugin/src/rules/index.ts b/packages/eslint-plugin/src/rules/index.ts
 import type { Linter } from '@typescript-eslint/utils/ts-eslint';

 import adjacentOverloadSignatures from './adjacent-overload-signatures';
 import arrayType from './array-type';
 import awaitThenable from './await-thenable';
  typedef: typedef,
  'unbound-method': unboundMethod,
  'unified-signatures': unifiedSignatures,
 };
 } satisfies Linter.PluginRules;
diff --git a/packages/repo-tools/src/generate-configs.mts b/packages/repo-tools/src/generate-configs.mts
    console.log(chalk.blueBright(`\n${hyphens} ${name}.ts ${hyphens}`));

    // note: we use `export =` because ESLint will import these configs via a commonjs import
    const code = `export = ${JSON.stringify(getConfig())};`;
    const code = [
      "import type { ClassicConfig } from '@typescript-eslint/utils/ts-eslint';",
      '',
      `export = ${JSON.stringify(getConfig())} satisfies ClassicConfig.Config;`,
    ].join('\n');
    const configStr = await prettier.format(addAutoGeneratedComment(code), {
      parser: 'typescript',
      ...prettierConfig,
diff --git a/packages/utils/src/ts-eslint/Config.ts b/packages/utils/src/ts-eslint/Config.ts
  }

  export type ParserOptions = ParserOptionsTypes.ParserOptions;

  export interface PluginMeta {
    /**
     * The meta.name property should match the npm package name for your plugin.
     */
    name: string;
    /**
     * The meta.version property should match the npm package version for your plugin.
     */
    version: string;
  }
 }

 export namespace ClassicConfig {
  export type GlobalsConfig = SharedConfig.GlobalsConfig;
  export type Parser = ParserType.LooseParserModule;
  export type ParserOptions = SharedConfig.ParserOptions;
  export type PluginMeta = SharedConfig.PluginMeta;
  export type Processor = ProcessorType.ProcessorModule;
  export type RuleEntry = SharedConfig.RuleEntry;
  export type RuleLevel = SharedConfig.RuleLevel;
  export interface SharedConfigs {
    [key: string]: Config;
  }
  export interface PluginMeta {
    /**
     * The meta.name property should match the npm package name for your plugin.
     */
    name: string;
    /**
     * The meta.version property should match the npm package version for your plugin.
     */
    version: string;
  }
  export interface Plugin {
    /**
     * Shared configurations bundled with the plugin.
diff --git a/packages/utils/src/ts-eslint/Linter.ts b/packages/utils/src/ts-eslint/Linter.ts
 import type { ClassicConfig, FlatConfig, SharedConfig } from './Config';
 import type { Parser } from './Parser';
 import type { Processor as ProcessorType } from './Processor';
 import type { RuleCreateFunction, RuleFix, RuleModule } from './Rule';
 import type {
  AnyRuleCreateFunction,
  AnyRuleModule,
  RuleCreateFunction,
  RuleFix,
  RuleModule,
 } from './Rule';
 import type { SourceCode } from './SourceCode';

 export type MinimalRuleModule<
  export type GlobalVariableOption = SharedConfig.GlobalVariableOption;
  export type GlobalVariableOptionBase = SharedConfig.GlobalVariableOptionBase;
  export type ParserOptions = SharedConfig.ParserOptions;
  export type PluginMeta = SharedConfig.PluginMeta;
  export type RuleEntry = SharedConfig.RuleEntry;
  export type RuleLevel = SharedConfig.RuleLevel;
  export type RuleLevelAndOptions = SharedConfig.RuleLevelAndOptions;
    parserOptions?: ParserOptions;
  }

  // TODO - RuleCreateFunction is no longer supported in ESLint v9
  export type LegacyPluginRules = Record<
    string,
    AnyRuleCreateFunction | AnyRuleModule
  >;
  export type PluginRules = Record<string, AnyRuleModule>;

  export interface Plugin {
    /**
     * The definition of plugin configs.
     * The definition of plugin environments.
     */
    environments?: Record<string, Environment>;
    /**
     * Metadata about your plugin for easier debugging and more effective caching of plugins.
     */
    meta?: PluginMeta;
    /**
     * The definition of plugin processors.
     */
    processors?: Record<string, ProcessorType.ProcessorModule>;
    /**
     * The definition of plugin rules.
     */
    rules?:Record<string, RuleCreateFunction | RuleModule<string, unknown[]>>;
    rules?:LegacyPluginRules;
  }
 }
Original file line number	Diff line number	Diff line change
		@@ -1,5 +1,17 @@
		import type { Linter } from '@typescript-eslint/utils/ts-eslint';

		import rules from './rules';

		// note - cannot migrate this to an import statement because it will make TSC copy the package.json to the dist folder
		const { name, version } = require('../package.json') as {
		name: string;
		version: string;
		};

		export = {
		rules,
		};
		meta: {
		name,
		version,
		},
		} satisfies Linter.Plugin;
Original file line number	Diff line number	Diff line change
		@@ -1,3 +1,5 @@
		import type { Linter } from '@typescript-eslint/utils/ts-eslint';

		import noPoorlyTypedTsProps from './no-poorly-typed-ts-props';
		import noTypescriptDefaultImport from './no-typescript-default-import';
		import noTypescriptEstreeImport from './no-typescript-estree-import';
Expand All		@@ -10,4 +12,4 @@ export default {
		'no-typescript-estree-import': noTypescriptEstreeImport,
		'plugin-test-formatting': pluginTestFormatting,
		'prefer-ast-types-enum': preferASTTypesEnum,
		};
		} satisfies Linter.PluginRules;
Original file line number	Diff line number	Diff line change
		@@ -1,9 +1,22 @@
		import type { Linter } from '@typescript-eslint/utils/ts-eslint';

		import configRule from './rules/config';

		// note - cannot migrate this to an import statement because it will make TSC copy the package.json to the dist folder
		const { name, version } = require('../package.json') as {
		name: string;
		version: string;
		};

		export const meta: Linter.PluginMeta = {
		name,
		version,
		};

		/**
		* Expose a single rule called "config", which will be accessed in the user's eslint config files
		* via "tslint/config"
		*/
		export const rules = {
		export const rules: Linter.PluginRules = {
		config: configRule,
		};
Original file line number	Diff line number	Diff line change
Expand Up		@@ -5,6 +5,8 @@
		// For developers working in the typescript-eslint monorepo:
		// You can regenerate it using `yarn generate:configs`

		import type { ClassicConfig } from '@typescript-eslint/utils/ts-eslint';

		export = {
		extends: ['./configs/base', './configs/eslint-recommended'],
		rules: {
Expand DownExpand Up		@@ -151,4 +153,4 @@ export = {
		'@typescript-eslint/unbound-method': 'error',
		'@typescript-eslint/unified-signatures': 'error',
		},
		};
		} satisfies ClassicConfig.Config;
Original file line number	Diff line number	Diff line change
Expand Up		@@ -5,8 +5,10 @@
		// For developers working in the typescript-eslint monorepo:
		// You can regenerate it using `yarn generate:configs`

		import type { ClassicConfig } from '@typescript-eslint/utils/ts-eslint';

		export = {
		parser: '@typescript-eslint/parser',
		parserOptions: { sourceType: 'module' },
		plugins: ['@typescript-eslint'],
		};
		} satisfies ClassicConfig.Config;
Original file line number	Diff line number	Diff line change
Expand Up		@@ -3,6 +3,8 @@
		* - disables rules from eslint:recommended which are already handled by TypeScript.
		* - enables rules that make sense due to TS's typechecking / transpilation.
		*/
		import type { ClassicConfig } from '@typescript-eslint/utils/ts-eslint';

		export = {
		overrides: [
		{
Expand DownExpand Up		@@ -31,4 +33,4 @@ export = {
		},
		},
		],
		};
		} satisfies ClassicConfig.Config;
Original file line number	Diff line number	Diff line change
		@@ -1,3 +1,5 @@
		import type { Linter } from '@typescript-eslint/utils/ts-eslint';

		import all from './configs/all';
		import base from './configs/base';
		import disableTypeChecked from './configs/disable-type-checked';
Expand All		@@ -10,6 +12,12 @@ import stylistic from './configs/stylistic';
		import stylisticTypeChecked from './configs/stylistic-type-checked';
		import rules from './rules';

		// note - cannot migrate this to an import statement because it will make TSC copy the package.json to the dist folder
		const { name, version } = require('../package.json') as {
		name: string;
		version: string;
		};

		export = {
		configs: {
		all,
Expand All		@@ -25,5 +33,9 @@ export = {
		stylistic,
		'stylistic-type-checked': stylisticTypeChecked,
		},
		meta: {
		name,
		version,
		},
		rules,
		};
		} satisfies Linter.Plugin;
Original file line number	Diff line number	Diff line change
		@@ -1,3 +1,5 @@
		import type { Linter } from '@typescript-eslint/utils/ts-eslint';

		import adjacentOverloadSignatures from './adjacent-overload-signatures';
		import arrayType from './array-type';
		import awaitThenable from './await-thenable';
Expand DownExpand Up		@@ -278,4 +280,4 @@ export default {
		typedef: typedef,
		'unbound-method': unboundMethod,
		'unified-signatures': unifiedSignatures,
		};
		} satisfies Linter.PluginRules;
Original file line number	Diff line number	Diff line change
Expand Up		@@ -142,7 +142,11 @@ async function main(): Promise<void> {
		console.log(chalk.blueBright(`\n${hyphens} ${name}.ts ${hyphens}`));

		// note: we use `export =` because ESLint will import these configs via a commonjs import
		const code = `export = ${JSON.stringify(getConfig())};`;
		const code = [
		"import type { ClassicConfig } from '@typescript-eslint/utils/ts-eslint';",
		'',
		`export = ${JSON.stringify(getConfig())} satisfies ClassicConfig.Config;`,
		].join('\n');
		const configStr = await prettier.format(addAutoGeneratedComment(code), {
		parser: 'typescript',
		...prettierConfig,
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -31,6 +31,17 @@ export namespace SharedConfig {
		}

		export type ParserOptions = ParserOptionsTypes.ParserOptions;

		export interface PluginMeta {
		/**
		* The meta.name property should match the npm package name for your plugin.
		*/
		name: string;
		/**
		* The meta.version property should match the npm package version for your plugin.
		*/
		version: string;
		}
		}

		export namespace ClassicConfig {
Expand DownExpand Up		@@ -121,6 +132,7 @@ export namespace FlatConfig {
		export type GlobalsConfig = SharedConfig.GlobalsConfig;
		export type Parser = ParserType.LooseParserModule;
		export type ParserOptions = SharedConfig.ParserOptions;
		export type PluginMeta = SharedConfig.PluginMeta;
		export type Processor = ProcessorType.ProcessorModule;
		export type RuleEntry = SharedConfig.RuleEntry;
		export type RuleLevel = SharedConfig.RuleLevel;
Expand All		@@ -134,16 +146,6 @@ export namespace FlatConfig {
		export interface SharedConfigs {
		[key: string]: Config;
		}
		export interface PluginMeta {
		/**
		* The meta.name property should match the npm package name for your plugin.
		*/
		name: string;
		/**
		* The meta.version property should match the npm package version for your plugin.
		*/
		version: string;
		}
		export interface Plugin {
		/**
		* Shared configurations bundled with the plugin.
Expand Down