Merge pull request microsoft#16122 from Microsoft/master-fix16092

[Master] ts-style @Property
zfkl · May 30, 2017 · d82a57e · d82a57e
2 parents 2c3c4dd + 27078f9
commit d82a57e
Show file tree

Hide file tree

Showing 19 changed files with 170 additions and 89 deletions.
diff --git a/src/compiler/parser.ts b/src/compiler/parser.ts
@@ -6510,7 +6510,7 @@ namespace ts {
                             case "arg":
                             case "argument":
                             case "param":
-                                tag = parseParamTag(atToken, tagName);
+                                tag = parseParameterOrPropertyTag(atToken, tagName, /*shouldParseParamTag*/ true);
                                 break;
                             case "return":
                             case "returns":
@@ -6655,11 +6655,12 @@ namespace ts {
                     return { name, isBracketed };
                 }
 
-                function parseParamTag(atToken: AtToken, tagName: Identifier) {
+                function parseParameterOrPropertyTag(atToken: AtToken, tagName: Identifier, shouldParseParamTag: boolean): JSDocPropertyTag | JSDocParameterTag {
                     let typeExpression = tryParseTypeExpression();
                     skipWhitespace();
 
                     const { name, isBracketed } = parseBracketNameInPropertyAndParamTag();
+                    skipWhitespace();
 
                     if (!name) {
                         parseErrorAtPosition(scanner.getStartPos(), 0, Diagnostics.Identifier_expected);
@@ -6678,13 +6679,15 @@ namespace ts {
                         typeExpression = tryParseTypeExpression();
                     }
 
-                    const result = <JSDocParameterTag>createNode(SyntaxKind.JSDocParameterTag, atToken.pos);
+                    const result = shouldParseParamTag ?
+                        <JSDocParameterTag>createNode(SyntaxKind.JSDocParameterTag, atToken.pos) :
+                        <JSDocPropertyTag>createNode(SyntaxKind.JSDocPropertyTag, atToken.pos);
                     result.atToken = atToken;
                     result.tagName = tagName;
                     result.preParameterName = preName;
                     result.typeExpression = typeExpression;
                     result.postParameterName = postName;
-                    result.parameterName = postName || preName;
+                    result.name = postName || preName;
                     result.isBracketed = isBracketed;
                     return finishNode(result);
                 }
@@ -6713,26 +6716,6 @@ namespace ts {
                     return finishNode(result);
                 }
 
-                function parsePropertyTag(atToken: AtToken, tagName: Identifier): JSDocPropertyTag {
-                    const typeExpression = tryParseTypeExpression();
-                    skipWhitespace();
-                    const { name, isBracketed } = parseBracketNameInPropertyAndParamTag();
-                    skipWhitespace();
-
-                    if (!name) {
-                        parseErrorAtPosition(scanner.getStartPos(), /*length*/ 0, Diagnostics.Identifier_expected);
-                        return undefined;
-                    }
-
-                    const result = <JSDocPropertyTag>createNode(SyntaxKind.JSDocPropertyTag, atToken.pos);
-                    result.atToken = atToken;
-                    result.tagName = tagName;
-                    result.name = name;
-                    result.typeExpression = typeExpression;
-                    result.isBracketed = isBracketed;
-                    return finishNode(result);
-                }
-
                 function parseAugmentsTag(atToken: AtToken, tagName: Identifier): JSDocAugmentsTag {
                     const typeExpression = tryParseTypeExpression();
 
@@ -6869,7 +6852,7 @@ namespace ts {
                             return true;
                         case "prop":
                         case "property":
-                            const propertyTag = parsePropertyTag(atToken, tagName);
+                            const propertyTag = parseParameterOrPropertyTag(atToken, tagName, /*shouldParseParamTag*/ false) as JSDocPropertyTag;
                             if (propertyTag) {
                                 if (!parentTag.jsDocPropertyTags) {
                                     parentTag.jsDocPropertyTags = <NodeArray<JSDocPropertyTag>>[];

diff --git a/src/compiler/types.ts b/src/compiler/types.ts
@@ -2145,6 +2145,10 @@ namespace ts {
         parent: JSDoc;
         kind: SyntaxKind.JSDocPropertyTag;
         name: Identifier;
+        /** the parameter name, if provided *before* the type (TypeScript-style) */
+        preParameterName?: Identifier;
+        /** the parameter name, if provided *after* the type (JSDoc-standard) */
+        postParameterName?: Identifier;
         typeExpression: JSDocTypeExpression;
         isBracketed: boolean;
     }
@@ -2163,7 +2167,7 @@ namespace ts {
         /** the parameter name, if provided *after* the type (JSDoc-standard) */
         postParameterName?: Identifier;
         /** the parameter name, regardless of the location it was provided */
-        parameterName: Identifier;
+        name: Identifier;
         isBracketed: boolean;
     }
 

diff --git a/src/compiler/utilities.ts b/src/compiler/utilities.ts
@@ -1635,7 +1635,7 @@ namespace ts {
         }
         else if (param.name.kind === SyntaxKind.Identifier) {
             const name = (param.name as Identifier).text;
-            return filter(tags, tag => tag.kind === SyntaxKind.JSDocParameterTag && tag.parameterName.text === name);
+            return filter(tags, tag => tag.kind === SyntaxKind.JSDocParameterTag && tag.name.text === name);
         }
         else {
             // TODO: it's a destructured parameter, so it should look up an "object type" series of multiple lines
@@ -1646,7 +1646,7 @@ namespace ts {
 
     /** Does the opposite of `getJSDocParameterTags`: given a JSDoc parameter, finds the parameter corresponding to it. */
     export function getParameterFromJSDoc(node: JSDocParameterTag): ParameterDeclaration | undefined {
-        const name = node.parameterName.text;
+        const name = node.name.text;
         const grandParent = node.parent!.parent!;
         Debug.assert(node.parent!.kind === SyntaxKind.JSDocComment);
         if (!isFunctionLike(grandParent)) {

diff --git a/...s/baselines/reference/JSDocParsing/DocComments.parsesCorrectly.argSynonymForParamTag.json b/...s/baselines/reference/JSDocParsing/DocComments.parsesCorrectly.argSynonymForParamTag.json
@@ -6,7 +6,7 @@
         "0": {
             "kind": "JSDocParameterTag",
             "pos": 8,
-            "end": 27,
+            "end": 28,
             "atToken": {
                 "kind": "AtToken",
                 "pos": 8,
@@ -34,7 +34,7 @@
                 "end": 27,
                 "text": "name1"
             },
-            "parameterName": {
+            "name": {
                 "kind": "Identifier",
                 "pos": 22,
                 "end": 27,
@@ -44,6 +44,6 @@
         },
         "length": 1,
         "pos": 8,
-        "end": 27
+        "end": 28
     }
 }
diff --git a/...elines/reference/JSDocParsing/DocComments.parsesCorrectly.argumentSynonymForParamTag.json b/...elines/reference/JSDocParsing/DocComments.parsesCorrectly.argumentSynonymForParamTag.json
@@ -6,7 +6,7 @@
         "0": {
             "kind": "JSDocParameterTag",
             "pos": 8,
-            "end": 32,
+            "end": 33,
             "atToken": {
                 "kind": "AtToken",
                 "pos": 8,
@@ -34,7 +34,7 @@
                 "end": 32,
                 "text": "name1"
             },
-            "parameterName": {
+            "name": {
                 "kind": "Identifier",
                 "pos": 27,
                 "end": 32,
@@ -44,6 +44,6 @@
         },
         "length": 1,
         "pos": 8,
-        "end": 32
+        "end": 33
     }
 }
diff --git a/tests/baselines/reference/JSDocParsing/DocComments.parsesCorrectly.oneParamTag.json b/tests/baselines/reference/JSDocParsing/DocComments.parsesCorrectly.oneParamTag.json
@@ -6,7 +6,7 @@
         "0": {
             "kind": "JSDocParameterTag",
             "pos": 8,
-            "end": 29,
+            "end": 30,
             "atToken": {
                 "kind": "AtToken",
                 "pos": 8,
@@ -34,7 +34,7 @@
                 "end": 29,
                 "text": "name1"
             },
-            "parameterName": {
+            "name": {
                 "kind": "Identifier",
                 "pos": 24,
                 "end": 29,
@@ -44,6 +44,6 @@
         },
         "length": 1,
         "pos": 8,
-        "end": 29
+        "end": 30
     }
 }
diff --git a/tests/baselines/reference/JSDocParsing/DocComments.parsesCorrectly.paramTag1.json b/tests/baselines/reference/JSDocParsing/DocComments.parsesCorrectly.paramTag1.json
@@ -6,7 +6,7 @@
         "0": {
             "kind": "JSDocParameterTag",
             "pos": 8,
-            "end": 29,
+            "end": 30,
             "atToken": {
                 "kind": "AtToken",
                 "pos": 8,
@@ -34,7 +34,7 @@
                 "end": 29,
                 "text": "name1"
             },
-            "parameterName": {
+            "name": {
                 "kind": "Identifier",
                 "pos": 24,
                 "end": 29,
@@ -44,6 +44,6 @@
         },
         "length": 1,
         "pos": 8,
-        "end": 29
+        "end": 30
     }
 }
diff --git a/.../baselines/reference/JSDocParsing/DocComments.parsesCorrectly.paramTagBracketedName1.json b/.../baselines/reference/JSDocParsing/DocComments.parsesCorrectly.paramTagBracketedName1.json
@@ -34,7 +34,7 @@
                 "end": 30,
                 "text": "name1"
             },
-            "parameterName": {
+            "name": {
                 "kind": "Identifier",
                 "pos": 25,
                 "end": 30,

diff --git a/.../baselines/reference/JSDocParsing/DocComments.parsesCorrectly.paramTagBracketedName2.json b/.../baselines/reference/JSDocParsing/DocComments.parsesCorrectly.paramTagBracketedName2.json
@@ -34,7 +34,7 @@
                 "end": 31,
                 "text": "name1"
             },
-            "parameterName": {
+            "name": {
                 "kind": "Identifier",
                 "pos": 26,
                 "end": 31,

diff --git a/...s/baselines/reference/JSDocParsing/DocComments.parsesCorrectly.paramTagNameThenType1.json b/...s/baselines/reference/JSDocParsing/DocComments.parsesCorrectly.paramTagNameThenType1.json
@@ -34,7 +34,7 @@
                     "end": 28
                 }
             },
-            "parameterName": {
+            "name": {
                 "kind": "Identifier",
                 "pos": 15,
                 "end": 20,

diff --git a/...s/baselines/reference/JSDocParsing/DocComments.parsesCorrectly.paramTagNameThenType2.json b/...s/baselines/reference/JSDocParsing/DocComments.parsesCorrectly.paramTagNameThenType2.json
@@ -34,7 +34,7 @@
                     "end": 28
                 }
             },
-            "parameterName": {
+            "name": {
                 "kind": "Identifier",
                 "pos": 15,
                 "end": 20,

diff --git a/tests/baselines/reference/JSDocParsing/DocComments.parsesCorrectly.paramWithoutType.json b/tests/baselines/reference/JSDocParsing/DocComments.parsesCorrectly.paramWithoutType.json
@@ -6,7 +6,7 @@
         "0": {
             "kind": "JSDocParameterTag",
             "pos": 8,
-            "end": 18,
+            "end": 19,
             "atToken": {
                 "kind": "AtToken",
                 "pos": 8,
@@ -24,7 +24,7 @@
                 "end": 18,
                 "text": "foo"
             },
-            "parameterName": {
+            "name": {
                 "kind": "Identifier",
                 "pos": 15,
                 "end": 18,
@@ -34,6 +34,6 @@
         },
         "length": 1,
         "pos": 8,
-        "end": 18
+        "end": 19
     }
 }
diff --git a/tests/baselines/reference/JSDocParsing/DocComments.parsesCorrectly.twoParamTag2.json b/tests/baselines/reference/JSDocParsing/DocComments.parsesCorrectly.twoParamTag2.json
@@ -6,7 +6,7 @@
         "0": {
             "kind": "JSDocParameterTag",
             "pos": 8,
-            "end": 29,
+            "end": 32,
             "atToken": {
                 "kind": "AtToken",
                 "pos": 8,
@@ -34,7 +34,7 @@
                 "end": 29,
                 "text": "name1"
             },
-            "parameterName": {
+            "name": {
                 "kind": "Identifier",
                 "pos": 24,
                 "end": 29,
@@ -45,7 +45,7 @@
         "1": {
             "kind": "JSDocParameterTag",
             "pos": 34,
-            "end": 55,
+            "end": 56,
             "atToken": {
                 "kind": "AtToken",
                 "pos": 34,
@@ -73,7 +73,7 @@
                 "end": 55,
                 "text": "name2"
             },
-            "parameterName": {
+            "name": {
                 "kind": "Identifier",
                 "pos": 50,
                 "end": 55,
@@ -83,6 +83,6 @@
         },
         "length": 2,
         "pos": 8,
-        "end": 55
+        "end": 56
     }
 }
diff --git a/...s/baselines/reference/JSDocParsing/DocComments.parsesCorrectly.twoParamTagOnSameLine.json b/...s/baselines/reference/JSDocParsing/DocComments.parsesCorrectly.twoParamTagOnSameLine.json
@@ -6,7 +6,7 @@
         "0": {
             "kind": "JSDocParameterTag",
             "pos": 8,
-            "end": 29,
+            "end": 30,
             "atToken": {
                 "kind": "AtToken",
                 "pos": 8,
@@ -34,7 +34,7 @@
                 "end": 29,
                 "text": "name1"
             },
-            "parameterName": {
+            "name": {
                 "kind": "Identifier",
                 "pos": 24,
                 "end": 29,
@@ -45,7 +45,7 @@
         "1": {
             "kind": "JSDocParameterTag",
             "pos": 30,
-            "end": 51,
+            "end": 52,
             "atToken": {
                 "kind": "AtToken",
                 "pos": 30,
@@ -73,7 +73,7 @@
                 "end": 51,
                 "text": "name2"
             },
-            "parameterName": {
+            "name": {
                 "kind": "Identifier",
                 "pos": 46,
                 "end": 51,
@@ -83,6 +83,6 @@
         },
         "length": 2,
         "pos": 8,
-        "end": 51
+        "end": 52
     }
 }