Merge pull request #2154 from bangbang93/master

fix(plugin): empty comment do not emit @ApiOperation decorator
nestjs · Feb 6, 2023 · ce1712c · ce1712c
2 parents 4f786b1 + f4e35f2
commit ce1712c
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 0 deletions.
diff --git a/lib/plugin/visitors/controller-class.visitor.ts b/lib/plugin/visitors/controller-class.visitor.ts
@@ -163,6 +163,9 @@ export class ControllerClassVisitor extends AbstractFileVisitor {
       (apiOperationExpr.properties as ts.NodeArray<ts.PropertyAssignment>);
 
     const extractedComments = getMainCommentOfNode(node, sourceFile);
+    if (!extractedComments) {
+      return [];
+    }
     const tags = getTsDocTagsOfNode(node, sourceFile, typeChecker);
 
     const properties = [

diff --git a/test/plugin/fixtures/app.controller-without-modifiers.ts b/test/plugin/fixtures/app.controller-without-modifiers.ts
@@ -56,6 +56,10 @@ export class AppController {
   @Get()
   @HttpCode(HttpStatus.NO_CONTENT)
   findAll(): Promise<Cat[]> {}
+  
+  @Get()
+  @HttpCode(HttpStatus.NO_CONTENT)
+  noComment() {}
 }`;
 
 export const appControllerWithoutModifiersTextTranspiled = `\"use strict\";
@@ -102,6 +106,7 @@ let AppController = class AppController {
      * @memberof AppController
      */
     findAll() { }
+    noComment() { }
 };
 __decorate([
     openapi.ApiOperation({ summary: "create a Cat" }),
@@ -129,6 +134,11 @@ __decorate([
     HttpCode(common_1.HttpStatus.NO_CONTENT),
     openapi.ApiResponse({ status: common_1.HttpStatus.NO_CONTENT, type: [Cat] })
 ], AppController.prototype, \"findAll\", null);
+__decorate([
+    Get(),
+    HttpCode(common_1.HttpStatus.NO_CONTENT),
+    openapi.ApiResponse({ status: common_1.HttpStatus.NO_CONTENT })
+], AppController.prototype, \"noComment\", null);
 AppController = __decorate([
     (0, common_1.Controller)('cats')
 ], AppController);