Merge pull request #206 from rbuckton/flexibleParamParsing

Flexible parsing of param/typeParam

Author: octogonz

common/changes/@microsoft/tsdoc/flexibleParamParsing_2019-12-20-01-20.json

@@ -0,0 +1,11 @@
+{
+  "changes": [
+    {
+      "packageName": "@microsoft/tsdoc",
+      "comment": "Improve the parsing of `@param` and `@typeParam` tags to recognize legacy syntaxes",
+      "type": "patch"
+    }
+  ],
+  "packageName": "@microsoft/tsdoc",
+  "email": "ron.buckton@microsoft.com"
+}

tsdoc/.npmrc

@@ -1,2 +1,3 @@
 registry=https://registry.npmjs.org/
 always-auth=false
+package-lock=false

tsdoc/.vscode/launch.json

@@ -18,7 +18,11 @@
       "request": "launch",
       "name": "Jest Current File",
       "program": "${workspaceFolder}/node_modules/jest/bin/jest",
-      "args": ["${relativeFile}"],
+      "args": [
+        "--runInBand",
+        "--testPathPattern",
+        "${fileBasename}"
+      ],
       "console": "integratedTerminal",
       "internalConsoleOptions": "neverOpen"
     }

tsdoc/src/__tests__/ParsingBasics.test.ts

@@ -111,3 +111,50 @@ test('04 typeParam blocks', () => {
     ' */'
   ].join('\n'));
 });
+
+test('05 Invalid JSDoc syntax in @param blocks', () => {
+  TestHelpers.parseAndMatchDocCommentSnapshot([
+    '/**',
+    ' * @param {type} a - description',
+    ' * @param {{}} b - description',
+    ' * @param {"{"} c - description',
+    ' * @param {"\\""} d - description',
+    ' * @param e {type} - description',
+    ' * @param f {{}} - description',
+    ' * @param g {"{"} - description',
+    ' * @param h - {type} description',
+    ' * @param i - {{}} description',
+    ' * @param j - {"{"} description',
+    ' * @param [k] - description',
+    ' * @param [l=] - description',
+    ' * @param [m=[]] - description',
+    ' * @param [n="["] - description',
+    ' * @param [o="\\""] - description',
+    ' */'
+  ].join('\n'));
+});
+
+test('06 Invalid JSDoc optional name', () => {
+  TestHelpers.parseAndMatchDocCommentSnapshot([
+    '/**',
+    ' * Example 1',
+    ' *',
+    ' * @param [n - this is',
+    ' * the description',
+    ' *',
+    ' * @public',
+    ' */'
+  ].join('\n'));
+});
+
+test('07 Invalid JSDoc type', () => {
+  TestHelpers.parseAndMatchDocCommentSnapshot([
+    '/**',
+    ' * Example 1',
+    ' *',
+    ' * @param { test',
+    ' *',
+    ' * @public',
+    ' */'
+  ].join('\n'));
+});