Merge pull request #67 from Xvezda/feature/refactor

Refactor

Author: Xvezda

src/rules/check-throws-tag-type.js

@@ -26,6 +26,7 @@ const {
   findIdentifierDeclaration,
   toFlattenedTypeArray,
   typesToUnionString,
+  typeStringsToUnionString,
   findFunctionCallNodes,
 } = require('../utils');
 
@@ -443,7 +444,7 @@ module.exports = createRule({
                   toSortedByMetadata([...throwableTypes, ...rejectableTypes])
                 )
               }>`
-              : [
+              : typeStringsToUnionString([
                 throwableTypes.length
                   ? typesToUnionString(
                     checker, toSortedByMetadata(throwableTypes),
@@ -456,7 +457,7 @@ module.exports = createRule({
                       toSortedByMetadata(rejectableTypes),
                     )}>`
                   : '',
-              ].filter(t => !!t).join(' | ')
+              ].filter(t => !!t))
           );
         },
       });

src/rules/no-implicit-propagation.js

@@ -3,6 +3,7 @@ const { ESLintUtils } = require('@typescript-eslint/utils');
 const {
   TypeMap,
   getNodeID,
+  getNodeIndent,
   createRule,
   isInHandledContext,
   typesToUnionString,
@@ -98,9 +99,7 @@ module.exports = createRule({
         node,
         messageId: 'implicitPropagation',
         fix(fixer) {
-          const lines = sourceCode.getLines();
-          const currentLine = lines[nodeToComment.loc.start.line - 1];
-          const indent = currentLine.match(/^\s*/)?.[0] ?? '';
+          const indent = getNodeIndent(sourceCode, nodeToComment);
 
           return fixer
             .insertTextBefore(

src/rules/no-undocumented-throws.js

@@ -5,10 +5,12 @@ const ts = require('typescript');
 const {
   TypeMap,
   getNodeID,
+  getNodeIndent,
   getFirst,
   createRule,
   hasJSDocThrowsTag,
   typesToUnionString,
+  typeStringsToUnionString,
   isInHandledContext,
   isInAsyncHandledContext,
   isNodeReturned,
@@ -126,27 +128,28 @@ module.exports = createRule({
         throwStatementsInFunction.get(getNodeID(node));
 
       if (throwStatementNodes) {
-        /** @type {import('typescript').Type[]} */
         const throwStatementTypes =
-          toFlattenedTypeArray(
-            throwStatementNodes
-              .map(n => {
-                const type = services.getTypeAtLocation(n.argument);
-
-                if (
-                  useBaseTypeOfLiteral &&
-                  ts.isLiteralTypeLiteral(
-                    services.esTreeNodeToTSNodeMap.get(n.argument)
-                  )
-                ) {
-                  return checker.getBaseTypeOfLiteralType(type);
-                }
-                return type;
-              })
-          )
+          throwStatementNodes
+            .map(n => {
+              const type = services.getTypeAtLocation(n.argument);
+
+              if (
+                useBaseTypeOfLiteral &&
+                ts.isLiteralTypeLiteral(
+                  services.esTreeNodeToTSNodeMap.get(n.argument)
+                )
+              ) {
+                return checker.getBaseTypeOfLiteralType(type);
+              }
+              return type;
+            });
+
+        const flattenedTypes = toFlattenedTypeArray(throwStatementTypes);
+
+        const awaitedTypes = flattenedTypes
           .map(t => checker.getAwaitedType(t) ?? t);
 
-        throwTypes.add(node, throwStatementTypes);
+        throwTypes.add(node, awaitedTypes);
       }
 
       const throwableTypes =
@@ -176,24 +179,22 @@ module.exports = createRule({
         node: nodeToComment,
         messageId: 'missingThrowsTag',
         fix(fixer) {
-          const lines = sourceCode.getLines();
-          const currentLine = lines[node.loc.start.line - 1];
-          const indent = currentLine.match(/^\s*/)?.[0] ?? '';
+          const indent = getNodeIndent(sourceCode, node);
 
-          const newType =
+          const newType = 
             node.async
-            ? `Promise<${typesToUnionString(checker, [
-              ...throwableTypes,
-              ...rejectableTypes,
-            ])}>`
-            : [
-              ...throwableTypes.length
-                ? [typesToUnionString(checker, throwableTypes)]
-                : [],
-              ...rejectableTypes.length
-                ? [`Promise<${typesToUnionString(checker, rejectableTypes)}>`]
-                : [],
-            ].join(' | ');
+              ? `Promise<${typesToUnionString(checker, [
+                ...throwableTypes,
+                ...rejectableTypes,
+              ])}>`
+              : typeStringsToUnionString([
+                ...throwableTypes.length
+                  ? [typesToUnionString(checker, throwableTypes)]
+                  : [],
+                ...rejectableTypes.length
+                  ? [`Promise<${typesToUnionString(checker, rejectableTypes)}>`]
+                  : [],
+              ]);
 
           return fixer
             .insertTextBefore(

src/utils.js

@@ -88,6 +88,22 @@ const getNodeID = (node) => {
   return `${node.loc.start.line}:${node.loc.start.column}`;
 };
 
+/**
+ * Get indentation of the node in source code.
+ * 
+ * @public
+ * @param {Readonly<import('@typescript-eslint/utils').TSESLint.SourceCode>} sourceCode
+ * @param {import('@typescript-eslint/utils').TSESTree.Node} node
+ * @returns {string}
+ */
+const getNodeIndent = (sourceCode, node) => {
+  const lines = sourceCode.getLines();
+  const currentLine = lines[node.loc.start.line - 1];
+  const indent = currentLine.match(/^\s*/)?.[0] ?? '';
+
+  return indent;
+};
+
 /**
  * Check if node has JSDoc comment with @throws or @exception tag.
  *
@@ -107,6 +123,16 @@ const hasJSDocThrowsTag = (sourceCode, node) => {
   return isCommented;
 };
 
+/**
+ * Combine multiple types into union type string of given types.
+ *
+ * @public
+ * @param {string[]} typeStrings
+ * @return {string}
+ */
+const typeStringsToUnionString = (typeStrings) =>
+  [...new Set(typeStrings)].join(' | ');
+
 /**
  * Combine multiple types into union type string of given types.
  *
@@ -116,7 +142,7 @@ const hasJSDocThrowsTag = (sourceCode, node) => {
  * @return {string}
  */
 const typesToUnionString = (checker, types) =>
-  [...new Set(types.map(t => utils.getTypeName(checker, t)))].join(' | ');
+  typeStringsToUnionString(types.map(t => utils.getTypeName(checker, t)))
 
 /**
  * Find closest node that matches the callback predicate.
@@ -719,9 +745,11 @@ module.exports = {
   getFirst,
   getLast,
   getNodeID,
+  getNodeIndent,
   createRule,
   hasThrowsTag,
   hasJSDocThrowsTag,
+  typeStringsToUnionString,
   typesToUnionString,
   findClosest,
   findParent,