fix: bumped ts-api-utils to 0.0.39 (#6497)

* fix: bumped ts-api-utils to 0.0.28 * Fix snippets formatting * Rename tools to tsutils too * ...and the docs * Fixed compile issues * Correct patch version * Correct patch
typescript-eslint · Feb 23, 2023 · 217c710 · 217c710
1 parent d676683
commit 217c710
Show file tree

Hide file tree

Showing 41 changed files with 175 additions and 142 deletions.
diff --git a/docs/Custom_Rules.mdx b/docs/Custom_Rules.mdx
@@ -229,7 +229,7 @@ This rule bans for-of looping over an enum by using the TypeScript type checker
 
 ```ts
 import { ESLintUtils } from '@typescript-eslint/utils';
-import * as tools from 'ts-api-tools';
+import * as tsutils from 'ts-api-tools';
 import * as ts from 'typescript';
 
 export const rule = createRule({
@@ -243,7 +243,7 @@ export const rule = createRule({
         const type = services.getTypeAtLocation(node);
 
         // 3. Check the TS type using the TypeScript APIs
-        if (tools.isTypeFlagSet(nodeType, ts.TypeFlags.EnumLike)) {
+        if (tsutils.isTypeFlagSet(nodeType, ts.TypeFlags.EnumLike)) {
           context.report({
             messageId: 'loopOverEnum',
             node: node.right,

diff --git a/packages/eslint-plugin/package.json b/packages/eslint-plugin/package.json
@@ -65,7 +65,7 @@
     "natural-compare-lite": "^1.4.0",
     "regexpp": "^3.2.0",
     "semver": "^7.3.7",
-    "ts-api-utils": "^0.0.22"
+    "ts-api-utils": "^0.0.39"
   },
   "devDependencies": {
     "@types/debug": "*",

diff --git a/packages/eslint-plugin/src/rules/await-thenable.ts b/packages/eslint-plugin/src/rules/await-thenable.ts
@@ -1,4 +1,4 @@
-import * as tools from 'ts-api-utils';
+import * as tsutils from 'ts-api-utils';
 
 import * as util from '../util';
 
@@ -31,7 +31,7 @@ export default util.createRule({
 
         const originalNode = services.esTreeNodeToTSNodeMap.get(node);
 
-        if (!tools.isThenableType(checker, originalNode.expression, type)) {
+        if (!tsutils.isThenableType(checker, originalNode.expression, type)) {
           context.report({
             messageId: 'await',
             node,

diff --git a/packages/eslint-plugin/src/rules/dot-notation.ts b/packages/eslint-plugin/src/rules/dot-notation.ts
@@ -1,5 +1,5 @@
 import type { TSESTree } from '@typescript-eslint/utils';
-import * as tools from 'ts-api-utils';
+import * as tsutils from 'ts-api-utils';
 import * as ts from 'typescript';
 
 import type {
@@ -75,7 +75,7 @@ export default createRule<Options, MessageIds>({
       options.allowProtectedClassPropertyAccess;
     const allowIndexSignaturePropertyAccess =
       (options.allowIndexSignaturePropertyAccess ?? false) ||
-      tools.isCompilerOptionEnabled(
+      tsutils.isCompilerOptionEnabled(
         services.program.getCompilerOptions(),
         'noPropertyAccessFromIndexSignature',
       );

diff --git a/packages/eslint-plugin/src/rules/no-confusing-void-expression.ts b/packages/eslint-plugin/src/rules/no-confusing-void-expression.ts
@@ -1,6 +1,6 @@
 import type { TSESLint, TSESTree } from '@typescript-eslint/utils';
 import { AST_NODE_TYPES } from '@typescript-eslint/utils';
-import * as tools from 'ts-api-utils';
+import * as tsutils from 'ts-api-utils';
 import * as ts from 'typescript';
 
 import * as util from '../util';
@@ -81,7 +81,7 @@ export default util.createRule<Options, MessageId>({
       ): void {
         const services = util.getParserServices(context);
         const type = util.getConstrainedTypeAtLocation(services, node);
-        if (!tools.isTypeFlagSet(type, ts.TypeFlags.VoidLike)) {
+        if (!tsutils.isTypeFlagSet(type, ts.TypeFlags.VoidLike)) {
           // not a void expression
           return;
         }

diff --git a/packages/eslint-plugin/src/rules/no-dynamic-delete.ts b/packages/eslint-plugin/src/rules/no-dynamic-delete.ts
@@ -1,6 +1,6 @@
 import type { TSESLint, TSESTree } from '@typescript-eslint/utils';
 import { AST_NODE_TYPES } from '@typescript-eslint/utils';
-import * as tools from 'ts-api-utils';
+import * as tsutils from 'ts-api-utils';
 
 import * as util from '../util';
 
@@ -97,6 +97,6 @@ function isNecessaryDynamicAccess(property: TSESTree.Expression): boolean {
 
   return (
     typeof property.value === 'string' &&
-    !tools.isValidPropertyAccess(property.value)
+    !tsutils.isValidPropertyAccess(property.value)
   );
 }
diff --git a/packages/eslint-plugin/src/rules/no-floating-promises.ts b/packages/eslint-plugin/src/rules/no-floating-promises.ts
@@ -1,6 +1,6 @@
 import type { TSESLint, TSESTree } from '@typescript-eslint/utils';
 import { AST_NODE_TYPES } from '@typescript-eslint/utils';
-import * as tools from 'ts-api-utils';
+import * as tsutils from 'ts-api-utils';
 import * as ts from 'typescript';
 
 import * as util from '../util';
@@ -240,7 +240,7 @@ export default util.createRule<Options, MessageId>({
 //   https://github.com/ajafff/tsutils/blob/49d0d31050b44b81e918eae4fbaf1dfe7b7286af/util/type.ts#L95-L125
 function isPromiseLike(checker: ts.TypeChecker, node: ts.Node): boolean {
   const type = checker.getTypeAtLocation(node);
-  for (const ty of tools.unionTypeParts(checker.getApparentType(type))) {
+  for (const ty of tsutils.unionTypeParts(checker.getApparentType(type))) {
     const then = ty.getProperty('then');
     if (then === undefined) {
       continue;
@@ -266,7 +266,7 @@ function hasMatchingSignature(
   type: ts.Type,
   matcher: (signature: ts.Signature) => boolean,
 ): boolean {
-  for (const t of tools.unionTypeParts(type)) {
+  for (const t of tsutils.unionTypeParts(type)) {
     if (t.getCallSignatures().some(matcher)) {
       return true;
     }
@@ -283,7 +283,7 @@ function isFunctionParam(
   const type: ts.Type | undefined = checker.getApparentType(
     checker.getTypeOfSymbolAtLocation(param, node),
   );
-  for (const t of tools.unionTypeParts(type)) {
+  for (const t of tsutils.unionTypeParts(type)) {
     if (t.getCallSignatures().length !== 0) {
       return true;
     }

diff --git a/packages/eslint-plugin/src/rules/no-implied-eval.ts b/packages/eslint-plugin/src/rules/no-implied-eval.ts
@@ -1,6 +1,6 @@
 import type { TSESTree } from '@typescript-eslint/utils';
 import { AST_NODE_TYPES } from '@typescript-eslint/utils';
-import * as tools from 'ts-api-utils';
+import * as tsutils from 'ts-api-utils';
 import * as ts from 'typescript';
 
 import * as util from '../util';
@@ -69,7 +69,7 @@ export default util.createRule({
 
       if (
         symbol &&
-        tools.isSymbolFlagSet(
+        tsutils.isSymbolFlagSet(
           symbol,
           ts.SymbolFlags.Function | ts.SymbolFlags.Method,
         )

diff --git a/packages/eslint-plugin/src/rules/no-meaningless-void-operator.ts b/packages/eslint-plugin/src/rules/no-meaningless-void-operator.ts
@@ -1,6 +1,6 @@
 import type { TSESLint, TSESTree } from '@typescript-eslint/utils';
 import { ESLintUtils } from '@typescript-eslint/utils';
-import * as tools from 'ts-api-utils';
+import * as tsutils from 'ts-api-utils';
 import * as ts from 'typescript';
 
 import * as util from '../util';
@@ -61,7 +61,7 @@ export default util.createRule<
         };
 
         const argType = services.getTypeAtLocation(node.argument);
-        const unionParts = tools.unionTypeParts(argType);
+        const unionParts = tsutils.unionTypeParts(argType);
         if (
           unionParts.every(
             part => part.flags & (ts.TypeFlags.Void | ts.TypeFlags.Undefined),

diff --git a/packages/eslint-plugin/src/rules/no-misused-promises.ts b/packages/eslint-plugin/src/rules/no-misused-promises.ts
@@ -1,6 +1,6 @@
 import type { TSESLint, TSESTree } from '@typescript-eslint/utils';
 import { AST_NODE_TYPES } from '@typescript-eslint/utils';
-import * as tools from 'ts-api-utils';
+import * as tsutils from 'ts-api-utils';
 import * as ts from 'typescript';
 
 import * as util from '../util';
@@ -410,8 +410,8 @@ export default util.createRule<Options, MessageId>({
 function isSometimesThenable(checker: ts.TypeChecker, node: ts.Node): boolean {
   const type = checker.getTypeAtLocation(node);
 
-  for (const subType of tools.unionTypeParts(checker.getApparentType(type))) {
-    if (tools.isThenableType(checker, node, subType)) {
+  for (const subType of tsutils.unionTypeParts(checker.getApparentType(type))) {
+    if (tsutils.isThenableType(checker, node, subType)) {
       return true;
     }
   }
@@ -426,7 +426,7 @@ function isSometimesThenable(checker: ts.TypeChecker, node: ts.Node): boolean {
 function isAlwaysThenable(checker: ts.TypeChecker, node: ts.Node): boolean {
   const type = checker.getTypeAtLocation(node);
 
-  for (const subType of tools.unionTypeParts(checker.getApparentType(type))) {
+  for (const subType of tsutils.unionTypeParts(checker.getApparentType(type))) {
     const thenProp = subType.getProperty('then');
 
     // If one of the alternates has no then property, it is not thenable in all
@@ -440,7 +440,7 @@ function isAlwaysThenable(checker: ts.TypeChecker, node: ts.Node): boolean {
     // be of the right form to consider it thenable.
     const thenType = checker.getTypeOfSymbolAtLocation(thenProp, node);
     let hasThenableSignature = false;
-    for (const subType of tools.unionTypeParts(thenType)) {
+    for (const subType of tsutils.unionTypeParts(thenType)) {
       for (const signature of subType.getCallSignatures()) {
         if (
           signature.parameters.length !== 0 &&
@@ -478,7 +478,7 @@ function isFunctionParam(
   const type: ts.Type | undefined = checker.getApparentType(
     checker.getTypeOfSymbolAtLocation(param, node),
   );
-  for (const subType of tools.unionTypeParts(type)) {
+  for (const subType of tsutils.unionTypeParts(type)) {
     if (subType.getCallSignatures().length !== 0) {
       return true;
     }
@@ -527,7 +527,7 @@ function voidFunctionArguments(
   // We can't use checker.getResolvedSignature because it prefers an early '() => void' over a later '() => Promise<void>'
   // See https://github.com/microsoft/TypeScript/issues/48077
 
-  for (const subType of tools.unionTypeParts(type)) {
+  for (const subType of tsutils.unionTypeParts(type)) {
     // Standard function calls and `new` have two different types of signatures
     const signatures = ts.isCallExpression(node)
       ? subType.getCallSignatures()
@@ -610,7 +610,7 @@ function anySignatureIsThenableType(
 ): boolean {
   for (const signature of type.getCallSignatures()) {
     const returnType = signature.getReturnType();
-    if (tools.isThenableType(checker, node, returnType)) {
+    if (tsutils.isThenableType(checker, node, returnType)) {
       return true;
     }
   }
@@ -626,7 +626,7 @@ function isThenableReturningFunctionType(
   node: ts.Node,
   type: ts.Type,
 ): boolean {
-  for (const subType of tools.unionTypeParts(type)) {
+  for (const subType of tsutils.unionTypeParts(type)) {
     if (anySignatureIsThenableType(checker, node, subType)) {
       return true;
     }
@@ -645,17 +645,17 @@ function isVoidReturningFunctionType(
 ): boolean {
   let hadVoidReturn = false;
 
-  for (const subType of tools.unionTypeParts(type)) {
+  for (const subType of tsutils.unionTypeParts(type)) {
     for (const signature of subType.getCallSignatures()) {
       const returnType = signature.getReturnType();
 
       // If a certain positional argument accepts both thenable and void returns,
       // a promise-returning function is valid
-      if (tools.isThenableType(checker, node, returnType)) {
+      if (tsutils.isThenableType(checker, node, returnType)) {
         return false;
       }
 
-      hadVoidReturn ||= tools.isTypeFlagSet(returnType, ts.TypeFlags.Void);
+      hadVoidReturn ||= tsutils.isTypeFlagSet(returnType, ts.TypeFlags.Void);
     }
   }
 

diff --git a/packages/eslint-plugin/src/rules/no-redundant-type-constituents.ts b/packages/eslint-plugin/src/rules/no-redundant-type-constituents.ts
@@ -1,5 +1,5 @@
 import { AST_NODE_TYPES, TSESTree } from '@typescript-eslint/utils';
-import * as tools from 'ts-api-utils';
+import * as tsutils from 'ts-api-utils';
 import * as ts from 'typescript';
 
 import * as util from '../util';
@@ -106,11 +106,11 @@ function describeLiteralType(type: ts.Type): string {
     return `${type.value.negative ? '-' : ''}${type.value.base10Value}n`;
   }
 
-  if (tools.isBooleanLiteralType(type, true)) {
+  if (tsutils.isTrueLiteralType(type)) {
     return 'true';
   }
 
-  if (tools.isBooleanLiteralType(type, false)) {
+  if (tsutils.isFalseLiteralType(type)) {
     return 'false';
   }
 
@@ -166,10 +166,10 @@ function isNodeInsideReturnType(node: TSESTree.TSUnionType): boolean {
 function unionTypePartsUnlessBoolean(type: ts.Type): ts.Type[] {
   return type.isUnion() &&
     type.types.length === 2 &&
-    tools.isBooleanLiteralType(type.types[0], false) &&
-    tools.isBooleanLiteralType(type.types[1], true)
+    tsutils.isFalseLiteralType(type.types[0]) &&
+    tsutils.isTrueLiteralType(type.types[1])
     ? [type]
-    : tools.unionTypeParts(type);
+    : tsutils.unionTypeParts(type);
 }
 
 export default util.createRule({

diff --git a/packages/eslint-plugin/src/rules/no-unnecessary-boolean-literal-compare.ts b/packages/eslint-plugin/src/rules/no-unnecessary-boolean-literal-compare.ts
@@ -1,6 +1,6 @@
 import type { TSESTree } from '@typescript-eslint/utils';
 import { AST_NODE_TYPES } from '@typescript-eslint/utils';
-import * as tools from 'ts-api-utils';
+import * as tsutils from 'ts-api-utils';
 import * as ts from 'typescript';
 
 import * as util from '../util';
@@ -110,7 +110,7 @@ export default util.createRule<Options, MessageIds>({
     }
 
     function isBooleanType(expressionType: ts.Type): boolean {
-      return tools.isTypeFlagSet(
+      return tsutils.isTypeFlagSet(
         expressionType,
         ts.TypeFlags.Boolean | ts.TypeFlags.BooleanLiteral,
       );
@@ -131,7 +131,7 @@ export default util.createRule<Options, MessageIds>({
 
       const nonNullishTypes = types.filter(
         type =>
-          !tools.isTypeFlagSet(
+          !tsutils.isTypeFlagSet(
             type,
             ts.TypeFlags.Undefined | ts.TypeFlags.Null,
           ),