fix(check-param-names): failure to handle default params with spaci…

…ng; closes #377
gajus · Dec 2, 2019 · c361ef6 · c361ef6
1 parent 67df3dd
commit c361ef6
Show file tree

Hide file tree

Showing 3 changed files with 43 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -1515,6 +1515,14 @@ function quux (foo) {
 }
 // Settings: {"jsdoc":{"tagNamePreference":{"param":false}}}
 // Message: Unexpected tag `@param`
+
+/**
+ * @param {Error} error Exit code
+ * @param {number} [code = 1] Exit code
+ */
+function quux (error, cde = 1) {
+};
+// Message: Expected @param names to be "error, cde". Got "error, code".
 ````
 
 The following patterns are not considered problems:
@@ -1603,6 +1611,13 @@ export class SomeClass {
    */
   constructor(private property: string) {}
 }
+
+/**
+ * @param {Error} error Exit code
+ * @param {number} [code = 1] Exit code
+ */
+function quux (error, code = 1) {
+};
 ````
 
 

diff --git a/src/rules/checkParamNames.js b/src/rules/checkParamNames.js
@@ -40,10 +40,10 @@ const validateParameterNames = (targetTagName : string, functionParameterNames :
       return false;
     }
 
-    if (functionParameterName !== tag.name) {
+    if (functionParameterName !== tag.name.trim()) {
       const expectedNames = functionParameterNames.join(', ');
       const actualNames = paramTags.map(([, {name}]) => {
-        return name;
+        return name.trim();
       }).join(', ');
 
       report(

diff --git a/test/rules/assertions/checkParamNames.js b/test/rules/assertions/checkParamNames.js
@@ -231,6 +231,22 @@ export default {
         },
       },
     },
+    {
+      code: `
+          /**
+           * @param {Error} error Exit code
+           * @param {number} [code = 1] Exit code
+           */
+          function quux (error, cde = 1) {
+          };
+      `,
+      errors: [
+        {
+          line: 4,
+          message: 'Expected @param names to be "error, cde". Got "error, code".',
+        },
+      ],
+    },
   ],
   valid: [
     {
@@ -354,5 +370,15 @@ export default {
         sourceType: 'module',
       },
     },
+    {
+      code: `
+          /**
+           * @param {Error} error Exit code
+           * @param {number} [code = 1] Exit code
+           */
+          function quux (error, code = 1) {
+          };
+      `,
+    },
   ],
 };