@microsoft/tsdoc - npm Package Compare versions

Comparing version 0.12.1 to 0.12.2

CHANGELOG.json

@@ -5,2 +5,14 @@ {
     {
+      "version": "0.12.2",
+      "tag": "@microsoft/tsdoc_v0.12.2",
+      "date": "Fri, 09 Nov 2018 15:13:13 GMT",
+      "comments": {
+        "patch": [
+          {
+            "comment": "Improve trimming of spacing for link text in `{@link}` tags"
+          }
+        ]
+      }
+    },
+    {
       "version": "0.12.1",
@@ -15,2 +27,5 @@ "tag": "@microsoft/tsdoc_v0.12.1",
           {
+            "comment": "Fix a bug where `TSDocEmitter.renderHtmlTag()` and `TSDocEmitter.renderDeclarationReference()` were including comment framing"
+          },
+          {
             "comment": "Add `DocSection.appendNodesInParagraph()` API"
@@ -17,0 +32,0 @@ }

CHANGELOG.md

 # Change Log - @microsoft/tsdoc
 
-This log was last generated on Tue, 06 Nov 2018 01:37:22 GMT and should not be manually modified.
+This log was last generated on Fri, 09 Nov 2018 15:13:13 GMT and should not be manually modified.
 
+## 0.12.2
+Fri, 09 Nov 2018 15:13:13 GMT
+
+### Patches
+
+- Improve trimming of spacing for link text in `{@link}` tags
+
 ## 0.12.1
@@ -11,2 +18,3 @@ Tue, 06 Nov 2018 01:37:22 GMT
 - Allow HTML in a `DocSection` node
+- Fix a bug where `TSDocEmitter.renderHtmlTag()` and `TSDocEmitter.renderDeclarationReference()` were including comment framing
 - Add `DocSection.appendNodesInParagraph()` API
@@ -13,0 +21,0 @@

lib/emitters/TSDocEmitter.js

@@ -177,7 +177,8 @@ "use strict";
                     if (docLinkTag_1.urlDestination !== undefined || docLinkTag_1.codeDestination !== undefined) {
-                        _this._writeContent(' ');
                         if (docLinkTag_1.urlDestination !== undefined) {
+                            _this._writeContent(' ');
                             _this._writeContent(docLinkTag_1.urlDestination);
                         }
-                        else {
+                        else if (docLinkTag_1.codeDestination !== undefined) {
+                            _this._writeContent(' ');
                             _this._renderNode(docLinkTag_1.codeDestination);
@@ -187,3 +188,5 @@ }
                     if (docLinkTag_1.linkText !== undefined) {
+                        _this._writeContent(' ');
                         _this._writeContent('|');
+                        _this._writeContent(' ');
                         _this._writeContent(docLinkTag_1.linkText);
@@ -190,0 +193,0 @@ }

lib/nodes/DocLinkTag.d.ts

@@ -21,3 +21,5 @@ import { DocNodeKind, DocNode } from './DocNode';
     pipeExcerpt?: TokenSequence;
+    spacingAfterPipeExcerpt?: TokenSequence;
     linkTextExcerpt?: TokenSequence;
+    spacingAfterLinkTextExcerpt?: TokenSequence;
 }
@@ -33,3 +35,5 @@ /**
     private readonly _pipeExcerpt;
+    private readonly _spacingAfterPipeExcerpt;
     private _linkText;
+    private readonly _spacingAfterLinkTextExcerpt;
     private readonly _linkTextExcerpt;
@@ -61,2 +65,19 @@ /**
      * or the declaration identifier).
+     *
+     * @remarks
+     *
+     * In HTML, the hyperlink can include leading/trailing space characters around the link text.
+     * For example, this HTML will cause a web browser to `y` and also the space character before
+     * and after it:
+     *
+     * ```html
+     * x<a href="#Button"> y </a> z
+     * ```
+     *
+     * Unlike HTML, TSDoc trims leading/trailing spaces.  For example, this TSDoc will be
+     * displayed `xy z` and underline only the `y` character:
+     *
+     * ```
+     * x{@link Button | y } z
+     * ```
      */
@@ -63,0 +84,0 @@ readonly linkText: string | undefined;

lib/nodes/DocLinkTag.js

@@ -59,2 +59,9 @@ "use strict";
             }
+            if (parameters.spacingAfterPipeExcerpt) {
+                _this._spacingAfterPipeExcerpt = new DocExcerpt_1.DocExcerpt({
+                    configuration: _this.configuration,
+                    excerptKind: "Spacing" /* Spacing */,
+                    content: parameters.spacingAfterPipeExcerpt
+                });
+            }
             if (parameters.linkTextExcerpt) {
@@ -67,2 +74,9 @@ _this._linkTextExcerpt = new DocExcerpt_1.DocExcerpt({
             }
+            if (parameters.spacingAfterLinkTextExcerpt) {
+                _this._spacingAfterLinkTextExcerpt = new DocExcerpt_1.DocExcerpt({
+                    configuration: _this.configuration,
+                    excerptKind: "Spacing" /* Spacing */,
+                    content: parameters.spacingAfterLinkTextExcerpt
+                });
+            }
         }
@@ -122,2 +136,19 @@ else {
          * or the declaration identifier).
+         *
+         * @remarks
+         *
+         * In HTML, the hyperlink can include leading/trailing space characters around the link text.
+         * For example, this HTML will cause a web browser to `y` and also the space character before
+         * and after it:
+         *
+         * ```html
+         * x<a href="#Button"> y </a> z
+         * ```
+         *
+         * Unlike HTML, TSDoc trims leading/trailing spaces.  For example, this TSDoc will be
+         * displayed `xy z` and underline only the `y` character:
+         *
+         * ```
+         * x{@link Button | y } z
+         * ```
          */
@@ -142,3 +173,5 @@ get: function () {
             this._pipeExcerpt,
-            this._linkTextExcerpt
+            this._spacingAfterPipeExcerpt,
+            this._linkTextExcerpt,
+            this._spacingAfterLinkTextExcerpt
         ];
@@ -145,0 +178,0 @@ };

package.json

 {
   "name": "@microsoft/tsdoc",
-  "version": "0.12.1",
+  "version": "0.12.2",
   "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

618141

increased by0.95%

Lines of code

10736

increased by0.87%

No dependency changes