chore: enabled stylistic-type-checked internally (#7138)

* chore: enabled stylistic-type-checked internally * Reduced scope of changes * Updated snapshots * Update packages/typescript-estree/tests/lib/convert.test.ts Co-authored-by: rubiesonthesky <2591240+rubiesonthesky@users.noreply.github.com> * More deeplyCopy removals * Updated test snapshots --------- Co-authored-by: rubiesonthesky <2591240+rubiesonthesky@users.noreply.github.com>
typescript-eslint · Jun 30, 2023 · 42fe29f · 42fe29f
1 parent 3cdf5c9
commit 42fe29f
Show file tree

Hide file tree

Showing 31 changed files with 173 additions and 116 deletions.
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -21,7 +21,8 @@ module.exports = {
     'eslint:recommended',
     'plugin:eslint-plugin/recommended',
     'plugin:@typescript-eslint/recommended-type-checked',
-    // TODO: consider enabling strict-type-checked and/or stylistic-type-checked
+    'plugin:@typescript-eslint/stylistic-type-checked',
+    // TODO: consider enabling strict-type-checked
   ],
   parserOptions: {
     sourceType: 'module',
@@ -52,11 +53,18 @@ module.exports = {
     // make sure we're not leveraging any deprecated APIs
     'deprecation/deprecation': 'error',
 
+    // TODO(#7138): Investigate enabling these soon ✨
+    '@typescript-eslint/consistent-indexed-object-style': 'off',
+    '@typescript-eslint/prefer-nullish-coalescing': 'off',
+
+    // TODO(#7130): Investigate changing these in or removing these from presets
+    '@typescript-eslint/no-confusing-void-expression': 'off',
+    '@typescript-eslint/prefer-string-starts-ends-with': 'off',
+
     //
     // our plugin :D
     //
 
-    '@typescript-eslint/array-type': 'error',
     '@typescript-eslint/ban-ts-comment': [
       'error',
       {
@@ -67,7 +75,6 @@ module.exports = {
         minimumDescriptionLength: 5,
       },
     ],
-    '@typescript-eslint/consistent-type-definitions': ['error', 'interface'],
     '@typescript-eslint/consistent-type-imports': [
       'error',
       { prefer: 'type-imports', disallowTypeAnnotations: true },
@@ -76,18 +83,10 @@ module.exports = {
       'error',
       { allowIIFEs: true },
     ],
-    '@typescript-eslint/explicit-module-boundary-types': 'off',
-    '@typescript-eslint/no-empty-function': [
-      'error',
-      { allow: ['arrowFunctions'] },
-    ],
     '@typescript-eslint/no-explicit-any': 'error',
     '@typescript-eslint/no-non-null-assertion': 'off',
     '@typescript-eslint/no-var-requires': 'off',
-    '@typescript-eslint/prefer-for-of': 'error',
-    '@typescript-eslint/prefer-optional-chain': 'error',
     '@typescript-eslint/unbound-method': 'off',
-    '@typescript-eslint/prefer-as-const': 'error',
     '@typescript-eslint/restrict-template-expressions': [
       'error',
       {
@@ -98,7 +97,6 @@ module.exports = {
         allowRegExp: true,
       },
     ],
-    '@typescript-eslint/sort-type-constituents': 'error',
     '@typescript-eslint/no-unused-vars': [
       'error',
       { varsIgnorePattern: '^_', argsIgnorePattern: '^_' },
@@ -238,6 +236,10 @@ module.exports = {
         'jest/globals': true,
       },
       rules: {
+        '@typescript-eslint/no-empty-function': [
+          'error',
+          { allow: ['arrowFunctions'] },
+        ],
         '@typescript-eslint/no-unsafe-assignment': 'off',
         '@typescript-eslint/no-unsafe-call': 'off',
         '@typescript-eslint/no-unsafe-member-access': 'off',

diff --git a/...perty/fixtures/_error_/modifier-abstract-accessor-with-value/snapshots/1-Babel-Error.shot b/...perty/fixtures/_error_/modifier-abstract-accessor-with-value/snapshots/1-Babel-Error.shot
diff --git a/...y/fixtures/_error_/modifier-abstract-accessor-with-value/snapshots/2-Alignment-Error.shot b/...y/fixtures/_error_/modifier-abstract-accessor-with-value/snapshots/2-Alignment-Error.shot
diff --git a/...perty/fixtures/_error_/modifier-abstract-property-with-value/snapshots/1-Babel-Error.shot b/...perty/fixtures/_error_/modifier-abstract-property-with-value/snapshots/1-Babel-Error.shot
diff --git a/...y/fixtures/_error_/modifier-abstract-property-with-value/snapshots/2-Alignment-Error.shot b/...y/fixtures/_error_/modifier-abstract-property-with-value/snapshots/2-Alignment-Error.shot
diff --git a/...rameterProperty/fixtures/_error_/override-function-parameter/snapshots/1-Babel-Error.shot b/...rameterProperty/fixtures/_error_/override-function-parameter/snapshots/1-Babel-Error.shot
diff --git a/...terProperty/fixtures/_error_/override-function-parameter/snapshots/2-Alignment-Error.shot b/...terProperty/fixtures/_error_/override-function-parameter/snapshots/2-Alignment-Error.shot
diff --git a/...ParameterProperty/fixtures/_error_/override-method-parameter/snapshots/1-Babel-Error.shot b/...ParameterProperty/fixtures/_error_/override-method-parameter/snapshots/1-Babel-Error.shot
diff --git a/...meterProperty/fixtures/_error_/override-method-parameter/snapshots/2-Alignment-Error.shot b/...meterProperty/fixtures/_error_/override-method-parameter/snapshots/2-Alignment-Error.shot
diff --git a/...ype/fixtures/_error_/looks-like-mapped-type-but-with-members/snapshots/1-Babel-Error.shot b/...ype/fixtures/_error_/looks-like-mapped-type-but-with-members/snapshots/1-Babel-Error.shot
diff --git a/...fixtures/_error_/looks-like-mapped-type-but-with-members/snapshots/2-Alignment-Error.shot b/...fixtures/_error_/looks-like-mapped-type-but-with-members/snapshots/2-Alignment-Error.shot
diff --git a/.../ast-spec/src/type/TSMappedType/fixtures/_error_/with-member/snapshots/1-Babel-Error.shot b/.../ast-spec/src/type/TSMappedType/fixtures/_error_/with-member/snapshots/1-Babel-Error.shot
diff --git a/...-spec/src/type/TSMappedType/fixtures/_error_/with-member/snapshots/2-Alignment-Error.shot b/...-spec/src/type/TSMappedType/fixtures/_error_/with-member/snapshots/2-Alignment-Error.shot
diff --git a/packages/eslint-plugin/src/rules/comma-dangle.ts b/packages/eslint-plugin/src/rules/comma-dangle.ts
@@ -98,7 +98,7 @@ export default util.createRule<Options, MessageIds>({
       'always-multiline': forceCommaIfMultiline,
       'only-multiline': allowCommaIfMultiline,
       never: forbidComma,
-      ignore: (): void => {},
+      ignore: undefined,
     };
 
     function last(nodes: TSESTree.Node[]): TSESTree.Node | null {

diff --git a/packages/eslint-plugin/src/rules/no-duplicate-type-constituents.ts b/packages/eslint-plugin/src/rules/no-duplicate-type-constituents.ts
@@ -108,7 +108,7 @@ export default util.createRule<Options, MessageIds>({
     function checkDuplicate(
       node: TSESTree.TSIntersectionType | TSESTree.TSUnionType,
     ): void {
-      const cachedTypeMap: Map<Type, TSESTree.TypeNode> = new Map();
+      const cachedTypeMap = new Map<Type, TSESTree.TypeNode>();
       node.types.reduce<TSESTree.TypeNode[]>(
         (uniqueConstituents, constituentNode) => {
           const duplicatedPreviousConstituentInAst = uniqueConstituents.find(

diff --git a/packages/eslint-plugin/src/rules/no-restricted-imports.ts b/packages/eslint-plugin/src/rules/no-restricted-imports.ts
@@ -183,7 +183,7 @@ export default createRule<Options, MessageIds>({
     }
 
     const restrictedPaths = getRestrictedPaths(options);
-    const allowedTypeImportPathNameSet: Set<string> = new Set();
+    const allowedTypeImportPathNameSet = new Set<string>();
     for (const restrictedPath of restrictedPaths) {
       if (
         typeof restrictedPath === 'object' &&

diff --git a/packages/eslint-plugin/src/rules/padding-line-between-statements.ts b/packages/eslint-plugin/src/rules/padding-line-between-statements.ts
@@ -438,12 +438,9 @@ function verifyForAlways(
     messageId: 'expectedBlankLine',
     fix(fixer) {
       const sourceCode = context.getSourceCode();
-      let prevToken = getActualLastToken(
-        prevNode,
-        sourceCode,
-      ) as TSESTree.Token;
+      let prevToken = getActualLastToken(prevNode, sourceCode)!;
       const nextToken =
-        (sourceCode.getFirstTokenBetween(prevToken, nextNode, {
+        sourceCode.getFirstTokenBetween(prevToken, nextNode, {
           includeComments: true,
 
           /**
@@ -473,7 +470,7 @@ function verifyForAlways(
             }
             return true;
           },
-        }) as TSESTree.Token) || nextNode;
+        })! || nextNode;
       const insertText = util.isTokenOnSameLine(prevToken, nextToken)
         ? '\n\n'
         : '\n';

diff --git a/packages/eslint-plugin/src/rules/switch-exhaustiveness-check.ts b/packages/eslint-plugin/src/rules/switch-exhaustiveness-check.ts
@@ -116,7 +116,7 @@ export default createRule({
 
       if (discriminantType.isUnion()) {
         const unionTypes = tsutils.unionTypeParts(discriminantType);
-        const caseTypes: Set<ts.Type> = new Set();
+        const caseTypes = new Set<ts.Type>();
         for (const switchCase of node.cases) {
           if (switchCase.test == null) {
             // Switch has 'default' branch - do nothing.

diff --git a/packages/eslint-plugin/src/util/astUtils.ts b/packages/eslint-plugin/src/util/astUtils.ts
@@ -56,7 +56,7 @@ export function forEachReturnStatement<T>(
   function traverse(node: ts.Node): T | undefined {
     switch (node.kind) {
       case ts.SyntaxKind.ReturnStatement:
-        return visitor(<ts.ReturnStatement>node);
+        return visitor(node as ts.ReturnStatement);
       case ts.SyntaxKind.CaseBlock:
       case ts.SyntaxKind.Block:
       case ts.SyntaxKind.IfStatement:

diff --git a/packages/eslint-plugin/tests/configs.test.ts b/packages/eslint-plugin/tests/configs.test.ts
@@ -130,7 +130,7 @@ describe('recommended-type-checked.ts', () => {
 
 describe('strict.ts', () => {
   const unfilteredConfigRules: Record<string, string> =
-    plugin.configs['strict'].rules;
+    plugin.configs.strict.rules;
 
   it('contains all strict rules, excluding type checked ones', () => {
     const configRules = filterRules(unfilteredConfigRules);
@@ -166,7 +166,7 @@ describe('strict-type-checked.ts', () => {
 
 describe('stylistic.ts', () => {
   const unfilteredConfigRules: Record<string, string> =
-    plugin.configs['stylistic'].rules;
+    plugin.configs.stylistic.rules;
 
   it('contains all stylistic rules, excluding deprecated or type checked ones', () => {
     const configRules = filterRules(unfilteredConfigRules);

diff --git a/packages/scope-manager/src/scope/ScopeBase.ts b/packages/scope-manager/src/scope/ScopeBase.ts
@@ -232,7 +232,7 @@ abstract class ScopeBase<
     block: TBlock,
     isMethodDefinition: boolean,
   ) {
-    const upperScopeAsScopeBase = upperScope as Scope;
+    const upperScopeAsScopeBase = upperScope!;
 
     this.type = type;
     this.#dynamic =
@@ -386,7 +386,7 @@ abstract class ScopeBase<
   }
 
   protected delegateToUpperScope(ref: Reference): void {
-    const upper = this.upper as Scope as AnyScope;
+    const upper = this.upper! as AnyScope;
     if (upper?.leftToResolve) {
       upper.leftToResolve.push(ref);
     }

diff --git a/packages/scope-manager/tests/eslint-scope/es6-destructuring-assignments.test.ts b/packages/scope-manager/tests/eslint-scope/es6-destructuring-assignments.test.ts
@@ -1,3 +1,4 @@
+/* eslint-disable @typescript-eslint/dot-notation -- ['implicit'] is private */
 import {
   expectToBeForScope,
   expectToBeFunctionScope,

diff --git a/packages/scope-manager/tests/eslint-scope/implicit-global-reference.test.ts b/packages/scope-manager/tests/eslint-scope/implicit-global-reference.test.ts
@@ -1,3 +1,4 @@
+/* eslint-disable @typescript-eslint/dot-notation -- ['implicit'] is private */
 import { DefinitionType } from '../../src/definition';
 import {
   expectToBeGlobalScope,

diff --git a/packages/typescript-estree/src/create-program/createDefaultProgram.ts b/packages/typescript-estree/src/create-program/createDefaultProgram.ts
@@ -32,7 +32,12 @@ function createDefaultProgram(
   const commandLine = ts.getParsedCommandLineOfConfigFile(
     tsconfigPath,
     createDefaultCompilerOptionsFromExtra(parseSettings),
-    { ...ts.sys, onUnRecoverableConfigFileDiagnostic: () => {} },
+    {
+      ...ts.sys,
+      // TODO: file issue on TypeScript to suggest making optional?
+      // eslint-disable-next-line @typescript-eslint/no-empty-function
+      onUnRecoverableConfigFileDiagnostic: () => {},
+    },
   );
 
   if (!commandLine) {

diff --git a/packages/typescript-estree/src/create-program/getWatchProgramsForProjects.ts b/packages/typescript-estree/src/create-program/getWatchProgramsForProjects.ts
@@ -264,6 +264,8 @@ function createWatchProgram(
     ts.sys,
     ts.createAbstractBuilder,
     diagnosticReporter,
+    // TODO: file issue on TypeScript to suggest making optional?
+    // eslint-disable-next-line @typescript-eslint/no-empty-function
     /*reportWatchStatus*/ () => {},
   ) as WatchCompilerHostOfConfigFile<ts.BuilderProgram>;
 

diff --git a/packages/typescript-estree/src/parseSettings/createParseSettings.ts b/packages/typescript-estree/src/parseSettings/createParseSettings.ts
@@ -66,7 +66,7 @@ export function createParseSettings(
       typeof options.loggerFn === 'function'
         ? options.loggerFn
         : options.loggerFn === false
-        ? (): void => {}
+        ? (): void => {} // eslint-disable-line @typescript-eslint/no-empty-function
         : console.log, // eslint-disable-line no-console
     preserveNodeMaps: options.preserveNodeMaps !== false,
     programs: Array.isArray(options.programs) ? options.programs : null,

diff --git a/packages/typescript-estree/src/parser.ts b/packages/typescript-estree/src/parser.ts
@@ -80,6 +80,7 @@ function getProgramAndAST(
   return createNoProgram(parseSettings);
 }
 
+// eslint-disable-next-line @typescript-eslint/no-empty-interface
 interface EmptyObject {}
 type AST<T extends TSESTreeOptions> = TSESTree.Program &
   (T['comment'] extends true ? { comments: TSESTree.Comment[] } : EmptyObject) &

diff --git a/packages/typescript-estree/src/ts-estree/ts-nodes.ts b/packages/typescript-estree/src/ts-estree/ts-nodes.ts
@@ -2,6 +2,7 @@ import type * as ts from 'typescript';
 
 // Workaround to support new TS version features for consumers on old TS versions
 // Eg: https://github.com/typescript-eslint/typescript-eslint/issues/2388, https://github.com/typescript-eslint/typescript-eslint/issues/2784
+/* eslint-disable @typescript-eslint/no-empty-interface */
 declare module 'typescript' {
   // added in TS 4.0
   export interface NamedTupleMember extends ts.Node {}
@@ -16,6 +17,7 @@ declare module 'typescript' {
   // added in TS 4.9
   export interface SatisfiesExpression extends ts.Node {}
 }
+/* eslint-enable @typescript-eslint/no-empty-interface */
 
 export type TSToken = ts.Token<ts.SyntaxKind>;