Support TypeScript parameter properties

+ add typescript parser devDependency
+ add tests to requireParam and checkParamName
+ extend jsdocUtils

Fixes #177

Author: c-vetter

package.json

@@ -19,6 +19,7 @@
     "@babel/plugin-transform-flow-strip-types": "^7.4.4",
     "@babel/preset-env": "^7.4.5",
     "@babel/register": "^7.4.4",
+    "@typescript-eslint/parser": "^1.5.0",
     "babel-eslint": "^10.0.2",
     "babel-plugin-add-module-exports": "^1.0.2",
     "babel-plugin-istanbul": "^5.1.4",

src/jsdocUtils.js

@@ -2,7 +2,7 @@ import _ from 'lodash';
 import tagNames from './tagNames';
 
 const getFunctionParameterNames = (functionNode : Object) : Array<string> => {
-  return _.map(functionNode.params, (param) => {
+  const functionParameterNameMapper = (param) => {
     if (_.has(param, 'name')) {
       return param.name;
     }
@@ -23,8 +23,14 @@ const getFunctionParameterNames = (functionNode : Object) : Array<string> => {
       return param.argument.name;
     }
 
+    if (param.type === 'TSParameterProperty') {
+      return functionParameterNameMapper(param.parameter);
+    }
+
     throw new Error('Unsupported function signature format.');
-  });
+  };
+
+  return _.map(functionNode.params, functionParameterNameMapper);
 };
 
 /**

test/rules/assertions/checkParamNames.js

@@ -274,6 +274,20 @@ export default {
 
           };
       `
+    },
+    {
+      code: `
+        export class SomeClass {
+          /**
+           * @param property
+           */
+          constructor(private property: string) {}
+        }
+      `,
+      parser: '@typescript-eslint/parser',
+      parserOptions: {
+        sourceType: 'module'
+      }
     }
   ]
 };

test/rules/assertions/requireParam.js

@@ -673,6 +673,20 @@ export default {
             }
           }
       `
+    },
+    {
+      code: `
+        export class SomeClass {
+          /**
+           * @param property
+           */
+          constructor(private property: string) {}
+        }
+      `,
+      parser: '@typescript-eslint/parser',
+      parserOptions: {
+        sourceType: 'module'
+      }
     }
   ]
 };