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

Comparing version 0.3.1 to 0.3.2

CHANGELOG.md

 # Change Log - @mattetti/custom-api-documenter
 
+## 0.3.2 Fix a bug where frontmatters weren't cleared in between pages
+
 ## 0.3.1 Fix the summary frontmatter information (package & interface level information was wrong)
@@ -4,0 +6,0 @@

lib/documenters/MarkdownDocumenter.d.ts

@@ -23,3 +23,2 @@ import { ApiModel } from '@microsoft/api-extractor-model';
     private _writeThrowsSection;
-    private _writeIndex;
     /**
@@ -26,0 +25,0 @@ * GENERATE PAGE: MODEL

lib/documenters/MarkdownDocumenter.js

@@ -61,3 +61,2 @@ "use strict";
         }
-        this._writeIndex(this._apiModel);
     }
@@ -73,2 +72,3 @@ _writeApiItemPage(apiItem, output) {
         if (this._shouldHaveStandalonePage(apiItem)) {
+            this._frontMatter = new FrontMatter_1.FrontMatter();
             this._currentApiItemPage = apiItem;
@@ -333,9 +333,2 @@ }
     }
-    _writeIndex(apiItem) {
-        // const indexPath: string = path.join(this._outputFolder, '_index.md');
-        // const output: StringBuilder = new StringBuilder();
-        // output.append(`---\nTitle: API Reference\n---\n\n`);
-        // // TODO:
-        // FileSystem.writeFile(indexPath, output.toString());
-    }
     /**
@@ -342,0 +335,0 @@ * GENERATE PAGE: MODEL

package.json

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

src/documenters/MarkdownDocumenter.ts

@@ -120,3 +120,2 @@ // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
         }
-        this._writeIndex(this._apiModel);
     }
@@ -134,2 +133,3 @@
         if (this._shouldHaveStandalonePage(apiItem)) {
+            this._frontMatter = new FrontMatter();
             this._currentApiItemPage = apiItem;
@@ -438,10 +438,2 @@ }
 
-    private _writeIndex(apiItem: ApiItem): void {
-        // const indexPath: string = path.join(this._outputFolder, '_index.md');
-        // const output: StringBuilder = new StringBuilder();
-        // output.append(`---\nTitle: API Reference\n---\n\n`);
-        // // TODO:
-        // FileSystem.writeFile(indexPath, output.toString());
-    }
-
     /**
@@ -1201,3 +1193,2 @@ * GENERATE PAGE: MODEL
         this._frontMatter.members = new Map<string, Map<string, string>>();
-
         apiMembers.forEach(element => {
@@ -1204,0 +1195,0 @@ if (element.displayName === "") { return }

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

Worsened metrics

Total package byte prevSize

780148

decreased by-0.14%

Lines of code

6999

decreased by-0.21%

No dependency changes