feat: update function name

nestjs · Feb 13, 2024 · 746ee88 · 746ee88
1 parent e3eed25
commit 746ee88
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 7 deletions.
diff --git a/lib/plugin/utils/ast-utils.ts b/lib/plugin/utils/ast-utils.ts
@@ -228,24 +228,25 @@ export function getTsDocTagsOfNode(node: Node, typeChecker: TypeChecker) {
   return tagResults;
 }
 
-export function getTsDocReturnsOrErrorOfNode(node: Node) {
+export function getTsDocErrorsOfNode(node: Node) {
   const tsdocParser: TSDocParser = new TSDocParser();
   const parserContext: ParserContext = tsdocParser.parseString(
     node.getFullText()
   );
   const docComment: DocComment = parserContext.docComment;
 
   const tagResults = [];
+  const errorParsingRegex = /{(\d+)} (.*)/;
+
   const introspectTsDocTags = (docComment: DocComment) => {
-    const blocks = docComment.customBlocks.filter((block) =>
-      ['@throws', '@returns'].includes(block.blockTag.tagName)
+    const blocks = docComment.customBlocks.filter(
+      (block) => block.blockTag.tagName === '@throws'
     );
 
     blocks.forEach((block) => {
       try {
         const docValue = renderDocNode(block.content).split('\n')[0].trim();
-        const regex = /{(\d+)} (.*)/;
-        const match = docValue.match(regex);
+        const match = docValue.match(errorParsingRegex);
         tagResults.push({
           status: match[1],
           description: `"${match[2]}"`

diff --git a/lib/plugin/visitors/controller-class.visitor.ts b/lib/plugin/visitors/controller-class.visitor.ts
@@ -9,7 +9,7 @@ import {
   getDecoratorArguments,
   getDecoratorName,
   getMainCommentOfNode,
-  getTsDocReturnsOrErrorOfNode,
+  getTsDocErrorsOfNode,
   getTsDocTagsOfNode
 } from '../utils/ast-utils';
 import {
@@ -353,7 +353,7 @@ export class ControllerClassVisitor extends AbstractFileVisitor {
       }
     }
 
-    const tags = getTsDocReturnsOrErrorOfNode(node);
+    const tags = getTsDocErrorsOfNode(node);
     if (!tags.length) {
       return [];
     }