@microsoft/tsdoc - npm Package Compare versions

Comparing version 0.12.16 to 0.12.17

CHANGELOG.json

@@ -5,2 +5,14 @@ {
     {
+      "version": "0.12.17",
+      "tag": "@microsoft/tsdoc_v0.12.17",
+      "date": "Sat, 22 Feb 2020 02:55:07 GMT",
+      "comments": {
+        "patch": [
+          {
+            "comment": "Improve the parsing of `@param` and `@typeParam` tags to recognize legacy syntaxes"
+          }
+        ]
+      }
+    },
+    {
       "version": "0.12.16",
@@ -7,0 +19,0 @@ "tag": "@microsoft/tsdoc_v0.12.16",

CHANGELOG.md

 # Change Log - @microsoft/tsdoc
 
-This log was last generated on Tue, 19 Nov 2019 22:01:56 GMT and should not be manually modified.
+This log was last generated on Sat, 22 Feb 2020 02:55:07 GMT and should not be manually modified.
 
+## 0.12.17
+Sat, 22 Feb 2020 02:55:07 GMT
+
+### Patches
+
+- Improve the parsing of `@param` and `@typeParam` tags to recognize legacy syntaxes
+
 ## 0.12.16
@@ -6,0 +13,0 @@ Tue, 19 Nov 2019 22:01:56 GMT

lib/nodes/DocParamBlock.d.ts

@@ -15,7 +15,12 @@ import { DocNodeKind, DocNode } from './DocNode';
     spacingBeforeParameterNameExcerpt?: TokenSequence;
+    unsupportedJsdocTypeBeforeParameterNameExcerpt?: TokenSequence;
+    unsupportedJsdocOptionalNameOpenBracketExcerpt?: TokenSequence;
     parameterNameExcerpt: TokenSequence;
     parameterName: string;
+    unsupportedJsdocOptionalNameRestExcerpt?: TokenSequence;
     spacingAfterParameterNameExcerpt?: TokenSequence;
-    hyphenExcerpt: TokenSequence;
+    unsupportedJsdocTypeAfterParameterNameExcerpt?: TokenSequence;
+    hyphenExcerpt?: TokenSequence;
     spacingAfterHyphenExcerpt?: TokenSequence;
+    unsupportedJsdocTypeAfterHyphenExcerpt?: TokenSequence;
 }
@@ -28,7 +33,12 @@ /**
     private readonly _spacingBeforeParameterNameExcerpt;
+    private readonly _unsupportedJsdocTypeBeforeParameterNameExcerpt;
+    private readonly _unsupportedJsdocOptionalNameOpenBracketExcerpt;
     private readonly _parameterName;
     private readonly _parameterNameExcerpt;
+    private readonly _unsupportedJsdocOptionalNameRestExcerpt;
     private readonly _spacingAfterParameterNameExcerpt;
+    private readonly _unsupportedJsdocTypeAfterParameterNameExcerpt;
     private readonly _hyphenExcerpt;
     private readonly _spacingAfterHyphenExcerpt;
+    private readonly _unsupportedJsdocTypeAfterHyphenExcerpt;
     /**
@@ -35,0 +45,0 @@ * Don't call this directly.  Instead use {@link TSDocParser}

lib/nodes/DocParamBlock.js

@@ -40,2 +40,16 @@ "use strict";
             }
+            if (parameters.unsupportedJsdocTypeBeforeParameterNameExcerpt) {
+                _this._unsupportedJsdocTypeBeforeParameterNameExcerpt = new DocExcerpt_1.DocExcerpt({
+                    configuration: _this.configuration,
+                    excerptKind: "ErrorText" /* ErrorText */,
+                    content: parameters.unsupportedJsdocTypeBeforeParameterNameExcerpt
+                });
+            }
+            if (parameters.unsupportedJsdocOptionalNameOpenBracketExcerpt) {
+                _this._unsupportedJsdocOptionalNameOpenBracketExcerpt = new DocExcerpt_1.DocExcerpt({
+                    configuration: _this.configuration,
+                    excerptKind: "ErrorText" /* ErrorText */,
+                    content: parameters.unsupportedJsdocOptionalNameOpenBracketExcerpt
+                });
+            }
             _this._parameterNameExcerpt = new DocExcerpt_1.DocExcerpt({
@@ -46,2 +60,9 @@ configuration: _this.configuration,
             });
+            if (parameters.unsupportedJsdocOptionalNameRestExcerpt) {
+                _this._unsupportedJsdocOptionalNameRestExcerpt = new DocExcerpt_1.DocExcerpt({
+                    configuration: _this.configuration,
+                    excerptKind: "ErrorText" /* ErrorText */,
+                    content: parameters.unsupportedJsdocOptionalNameRestExcerpt
+                });
+            }
             if (parameters.spacingAfterParameterNameExcerpt) {
@@ -54,7 +75,16 @@ _this._spacingAfterParameterNameExcerpt = new DocExcerpt_1.DocExcerpt({
             }
-            _this._hyphenExcerpt = new DocExcerpt_1.DocExcerpt({
-                configuration: _this.configuration,
-                excerptKind: "ParamBlock_Hyphen" /* ParamBlock_Hyphen */,
-                content: parameters.hyphenExcerpt
-            });
+            if (parameters.unsupportedJsdocTypeAfterParameterNameExcerpt) {
+                _this._unsupportedJsdocTypeAfterParameterNameExcerpt = new DocExcerpt_1.DocExcerpt({
+                    configuration: _this.configuration,
+                    excerptKind: "ErrorText" /* ErrorText */,
+                    content: parameters.unsupportedJsdocTypeAfterParameterNameExcerpt
+                });
+            }
+            if (parameters.hyphenExcerpt) {
+                _this._hyphenExcerpt = new DocExcerpt_1.DocExcerpt({
+                    configuration: _this.configuration,
+                    excerptKind: "ParamBlock_Hyphen" /* ParamBlock_Hyphen */,
+                    content: parameters.hyphenExcerpt
+                });
+            }
             if (parameters.spacingAfterHyphenExcerpt) {
@@ -67,2 +97,9 @@ _this._spacingAfterHyphenExcerpt = new DocExcerpt_1.DocExcerpt({
             }
+            if (parameters.unsupportedJsdocTypeAfterHyphenExcerpt) {
+                _this._unsupportedJsdocTypeAfterHyphenExcerpt = new DocExcerpt_1.DocExcerpt({
+                    configuration: _this.configuration,
+                    excerptKind: "ErrorText" /* ErrorText */,
+                    content: parameters.unsupportedJsdocTypeAfterHyphenExcerpt
+                });
+            }
         }
@@ -95,6 +132,11 @@ return _this;
             this._spacingBeforeParameterNameExcerpt,
+            this._unsupportedJsdocTypeBeforeParameterNameExcerpt,
+            this._unsupportedJsdocOptionalNameOpenBracketExcerpt,
             this._parameterNameExcerpt,
+            this._unsupportedJsdocOptionalNameRestExcerpt,
             this._spacingAfterParameterNameExcerpt,
+            this._unsupportedJsdocTypeAfterParameterNameExcerpt,
             this._hyphenExcerpt,
             this._spacingAfterHyphenExcerpt,
+            this._unsupportedJsdocTypeAfterHyphenExcerpt,
             this.content
@@ -101,0 +143,0 @@ ];

lib/parser/NodeParser.d.ts

@@ -16,2 +16,5 @@ import { ParserContext } from './ParserContext';
     private _addBlockToDocComment;
+    private _tryParseJSDocTypeOrValueRest;
+    private _tryParseUnsupportedJSDocType;
+    private _tryParseJSDocOptionalNameRest;
     private _parseParamBlock;
@@ -18,0 +21,0 @@ private _pushNode;

lib/parser/TSDocMessageId.d.ts

@@ -98,2 +98,10 @@ /**
     /**
+     * The `@param` block should not include a JSDoc-style `{type}`.
+     */
+    ParamTagWithInvalidType = "tsdoc-param-tag-with-invalid-type",
+    /**
+     * The `@param` block should not include a JSDoc-style optional name; it must not be enclosed in `[ ]` brackets.
+     */
+    ParamTagWithInvalidOptionalName = "tsdoc-param-tag-with-invalid-optional-name",
+    /**
      * The `@param` block should be followed by a parameter name.
@@ -100,0 +108,0 @@ */

package.json

 {
   "name": "@microsoft/tsdoc",
-  "version": "0.12.16",
+  "version": "0.12.17",
   "description": "A parser for the TypeScript doc comment syntax",
@@ -5,0 +5,0 @@ "keywords": [

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

767241

increased by1.94%

Lines of code

13246

increased by1.32%

No dependency changes