@mattetti/custom-api-documenter - npm Package Compare versions

Comparing version 0.2.2 to 0.3.0

CHANGELOG.md

 # Change Log - @mattetti/custom-api-documenter
 
+## 0.3.0 Provide uris for members in the frontmatter
+
 ## 0.2.0 Supports passing the path to a config file using --config + turning off YAML generation
@@ -4,0 +6,0 @@

lib/documenters/FrontMatter.d.ts

@@ -7,5 +7,5 @@ import { ApiItemKind } from "@microsoft/api-extractor-model";
     summary?: string;
-    members: Map<string, string[]>;
+    members: Map<string, Map<string, string>>;
     toString(): string;
 }
 //# sourceMappingURL=FrontMatter.d.ts.map

lib/documenters/MarkdownDocumenter.js

@@ -941,5 +941,5 @@ "use strict";
             if (!this._frontMatter.members[element.kind]) {
-                this._frontMatter.members[element.kind] = [];
+                this._frontMatter.members[element.kind] = {};
             }
-            this._frontMatter.members[element.kind].push(element.displayName);
+            this._frontMatter.members[element.kind][element.displayName] = this._getLinkFilenameForApiItem(element);
         });
@@ -1019,3 +1019,3 @@ const pkg = item.getAssociatedPackage();
     }
-    _getFilenameForApiItem(apiItem) {
+    _getFilenameForApiItem(apiItem, linkToMD) {
         if (apiItem.kind === "Model" /* Model */) {
@@ -1022,0 +1022,0 @@ return '/';

package.json

 {
   "name": "@mattetti/custom-api-documenter",
-  "version": "0.2.2",
+  "version": "0.3.0",
   "description": "Read JSON files from api-extractor, generate documentation pages",
@@ -5,0 +5,0 @@ "repository": {

src/documenters/FrontMatter.ts

@@ -9,3 +9,3 @@ import { ApiItemKind } from "@microsoft/api-extractor-model";
     public summary?: string;
-    public members: Map<string, string[]>
+    public members: Map<string, Map<string, string>>
 
@@ -12,0 +12,0 @@ public toString(): string {

src/documenters/MarkdownDocumenter.ts

@@ -1184,8 +1184,8 @@ // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
 
-        this._frontMatter.members = new Map<string, string[]>();
+        this._frontMatter.members = new Map<string, Map<string, string>>();
 
         apiMembers.forEach(element => {
             if (element.displayName === "") { return }
-            if (!this._frontMatter.members[element.kind]) { this._frontMatter.members[element.kind] = [] }
-            this._frontMatter.members[element.kind].push(element.displayName);
+            if (!this._frontMatter.members[element.kind]) { this._frontMatter.members[element.kind] = {} }
+            this._frontMatter.members[element.kind][element.displayName] = this._getLinkFilenameForApiItem(element);
         });
@@ -1283,3 +1283,3 @@
 
-    private _getFilenameForApiItem(apiItem: ApiItem): string {
+    private _getFilenameForApiItem(apiItem: ApiItem, linkToMD?: boolean): string {
         if (apiItem.kind === ApiItemKind.Model) {
@@ -1286,0 +1286,0 @@ return '/';

No alert changes

Improved metrics

Total package byte prevSize

1085139

increased by0.03%

No dependency changes