@microsoft/api-documenter - npm Package Compare versions

Comparing version 1.1.21 to 1.1.22

CHANGELOG.json

@@ -5,2 +5,31 @@ {
     {
+      "version": "1.1.22",
+      "tag": "@microsoft/api-documenter_v1.1.22",
+      "date": "Thu, 15 Mar 2018 20:00:50 GMT",
+      "comments": {
+        "patch": [
+          {
+            "comment": "Fix an issue where GitHub changed its markdown parser such that \"./\" is now required for relative hyperlinks"
+          },
+          {
+            "comment": "Fix a bug where MarkdownRenderer did not handle newlines properly inside table cells"
+          },
+          {
+            "comment": "Improve appearance of warning messages"
+          }
+        ],
+        "dependency": [
+          {
+            "comment": "Updating dependency \"@microsoft/api-extractor\" from `5.3.9` to `5.4.0`"
+          },
+          {
+            "comment": "Updating dependency \"@microsoft/ts-command-line\" from `3.0.7` to `3.1.0`"
+          },
+          {
+            "comment": "Updating dependency \"@microsoft/node-library-build\" from `4.3.21` to `4.3.22`"
+          }
+        ]
+      }
+    },
+    {
       "version": "1.1.21",
@@ -7,0 +36,0 @@ "tag": "@microsoft/api-documenter_v1.1.21",

CHANGELOG.md

 # Change Log - @microsoft/api-documenter
 
-This log was last generated on Thu, 15 Mar 2018 16:05:43 GMT and should not be manually modified.
+This log was last generated on Thu, 15 Mar 2018 20:00:50 GMT and should not be manually modified.
 
+## 1.1.22
+Thu, 15 Mar 2018 20:00:50 GMT
+
+### Patches
+
+- Fix an issue where GitHub changed its markdown parser such that "./" is now required for relative hyperlinks
+- Fix a bug where MarkdownRenderer did not handle newlines properly inside table cells
+- Improve appearance of warning messages
+
 ## 1.1.21
@@ -6,0 +15,0 @@ Thu, 15 Mar 2018 16:05:43 GMT

lib/markdown/MarkdownDocumenter.js

@@ -7,2 +7,3 @@ "use strict";
 const path = require("path");
+const node_core_library_1 = require("@microsoft/node-core-library");
 const api_extractor_1 = require("@microsoft/api-extractor");
@@ -427,3 +428,5 @@ const DocItemSet_1 = require("../utils/DocItemSet");
                 }
-                const docFilename = this._getFilenameForDocItem(resolveResult.docItem);
+                // NOTE: GitHub's markdown renderer does not resolve relative hyperlinks correctly
+                // unless they start with "./" or "../".
+                const docFilename = './' + this._getFilenameForDocItem(resolveResult.docItem);
                 args.prefix = '[';
@@ -433,3 +436,3 @@ args.suffix = '](' + docFilename + ')';
         });
-        fsx.writeFileSync(filename, content);
+        fsx.writeFileSync(filename, node_core_library_1.Text.convertToCrLf(content));
     }
@@ -436,0 +439,0 @@ _getFilenameForDocItem(docItem) {

lib/utils/MarkdownRenderer.js

@@ -162,3 +162,9 @@ "use strict";
                     writer.write('`');
-                    writer.write(element.text);
+                    if (context.insideTable) {
+                        const parts = element.text.split(/[\r\n]+/g);
+                        writer.write(parts.join('`<p/>`'));
+                    }
+                    else {
+                        writer.write(element.text);
+                    }
                     writer.write('`');
@@ -165,0 +171,0 @@ break;

lib/yaml/OfficeYamlDocumenter.js

@@ -5,2 +5,3 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+const colors = require("colors");
 const fsx = require("fs-extra");
@@ -24,4 +25,5 @@ const path = require("path");
         // After we generate everything, check for any unused snippets
+        console.log();
         for (const apiName of Object.keys(this._snippets)) {
-            console.error('UNUSED SNIPPET: ' + apiName);
+            console.error(colors.yellow('Warning: Unused snippet ' + apiName));
         }
@@ -28,0 +30,0 @@ }

lib/yaml/YamlDocumenter.js

@@ -7,4 +7,6 @@ "use strict";
 const path = require("path");
+const colors = require("colors");
 const yaml = require("js-yaml");
 const node_core_library_1 = require("@microsoft/node-core-library");
+const api_extractor_1 = require("@microsoft/api-extractor");
 const DocItemSet_1 = require("../utils/DocItemSet");
@@ -280,3 +282,4 @@ const Utilities_1 = require("../utils/Utilities");
                     // Eventually we should introduce a warnings file
-                    console.error('==> UNRESOLVED REFERENCE: ' + JSON.stringify(args.reference));
+                    console.error(colors.yellow('Warning: Unresolved hyperlink to '
+                        + api_extractor_1.Markup.formatApiItemReference(args.reference)));
                 }
@@ -283,0 +286,0 @@ else {

package.json

 {
   "name": "@microsoft/api-documenter",
-  "version": "1.1.21",
+  "version": "1.1.22",
   "description": "Read JSON files from api-extractor, generate documentation pages",
@@ -18,5 +18,5 @@ "repository": {
   "dependencies": {
-    "@microsoft/api-extractor": "5.3.9",
+    "@microsoft/api-extractor": "5.4.0",
     "@microsoft/node-core-library": "0.8.0",
-    "@microsoft/ts-command-line": "3.0.7",
+    "@microsoft/ts-command-line": "3.1.0",
     "colors": "~1.1.2",
@@ -27,3 +27,3 @@ "fs-extra": "~0.26.7",
   "devDependencies": {
-    "@microsoft/node-library-build": "4.3.21",
+    "@microsoft/node-library-build": "4.3.22",
     "@types/colors": "1.1.3",
@@ -30,0 +30,0 @@ "@types/fs-extra": "0.0.37",

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

255923

increased by1.25%

Lines of code

3141

increased by1.39%

Dependency changes

• + Added@microsoft/api-extractor@5.4.0(transitive)

• + Added@microsoft/ts-command-line@3.1.0(transitive)

• - Removed@microsoft/api-extractor@5.3.9(transitive)

• - Removed@microsoft/ts-command-line@3.0.7(transitive)

• Updated@microsoft/api-extractor@5.4.0

• Updated@microsoft/ts-command-line@3.1.0