feat(eslint-plugin): add *-type-checked-only configs (#8367)

typescript-eslint · Feb 22, 2024 · 13429cc · 13429cc
1 parent 813ad93
commit 13429cc
Show file tree

Hide file tree

Showing 8 changed files with 302 additions and 2 deletions.
diff --git a/docs/users/Shared_Configurations.mdx b/docs/users/Shared_Configurations.mdx
@@ -390,6 +390,45 @@ This config is automatically included if you use any of the recommended configur
 
 See [`configs/eslint-recommended.ts`](https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/src/configs/eslint-recommended.ts) for the exact contents of this config.
 
+### `recommended-type-checked-only`
+
+A version of `recommended` that _only_ contains type-checked rules and disables of any corresponding core ESLint rules.
+This config plus `recommended` is equivalent to `recommended-type-checked`.
+
+```js title=".eslintrc.js"
+module.exports = {
+  extends: ['plugin:@typescript-eslint/recommended-type-checked-only'],
+};
+```
+
+See [`configs/recommended-type-checked-only.ts`](https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/src/configs/recommended-type-checked-only.ts) for the exact contents of this config.
+
+### `strict-type-checked-only`
+
+A version of `strict` that _only_ contains type-checked rules and disables of any corresponding core ESLint rules.
+This config plus `strict` is equivalent to `strict-type-checked`.
+
+```js title=".eslintrc.js"
+module.exports = {
+  extends: ['plugin:@typescript-eslint/strict-type-checked-only'],
+};
+```
+
+See [`configs/strict-type-checked-only.ts`](https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/src/configs/strict-type-checked-only.ts) for the exact contents of this config.
+
+### `stylistic-type-checked-only`
+
+A version of `stylistic` that _only_ contains type-checked rules and disables of any corresponding core ESLint rules.
+This config plus `stylistic` is equivalent to `stylistic-type-checked`.
+
+```js title=".eslintrc.js"
+module.exports = {
+  extends: ['plugin:@typescript-eslint/stylistic-type-checked-only'],
+};
+```
+
+See [`configs/stylistic-type-checked-only.ts`](https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/src/configs/stylistic-type-checked-only.ts) for the exact contents of this config.
+
 ## Suggesting Configuration Changes
 
 If you feel strongly that a specific rule should (or should not) be one of these configurations, please [file an issue](https://github.com/typescript-eslint/typescript-eslint/issues/new?assignees=&labels=package%3A+eslint-plugin%2Cpreset+config+change%2Ctriage&template=09-config-change.yaml&title=Configs%3A+%3Ca+short+description+of+my+proposal%3E) along with a **detailed** argument explaining your reasoning.

diff --git a/packages/eslint-plugin/src/configs/recommended-type-checked-only.ts b/packages/eslint-plugin/src/configs/recommended-type-checked-only.ts
@@ -0,0 +1,35 @@
+// THIS CODE WAS AUTOMATICALLY GENERATED
+// DO NOT EDIT THIS CODE BY HAND
+// SEE https://typescript-eslint.io/users/configs
+//
+// 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/await-thenable': 'error',
+    '@typescript-eslint/no-base-to-string': 'error',
+    '@typescript-eslint/no-duplicate-type-constituents': 'error',
+    '@typescript-eslint/no-floating-promises': 'error',
+    '@typescript-eslint/no-for-in-array': 'error',
+    'no-implied-eval': 'off',
+    '@typescript-eslint/no-implied-eval': 'error',
+    '@typescript-eslint/no-misused-promises': 'error',
+    '@typescript-eslint/no-redundant-type-constituents': 'error',
+    '@typescript-eslint/no-unnecessary-type-assertion': 'error',
+    '@typescript-eslint/no-unsafe-argument': 'error',
+    '@typescript-eslint/no-unsafe-assignment': 'error',
+    '@typescript-eslint/no-unsafe-call': 'error',
+    '@typescript-eslint/no-unsafe-enum-comparison': 'error',
+    '@typescript-eslint/no-unsafe-member-access': 'error',
+    '@typescript-eslint/no-unsafe-return': 'error',
+    'require-await': 'off',
+    '@typescript-eslint/require-await': 'error',
+    '@typescript-eslint/restrict-plus-operands': 'error',
+    '@typescript-eslint/restrict-template-expressions': 'error',
+    '@typescript-eslint/unbound-method': 'error',
+  },
+} satisfies ClassicConfig.Config;
diff --git a/packages/eslint-plugin/src/configs/strict-type-checked-only.ts b/packages/eslint-plugin/src/configs/strict-type-checked-only.ts
@@ -0,0 +1,50 @@
+// THIS CODE WAS AUTOMATICALLY GENERATED
+// DO NOT EDIT THIS CODE BY HAND
+// SEE https://typescript-eslint.io/users/configs
+//
+// 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/await-thenable': 'error',
+    '@typescript-eslint/no-array-delete': 'error',
+    '@typescript-eslint/no-base-to-string': 'error',
+    '@typescript-eslint/no-confusing-void-expression': 'error',
+    '@typescript-eslint/no-duplicate-type-constituents': 'error',
+    '@typescript-eslint/no-floating-promises': 'error',
+    '@typescript-eslint/no-for-in-array': 'error',
+    'no-implied-eval': 'off',
+    '@typescript-eslint/no-implied-eval': 'error',
+    '@typescript-eslint/no-meaningless-void-operator': 'error',
+    '@typescript-eslint/no-misused-promises': 'error',
+    '@typescript-eslint/no-mixed-enums': 'error',
+    '@typescript-eslint/no-redundant-type-constituents': 'error',
+    'no-throw-literal': 'off',
+    '@typescript-eslint/no-throw-literal': 'error',
+    '@typescript-eslint/no-unnecessary-boolean-literal-compare': 'error',
+    '@typescript-eslint/no-unnecessary-condition': 'error',
+    '@typescript-eslint/no-unnecessary-type-arguments': 'error',
+    '@typescript-eslint/no-unnecessary-type-assertion': 'error',
+    '@typescript-eslint/no-unsafe-argument': 'error',
+    '@typescript-eslint/no-unsafe-assignment': 'error',
+    '@typescript-eslint/no-unsafe-call': 'error',
+    '@typescript-eslint/no-unsafe-enum-comparison': 'error',
+    '@typescript-eslint/no-unsafe-member-access': 'error',
+    '@typescript-eslint/no-unsafe-return': 'error',
+    '@typescript-eslint/no-useless-template-literals': 'error',
+    '@typescript-eslint/prefer-includes': 'error',
+    'prefer-promise-reject-errors': 'off',
+    '@typescript-eslint/prefer-promise-reject-errors': 'error',
+    '@typescript-eslint/prefer-reduce-type-parameter': 'error',
+    '@typescript-eslint/prefer-return-this-type': 'error',
+    'require-await': 'off',
+    '@typescript-eslint/require-await': 'error',
+    '@typescript-eslint/restrict-plus-operands': 'error',
+    '@typescript-eslint/restrict-template-expressions': 'error',
+    '@typescript-eslint/unbound-method': 'error',
+  },
+} satisfies ClassicConfig.Config;
diff --git a/packages/eslint-plugin/src/configs/stylistic-type-checked-only.ts b/packages/eslint-plugin/src/configs/stylistic-type-checked-only.ts
@@ -0,0 +1,20 @@
+// THIS CODE WAS AUTOMATICALLY GENERATED
+// DO NOT EDIT THIS CODE BY HAND
+// SEE https://typescript-eslint.io/users/configs
+//
+// 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: {
+    'dot-notation': 'off',
+    '@typescript-eslint/dot-notation': 'error',
+    '@typescript-eslint/non-nullable-type-assertion-style': 'error',
+    '@typescript-eslint/prefer-nullish-coalescing': 'error',
+    '@typescript-eslint/prefer-optional-chain': 'error',
+    '@typescript-eslint/prefer-string-starts-ends-with': 'error',
+  },
+} satisfies ClassicConfig.Config;
diff --git a/packages/repo-tools/src/generate-configs.mts b/packages/repo-tools/src/generate-configs.mts
@@ -251,15 +251,15 @@ async function main(): Promise<void> {
   }
 
   async function writeExtendedConfig({
-    filters: ruleFilter,
+    filters,
     name,
     ruleEntries,
   }: ExtendedConfigSettings): Promise<void> {
     await writeConfig(
       () => ({
         extends: [...CLASSIC_EXTENDS],
         rules: ruleEntries.reduce(
-          (config, entry) => reducer(config, entry, ruleFilter),
+          (config, entry) => reducer(config, entry, filters),
           {},
         ),
       }),
@@ -296,6 +296,14 @@ async function main(): Promise<void> {
     ruleEntries: filterRuleEntriesTo('recommended'),
   });
 
+  await writeExtendedConfig({
+    filters: {
+      typeChecked: 'include-only',
+    },
+    name: 'recommended-type-checked-only',
+    ruleEntries: filterRuleEntriesTo('recommended'),
+  });
+
   await writeExtendedConfig({
     filters: {
       typeChecked: 'exclude',
@@ -309,6 +317,14 @@ async function main(): Promise<void> {
     ruleEntries: filterRuleEntriesTo('recommended', 'strict'),
   });
 
+  await writeExtendedConfig({
+    filters: {
+      typeChecked: 'include-only',
+    },
+    name: 'strict-type-checked-only',
+    ruleEntries: filterRuleEntriesTo('recommended', 'strict'),
+  });
+
   await writeExtendedConfig({
     filters: {
       typeChecked: 'exclude',
@@ -322,6 +338,14 @@ async function main(): Promise<void> {
     ruleEntries: filterRuleEntriesTo('stylistic'),
   });
 
+  await writeExtendedConfig({
+    filters: {
+      typeChecked: 'include-only',
+    },
+    name: 'stylistic-type-checked-only',
+    ruleEntries: filterRuleEntriesTo('stylistic'),
+  });
+
   await writeConfig(
     () => ({
       parserOptions: {

diff --git a/packages/typescript-eslint/src/configs/recommended-type-checked-only.ts b/packages/typescript-eslint/src/configs/recommended-type-checked-only.ts
@@ -0,0 +1,44 @@
+// THIS CODE WAS AUTOMATICALLY GENERATED
+// DO NOT EDIT THIS CODE BY HAND
+// SEE https://typescript-eslint.io/users/configs
+//
+// For developers working in the typescript-eslint monorepo:
+// You can regenerate it using `yarn generate:configs`
+
+import type { FlatConfig } from '@typescript-eslint/utils/ts-eslint';
+
+import baseConfig from './base';
+import eslintRecommendedConfig from './eslint-recommended';
+
+export default (
+  plugin: FlatConfig.Plugin,
+  parser: FlatConfig.Parser,
+): FlatConfig.ConfigArray => [
+  baseConfig(plugin, parser),
+  eslintRecommendedConfig(plugin, parser),
+  {
+    rules: {
+      '@typescript-eslint/await-thenable': 'error',
+      '@typescript-eslint/no-base-to-string': 'error',
+      '@typescript-eslint/no-duplicate-type-constituents': 'error',
+      '@typescript-eslint/no-floating-promises': 'error',
+      '@typescript-eslint/no-for-in-array': 'error',
+      'no-implied-eval': 'off',
+      '@typescript-eslint/no-implied-eval': 'error',
+      '@typescript-eslint/no-misused-promises': 'error',
+      '@typescript-eslint/no-redundant-type-constituents': 'error',
+      '@typescript-eslint/no-unnecessary-type-assertion': 'error',
+      '@typescript-eslint/no-unsafe-argument': 'error',
+      '@typescript-eslint/no-unsafe-assignment': 'error',
+      '@typescript-eslint/no-unsafe-call': 'error',
+      '@typescript-eslint/no-unsafe-enum-comparison': 'error',
+      '@typescript-eslint/no-unsafe-member-access': 'error',
+      '@typescript-eslint/no-unsafe-return': 'error',
+      'require-await': 'off',
+      '@typescript-eslint/require-await': 'error',
+      '@typescript-eslint/restrict-plus-operands': 'error',
+      '@typescript-eslint/restrict-template-expressions': 'error',
+      '@typescript-eslint/unbound-method': 'error',
+    },
+  },
+];
diff --git a/packages/typescript-eslint/src/configs/strict-type-checked-only.ts b/packages/typescript-eslint/src/configs/strict-type-checked-only.ts
@@ -0,0 +1,59 @@
+// THIS CODE WAS AUTOMATICALLY GENERATED
+// DO NOT EDIT THIS CODE BY HAND
+// SEE https://typescript-eslint.io/users/configs
+//
+// For developers working in the typescript-eslint monorepo:
+// You can regenerate it using `yarn generate:configs`
+
+import type { FlatConfig } from '@typescript-eslint/utils/ts-eslint';
+
+import baseConfig from './base';
+import eslintRecommendedConfig from './eslint-recommended';
+
+export default (
+  plugin: FlatConfig.Plugin,
+  parser: FlatConfig.Parser,
+): FlatConfig.ConfigArray => [
+  baseConfig(plugin, parser),
+  eslintRecommendedConfig(plugin, parser),
+  {
+    rules: {
+      '@typescript-eslint/await-thenable': 'error',
+      '@typescript-eslint/no-array-delete': 'error',
+      '@typescript-eslint/no-base-to-string': 'error',
+      '@typescript-eslint/no-confusing-void-expression': 'error',
+      '@typescript-eslint/no-duplicate-type-constituents': 'error',
+      '@typescript-eslint/no-floating-promises': 'error',
+      '@typescript-eslint/no-for-in-array': 'error',
+      'no-implied-eval': 'off',
+      '@typescript-eslint/no-implied-eval': 'error',
+      '@typescript-eslint/no-meaningless-void-operator': 'error',
+      '@typescript-eslint/no-misused-promises': 'error',
+      '@typescript-eslint/no-mixed-enums': 'error',
+      '@typescript-eslint/no-redundant-type-constituents': 'error',
+      'no-throw-literal': 'off',
+      '@typescript-eslint/no-throw-literal': 'error',
+      '@typescript-eslint/no-unnecessary-boolean-literal-compare': 'error',
+      '@typescript-eslint/no-unnecessary-condition': 'error',
+      '@typescript-eslint/no-unnecessary-type-arguments': 'error',
+      '@typescript-eslint/no-unnecessary-type-assertion': 'error',
+      '@typescript-eslint/no-unsafe-argument': 'error',
+      '@typescript-eslint/no-unsafe-assignment': 'error',
+      '@typescript-eslint/no-unsafe-call': 'error',
+      '@typescript-eslint/no-unsafe-enum-comparison': 'error',
+      '@typescript-eslint/no-unsafe-member-access': 'error',
+      '@typescript-eslint/no-unsafe-return': 'error',
+      '@typescript-eslint/no-useless-template-literals': 'error',
+      '@typescript-eslint/prefer-includes': 'error',
+      'prefer-promise-reject-errors': 'off',
+      '@typescript-eslint/prefer-promise-reject-errors': 'error',
+      '@typescript-eslint/prefer-reduce-type-parameter': 'error',
+      '@typescript-eslint/prefer-return-this-type': 'error',
+      'require-await': 'off',
+      '@typescript-eslint/require-await': 'error',
+      '@typescript-eslint/restrict-plus-operands': 'error',
+      '@typescript-eslint/restrict-template-expressions': 'error',
+      '@typescript-eslint/unbound-method': 'error',
+    },
+  },
+];
diff --git a/packages/typescript-eslint/src/configs/stylistic-type-checked-only.ts b/packages/typescript-eslint/src/configs/stylistic-type-checked-only.ts
@@ -0,0 +1,29 @@
+// THIS CODE WAS AUTOMATICALLY GENERATED
+// DO NOT EDIT THIS CODE BY HAND
+// SEE https://typescript-eslint.io/users/configs
+//
+// For developers working in the typescript-eslint monorepo:
+// You can regenerate it using `yarn generate:configs`
+
+import type { FlatConfig } from '@typescript-eslint/utils/ts-eslint';
+
+import baseConfig from './base';
+import eslintRecommendedConfig from './eslint-recommended';
+
+export default (
+  plugin: FlatConfig.Plugin,
+  parser: FlatConfig.Parser,
+): FlatConfig.ConfigArray => [
+  baseConfig(plugin, parser),
+  eslintRecommendedConfig(plugin, parser),
+  {
+    rules: {
+      'dot-notation': 'off',
+      '@typescript-eslint/dot-notation': 'error',
+      '@typescript-eslint/non-nullable-type-assertion-style': 'error',
+      '@typescript-eslint/prefer-nullish-coalescing': 'error',
+      '@typescript-eslint/prefer-optional-chain': 'error',
+      '@typescript-eslint/prefer-string-starts-ends-with': 'error',
+    },
+  },
+];