Add test for shorter return statement and fix shorter return statemen…

…t bug
neild3r · May 9, 2021 · 6169ebc · 6169ebc
1 parent 240ac24
commit 6169ebc
Show file tree

Hide file tree

Showing 2 changed files with 34 additions and 1 deletion.
diff --git a/src/doc.ts b/src/doc.ts
@@ -164,7 +164,9 @@ export class Doc
         if (this.return && (this.return != 'void' || Config.instance.get('returnVoid'))) {
             let appendSpace = '';
             if (alignReturn) {
-                appendSpace = Array(1 + maxParamNameLength).fill(' ').join('');
+                appendSpace =
+                    Array(1 + maxParamTypeLength - this.return.length).fill(' ').join('') +
+                    Array(maxParamNameLength).fill(' ').join('');
             }
             returnString = "@return \${###:" +this.return + "}" + appendSpace;
         }

diff --git a/test/fixtures/doc.json b/test/fixtures/doc.json
@@ -426,5 +426,36 @@
             " * @return ${4:LongClassName}           ",
             " */"
         ]
+    },
+    {
+        "name": "Align params and shorter return statement",
+        "config": {
+            "gap": true,
+            "alignParams": true,
+            "alignReturn": true
+        },
+        "input": {
+            "message": "Undocumented function",
+            "params": [
+                {
+                    "name": "$nameLong",
+                    "type": "int"
+                },
+                {
+                    "name": "$name",
+                    "type": "string"
+                }
+            ],
+            "return": "int"
+        },
+        "expected": [
+            "/**",
+            " * ${1:Undocumented function}",
+            " *",
+            " * @param  ${2:int}    \\$nameLong ",
+            " * @param  ${3:string} \\$name     ",
+            " * @return ${4:int}              ",
+            " */"
+        ]
     }
 ]