@firebase/api-documenter 0.1.2-canary.233e117f0

package/dist/markdown/CustomMarkdownEmitter.js

@@ -0,0 +1,161 @@
+"use strict";
+/**
+ * @license
+ * Copyright 2020 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CustomMarkdownEmitter = void 0;
+const tslib_1 = require("tslib");
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+const colors_1 = tslib_1.__importDefault(require("colors"));
+const MarkdownEmitter_1 = require("./MarkdownEmitter");
+class CustomMarkdownEmitter extends MarkdownEmitter_1.MarkdownEmitter {
+    constructor(apiModel) {
+        super();
+        this._apiModel = apiModel;
+    }
+    emit(stringBuilder, docNode, options) {
+        return super.emit(stringBuilder, docNode, options);
+    }
+    /** @override */
+    writeNode(docNode, context, docNodeSiblings) {
+        const writer = context.writer;
+        switch (docNode.kind) {
+            case "Heading" /* Heading */: {
+                const docHeading = docNode;
+                writer.ensureSkippedLine();
+                let prefix;
+                switch (docHeading.level) {
+                    case 1:
+                        prefix = '##';
+                        break;
+                    case 2:
+                        prefix = '###';
+                        break;
+                    case 3:
+                        prefix = '###';
+                        break;
+                    default:
+                        prefix = '####';
+                }
+                writer.writeLine(prefix + ' ' + this.getEscapedText(docHeading.title));
+                writer.writeLine();
+                break;
+            }
+            case "NoteBox" /* NoteBox */: {
+                const docNoteBox = docNode;
+                writer.ensureNewLine();
+                writer.increaseIndent('> ');
+                this.writeNode(docNoteBox.content, context, false);
+                writer.ensureNewLine();
+                writer.decreaseIndent();
+                writer.writeLine();
+                break;
+            }
+            case "Table" /* Table */: {
+                const docTable = docNode;
+                // GitHub's markdown renderer chokes on tables that don't have a blank line above them,
+                // whereas VS Code's renderer is totally fine with it.
+                writer.ensureSkippedLine();
+                context.insideTable = true;
+                // Markdown table rows can have inconsistent cell counts.  Size the table based on the longest row.
+                let columnCount = 0;
+                if (docTable.header) {
+                    columnCount = docTable.header.cells.length;
+                }
+                for (const row of docTable.rows) {
+                    if (row.cells.length > columnCount) {
+                        columnCount = row.cells.length;
+                    }
+                }
+                // write the table header (which is required by Markdown)
+                writer.write('| ');
+                for (let i = 0; i < columnCount; ++i) {
+                    writer.write(' ');
+                    if (docTable.header) {
+                        const cell = docTable.header.cells[i];
+                        if (cell) {
+                            this.writeNode(cell.content, context, false);
+                        }
+                    }
+                    writer.write(' |');
+                }
+                writer.writeLine();
+                // write the divider
+                writer.write('| ');
+                for (let i = 0; i < columnCount; ++i) {
+                    writer.write(' --- |');
+                }
+                writer.writeLine();
+                for (const row of docTable.rows) {
+                    writer.write('| ');
+                    for (const cell of row.cells) {
+                        writer.write(' ');
+                        this.writeNode(cell.content, context, false);
+                        writer.write(' |');
+                    }
+                    writer.writeLine();
+                }
+                writer.writeLine();
+                context.insideTable = false;
+                break;
+            }
+            case "EmphasisSpan" /* EmphasisSpan */: {
+                const docEmphasisSpan = docNode;
+                const oldBold = context.boldRequested;
+                const oldItalic = context.italicRequested;
+                context.boldRequested = docEmphasisSpan.bold;
+                context.italicRequested = docEmphasisSpan.italic;
+                this.writeNodes(docEmphasisSpan.nodes, context);
+                context.boldRequested = oldBold;
+                context.italicRequested = oldItalic;
+                break;
+            }
+            default:
+                super.writeNode(docNode, context, false);
+        }
+    }
+    /** @override */
+    writeLinkTagWithCodeDestination(docLinkTag, context) {
+        const options = context.options;
+        const result = this._apiModel.resolveDeclarationReference(docLinkTag.codeDestination, options.contextApiItem);
+        if (result.resolvedApiItem) {
+            const filename = options.onGetFilenameForApiItem(result.resolvedApiItem);
+            if (filename) {
+                let linkText = docLinkTag.linkText || '';
+                if (linkText.length === 0) {
+                    // Generate a name such as Namespace1.Namespace2.MyClass.myMethod()
+                    linkText = result.resolvedApiItem.getScopedNameWithinPackage();
+                }
+                if (linkText.length > 0) {
+                    const encodedLinkText = this.getEscapedText(linkText.replace(/\s+/g, ' '));
+                    context.writer.write('[');
+                    context.writer.write(encodedLinkText);
+                    context.writer.write(`](${filename})`);
+                }
+                else {
+                    console.log(colors_1.default.yellow('WARNING: Unable to determine link text'));
+                }
+            }
+        }
+        else if (result.errorMessage) {
+            console.log(colors_1.default.yellow(`WARNING: Unable to resolve reference "${docLinkTag.codeDestination.emitAsTsdoc()}": ` +
+                result.errorMessage));
+        }
+    }
+}
+exports.CustomMarkdownEmitter = CustomMarkdownEmitter;
+//# sourceMappingURL=CustomMarkdownEmitter.js.map

package/dist/markdown/CustomMarkdownEmitter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CustomMarkdownEmitter.js","sourceRoot":"","sources":["../../src/markdown/CustomMarkdownEmitter.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;GAeG;;;;AAEH,4FAA4F;AAC5F,2DAA2D;AAE3D,4DAA4B;AAe5B,uDAI2B;AAS3B,MAAa,qBAAsB,SAAQ,iCAAe;IAGxD,YAAmB,QAAkB;QACnC,KAAK,EAAE,CAAC;QAER,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;IAC5B,CAAC;IAEM,IAAI,CACT,aAA4B,EAC5B,OAAgB,EAChB,OAAsC;QAEtC,OAAO,KAAK,CAAC,IAAI,CAAC,aAAa,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;IACrD,CAAC;IAED,gBAAgB;IACN,SAAS,CACjB,OAAgB,EAChB,OAAgC,EAChC,eAAwB;QAExB,MAAM,MAAM,GAAmB,OAAO,CAAC,MAAM,CAAC;QAE9C,QAAQ,OAAO,CAAC,IAAI,EAAE;YACpB,4BAA8B,CAAC,CAAC;gBAC9B,MAAM,UAAU,GAAe,OAAqB,CAAC;gBACrD,MAAM,CAAC,iBAAiB,EAAE,CAAC;gBAE3B,IAAI,MAAc,CAAC;gBACnB,QAAQ,UAAU,CAAC,KAAK,EAAE;oBACxB,KAAK,CAAC;wBACJ,MAAM,GAAG,IAAI,CAAC;wBACd,MAAM;oBACR,KAAK,CAAC;wBACJ,MAAM,GAAG,KAAK,CAAC;wBACf,MAAM;oBACR,KAAK,CAAC;wBACJ,MAAM,GAAG,KAAK,CAAC;wBACf,MAAM;oBACR;wBACE,MAAM,GAAG,MAAM,CAAC;iBACnB;gBAED,MAAM,CAAC,SAAS,CAAC,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC;gBACvE,MAAM,CAAC,SAAS,EAAE,CAAC;gBACnB,MAAM;aACP;YACD,4BAA8B,CAAC,CAAC;gBAC9B,MAAM,UAAU,GAAe,OAAqB,CAAC;gBACrD,MAAM,CAAC,aAAa,EAAE,CAAC;gBAEvB,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;gBAE5B,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,OAAO,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;gBACnD,MAAM,CAAC,aAAa,EAAE,CAAC;gBAEvB,MAAM,CAAC,cAAc,EAAE,CAAC;gBAExB,MAAM,CAAC,SAAS,EAAE,CAAC;gBACnB,MAAM;aACP;YACD,wBAA4B,CAAC,CAAC;gBAC5B,MAAM,QAAQ,GAAa,OAAmB,CAAC;gBAC/C,uFAAuF;gBACvF,sDAAsD;gBACtD,MAAM,CAAC,iBAAiB,EAAE,CAAC;gBAE3B,OAAO,CAAC,WAAW,GAAG,IAAI,CAAC;gBAE3B,mGAAmG;gBACnG,IAAI,WAAW,GAAW,CAAC,CAAC;gBAC5B,IAAI,QAAQ,CAAC,MAAM,EAAE;oBACnB,WAAW,GAAG,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC;iBAC5C;gBACD,KAAK,MAAM,GAAG,IAAI,QAAQ,CAAC,IAAI,EAAE;oBAC/B,IAAI,GAAG,CAAC,KAAK,CAAC,MAAM,GAAG,WAAW,EAAE;wBAClC,WAAW,GAAG,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC;qBAChC;iBACF;gBAED,yDAAyD;gBACzD,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;gBACnB,KAAK,IAAI,CAAC,GAAW,CAAC,EAAE,CAAC,GAAG,WAAW,EAAE,EAAE,CAAC,EAAE;oBAC5C,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;oBAClB,IAAI,QAAQ,CAAC,MAAM,EAAE;wBACnB,MAAM,IAAI,GAA6B,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;wBAChE,IAAI,IAAI,EAAE;4BACR,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;yBAC9C;qBACF;oBACD,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;iBACpB;gBACD,MAAM,CAAC,SAAS,EAAE,CAAC;gBAEnB,oBAAoB;gBACpB,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;gBACnB,KAAK,IAAI,CAAC,GAAW,CAAC,EAAE,CAAC,GAAG,WAAW,EAAE,EAAE,CAAC,EAAE;oBAC5C,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;iBACxB;gBACD,MAAM,CAAC,SAAS,EAAE,CAAC;gBAEnB,KAAK,MAAM,GAAG,IAAI,QAAQ,CAAC,IAAI,EAAE;oBAC/B,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;oBACnB,KAAK,MAAM,IAAI,IAAI,GAAG,CAAC,KAAK,EAAE;wBAC5B,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;wBAClB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;wBAC7C,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;qBACpB;oBACD,MAAM,CAAC,SAAS,EAAE,CAAC;iBACpB;gBACD,MAAM,CAAC,SAAS,EAAE,CAAC;gBAEnB,OAAO,CAAC,WAAW,GAAG,KAAK,CAAC;gBAE5B,MAAM;aACP;YACD,sCAAmC,CAAC,CAAC;gBACnC,MAAM,eAAe,GAAoB,OAA0B,CAAC;gBACpE,MAAM,OAAO,GAAY,OAAO,CAAC,aAAa,CAAC;gBAC/C,MAAM,SAAS,GAAY,OAAO,CAAC,eAAe,CAAC;gBACnD,OAAO,CAAC,aAAa,GAAG,eAAe,CAAC,IAAI,CAAC;gBAC7C,OAAO,CAAC,eAAe,GAAG,eAAe,CAAC,MAAM,CAAC;gBACjD,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;gBAChD,OAAO,CAAC,aAAa,GAAG,OAAO,CAAC;gBAChC,OAAO,CAAC,eAAe,GAAG,SAAS,CAAC;gBACpC,MAAM;aACP;YACD;gBACE,KAAK,CAAC,SAAS,CAAC,OAAO,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;SAC5C;IACH,CAAC;IAED,gBAAgB;IACN,+BAA+B,CACvC,UAAsB,EACtB,OAA+D;QAE/D,MAAM,OAAO,GAAkC,OAAO,CAAC,OAAO,CAAC;QAE/D,MAAM,MAAM,GAAuC,IAAI,CAAC,SAAS,CAAC,2BAA2B,CAC3F,UAAU,CAAC,eAAgB,EAC3B,OAAO,CAAC,cAAc,CACvB,CAAC;QAEF,IAAI,MAAM,CAAC,eAAe,EAAE;YAC1B,MAAM,QAAQ,GAAuB,OAAO,CAAC,uBAAuB,CAClE,MAAM,CAAC,eAAe,CACvB,CAAC;YAEF,IAAI,QAAQ,EAAE;gBACZ,IAAI,QAAQ,GAAW,UAAU,CAAC,QAAQ,IAAI,EAAE,CAAC;gBACjD,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE;oBACzB,mEAAmE;oBACnE,QAAQ,GAAG,MAAM,CAAC,eAAe,CAAC,0BAA0B,EAAE,CAAC;iBAChE;gBACD,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE;oBACvB,MAAM,eAAe,GAAW,IAAI,CAAC,cAAc,CACjD,QAAQ,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAC9B,CAAC;oBAEF,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;oBAC1B,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;oBACtC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,QAAS,GAAG,CAAC,CAAC;iBACzC;qBAAM;oBACL,OAAO,CAAC,GAAG,CAAC,gBAAM,CAAC,MAAM,CAAC,wCAAwC,CAAC,CAAC,CAAC;iBACtE;aACF;SACF;aAAM,IAAI,MAAM,CAAC,YAAY,EAAE;YAC9B,OAAO,CAAC,GAAG,CACT,gBAAM,CAAC,MAAM,CACX,yCAAyC,UAAU,CAAC,eAAgB,CAAC,WAAW,EAAE,KAAK;gBACrF,MAAM,CAAC,YAAY,CACtB,CACF,CAAC;SACH;IACH,CAAC;CACF;AAlLD,sDAkLC"}

package/dist/markdown/MarkdownEmitter.d.ts

@@ -0,0 +1,48 @@
+/**
+ * @license
+ * Copyright 2020 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { DocNode, StringBuilder, DocLinkTag } from '@microsoft/tsdoc';
+import { IndentedWriter } from '../utils/IndentedWriter';
+export interface IMarkdownEmitterOptions {
+}
+export interface IMarkdownEmitterContext<TOptions = IMarkdownEmitterOptions> {
+    writer: IndentedWriter;
+    insideTable: boolean;
+    boldRequested: boolean;
+    italicRequested: boolean;
+    writingBold: boolean;
+    writingItalic: boolean;
+    options: TOptions;
+}
+/**
+ * Renders MarkupElement content in the Markdown file format.
+ * For more info:  https://en.wikipedia.org/wiki/Markdown
+ */
+export declare class MarkdownEmitter {
+    emit(stringBuilder: StringBuilder, docNode: DocNode, options: IMarkdownEmitterOptions): string;
+    protected getEscapedText(text: string): string;
+    protected getTableEscapedText(text: string): string;
+    /**
+     * @virtual
+     */
+    protected writeNode(docNode: DocNode, context: IMarkdownEmitterContext, docNodeSiblings: boolean): void;
+    /** @virtual */
+    protected writeLinkTagWithCodeDestination(docLinkTag: DocLinkTag, context: IMarkdownEmitterContext): void;
+    /** @virtual */
+    protected writeLinkTagWithUrlDestination(docLinkTag: DocLinkTag, context: IMarkdownEmitterContext): void;
+    protected writePlainText(text: string, context: IMarkdownEmitterContext): void;
+    protected writeNodes(docNodes: ReadonlyArray<DocNode>, context: IMarkdownEmitterContext): void;
+}

package/dist/markdown/MarkdownEmitter.js

@@ -0,0 +1,243 @@
+"use strict";
+/**
+ * @license
+ * Copyright 2020 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MarkdownEmitter = void 0;
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+const tsdoc_1 = require("@microsoft/tsdoc");
+const node_core_library_1 = require("@rushstack/node-core-library");
+const IndentedWriter_1 = require("../utils/IndentedWriter");
+/**
+ * Renders MarkupElement content in the Markdown file format.
+ * For more info:  https://en.wikipedia.org/wiki/Markdown
+ */
+class MarkdownEmitter {
+    emit(stringBuilder, docNode, options) {
+        const writer = new IndentedWriter_1.IndentedWriter(stringBuilder);
+        const context = {
+            writer,
+            insideTable: false,
+            boldRequested: false,
+            italicRequested: false,
+            writingBold: false,
+            writingItalic: false,
+            options
+        };
+        this.writeNode(docNode, context, false);
+        writer.ensureNewLine(); // finish the last line
+        return writer.toString();
+    }
+    getEscapedText(text) {
+        const textWithBackslashes = text
+            .replace(/\\/g, '\\\\') // first replace the escape character
+            .replace(/[*#[\]_|`~]/g, x => '\\' + x) // then escape any special characters
+            .replace(/---/g, '\\-\\-\\-') // hyphens only if it's 3 or more
+            .replace(/&/g, '&')
+            .replace(/</g, '&lt;')
+            .replace(/>/g, '&gt;');
+        return textWithBackslashes;
+    }
+    getTableEscapedText(text) {
+        return text
+            .replace(/&/g, '&amp;')
+            .replace(/"/g, '&quot;')
+            .replace(/</g, '&lt;')
+            .replace(/>/g, '&gt;')
+            .replace(/\|/g, '&#124;');
+    }
+    /**
+     * @virtual
+     */
+    writeNode(docNode, context, docNodeSiblings) {
+        const writer = context.writer;
+        switch (docNode.kind) {
+            case "PlainText" /* PlainText */: {
+                const docPlainText = docNode;
+                this.writePlainText(docPlainText.text, context);
+                break;
+            }
+            case "HtmlStartTag" /* HtmlStartTag */:
+            case "HtmlEndTag" /* HtmlEndTag */: {
+                const docHtmlTag = docNode;
+                // write the HTML element verbatim into the output
+                writer.write(docHtmlTag.emitAsHtml());
+                break;
+            }
+            case "CodeSpan" /* CodeSpan */: {
+                const docCodeSpan = docNode;
+                if (context.insideTable) {
+                    writer.write('<code>');
+                }
+                else {
+                    writer.write('`');
+                }
+                if (context.insideTable) {
+                    const code = this.getTableEscapedText(docCodeSpan.code);
+                    const parts = code.split(/\r?\n/g);
+                    writer.write(parts.join('</code><br/><code>'));
+                }
+                else {
+                    writer.write(docCodeSpan.code);
+                }
+                if (context.insideTable) {
+                    writer.write('</code>');
+                }
+                else {
+                    writer.write('`');
+                }
+                break;
+            }
+            case "LinkTag" /* LinkTag */: {
+                const docLinkTag = docNode;
+                if (docLinkTag.codeDestination) {
+                    this.writeLinkTagWithCodeDestination(docLinkTag, context);
+                }
+                else if (docLinkTag.urlDestination) {
+                    this.writeLinkTagWithUrlDestination(docLinkTag, context);
+                }
+                else if (docLinkTag.linkText) {
+                    this.writePlainText(docLinkTag.linkText, context);
+                }
+                break;
+            }
+            case "Paragraph" /* Paragraph */: {
+                const docParagraph = docNode;
+                const trimmedParagraph = tsdoc_1.DocNodeTransforms.trimSpacesInParagraph(docParagraph);
+                if (context.insideTable) {
+                    if (docNodeSiblings) {
+                        writer.write('<p>');
+                        this.writeNodes(trimmedParagraph.nodes, context);
+                        writer.write('</p>');
+                    }
+                    else {
+                        // Special case:  If we are the only element inside this table cell, then we can omit the <p></p> container.
+                        this.writeNodes(trimmedParagraph.nodes, context);
+                    }
+                }
+                else {
+                    this.writeNodes(trimmedParagraph.nodes, context);
+                    writer.ensureNewLine();
+                    writer.writeLine();
+                }
+                break;
+            }
+            case "FencedCode" /* FencedCode */: {
+                const docFencedCode = docNode;
+                writer.ensureNewLine();
+                writer.write('```');
+                writer.write(docFencedCode.language);
+                writer.writeLine();
+                writer.write(docFencedCode.code);
+                writer.writeLine();
+                writer.writeLine('```');
+                break;
+            }
+            case "Section" /* Section */: {
+                const docSection = docNode;
+                this.writeNodes(docSection.nodes, context);
+                break;
+            }
+            case "SoftBreak" /* SoftBreak */: {
+                if (!/^\s?$/.test(writer.peekLastCharacter())) {
+                    writer.write(' ');
+                }
+                break;
+            }
+            case "EscapedText" /* EscapedText */: {
+                const docEscapedText = docNode;
+                this.writePlainText(docEscapedText.decodedText, context);
+                break;
+            }
+            case "ErrorText" /* ErrorText */: {
+                const docErrorText = docNode;
+                this.writePlainText(docErrorText.text, context);
+                break;
+            }
+            case "InlineTag" /* InlineTag */: {
+                break;
+            }
+            case "BlockTag" /* BlockTag */: {
+                const tagNode = docNode;
+                console.warn('Unsupported block tag: ' + tagNode.tagName);
+                break;
+            }
+            default:
+                throw new node_core_library_1.InternalError('Unsupported DocNodeKind kind: ' + docNode.kind);
+        }
+    }
+    /** @virtual */
+    writeLinkTagWithCodeDestination(docLinkTag, context) {
+        // The subclass needs to implement this to support code destinations
+        throw new node_core_library_1.InternalError('writeLinkTagWithCodeDestination()');
+    }
+    /** @virtual */
+    writeLinkTagWithUrlDestination(docLinkTag, context) {
+        const linkText = docLinkTag.linkText !== undefined
+            ? docLinkTag.linkText
+            : docLinkTag.urlDestination;
+        const encodedLinkText = this.getEscapedText(linkText.replace(/\s+/g, ' '));
+        context.writer.write('[');
+        context.writer.write(encodedLinkText);
+        context.writer.write(`](${docLinkTag.urlDestination})`);
+    }
+    writePlainText(text, context) {
+        const writer = context.writer;
+        // split out the [ leading whitespace, content, trailing whitespace ]
+        const parts = text.match(/^(\s*)(.*?)(\s*)$/) || [];
+        writer.write(parts[1]); // write leading whitespace
+        const middle = parts[2];
+        if (middle !== '') {
+            switch (writer.peekLastCharacter()) {
+                case '':
+                case '\n':
+                case ' ':
+                case '[':
+                case '>':
+                    // okay to put a symbol
+                    break;
+                default:
+                    // This is no problem:        "**one** *two* **three**"
+                    // But this is trouble:       "**one***two***three**"
+                    // The most general solution: "**one**<!-- -->*two*<!-- -->**three**"
+                    writer.write('<!-- -->');
+                    break;
+            }
+            if (context.boldRequested) {
+                writer.write('<b>');
+            }
+            if (context.italicRequested) {
+                writer.write('<i>');
+            }
+            writer.write(this.getEscapedText(middle));
+            if (context.italicRequested) {
+                writer.write('</i>');
+            }
+            if (context.boldRequested) {
+                writer.write('</b>');
+            }
+        }
+        writer.write(parts[3]); // write trailing whitespace
+    }
+    writeNodes(docNodes, context) {
+        for (const docNode of docNodes) {
+            this.writeNode(docNode, context, docNodes.length > 1);
+        }
+    }
+}
+exports.MarkdownEmitter = MarkdownEmitter;
+//# sourceMappingURL=MarkdownEmitter.js.map

package/dist/markdown/MarkdownEmitter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MarkdownEmitter.js","sourceRoot":"","sources":["../../src/markdown/MarkdownEmitter.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;GAeG;;;AAEH,4FAA4F;AAC5F,2DAA2D;AAE3D,4CAgB0B;AAC1B,oEAA6D;AAE7D,4DAAyD;AAiBzD;;;GAGG;AACH,MAAa,eAAe;IACnB,IAAI,CACT,aAA4B,EAC5B,OAAgB,EAChB,OAAgC;QAEhC,MAAM,MAAM,GAAmB,IAAI,+BAAc,CAAC,aAAa,CAAC,CAAC;QAEjE,MAAM,OAAO,GAA4B;YACvC,MAAM;YACN,WAAW,EAAE,KAAK;YAElB,aAAa,EAAE,KAAK;YACpB,eAAe,EAAE,KAAK;YAEtB,WAAW,EAAE,KAAK;YAClB,aAAa,EAAE,KAAK;YAEpB,OAAO;SACR,CAAC;QAEF,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;QAExC,MAAM,CAAC,aAAa,EAAE,CAAC,CAAC,uBAAuB;QAE/C,OAAO,MAAM,CAAC,QAAQ,EAAE,CAAC;IAC3B,CAAC;IAES,cAAc,CAAC,IAAY;QACnC,MAAM,mBAAmB,GAAW,IAAI;aACrC,OAAO,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,qCAAqC;aAC5D,OAAO,CAAC,cAAc,EAAE,CAAC,CAAC,EAAE,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,qCAAqC;aAC5E,OAAO,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC,iCAAiC;aAC9D,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC;aACtB,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC;aACrB,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QACzB,OAAO,mBAAmB,CAAC;IAC7B,CAAC;IAES,mBAAmB,CAAC,IAAY;QACxC,OAAO,IAAI;aACR,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC;aACtB,OAAO,CAAC,IAAI,EAAE,QAAQ,CAAC;aACvB,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC;aACrB,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC;aACrB,OAAO,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;IAC9B,CAAC;IAED;;OAEG;IACO,SAAS,CACjB,OAAgB,EAChB,OAAgC,EAChC,eAAwB;QAExB,MAAM,MAAM,GAAmB,OAAO,CAAC,MAAM,CAAC;QAE9C,QAAQ,OAAO,CAAC,IAAI,EAAE;YACpB,gCAA0B,CAAC,CAAC;gBAC1B,MAAM,YAAY,GAAiB,OAAuB,CAAC;gBAC3D,IAAI,CAAC,cAAc,CAAC,YAAY,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;gBAChD,MAAM;aACP;YACD,uCAA8B;YAC9B,kCAA2B,CAAC,CAAC;gBAC3B,MAAM,UAAU,GAAoC,OAEnC,CAAC;gBAClB,kDAAkD;gBAClD,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,UAAU,EAAE,CAAC,CAAC;gBACtC,MAAM;aACP;YACD,8BAAyB,CAAC,CAAC;gBACzB,MAAM,WAAW,GAAgB,OAAsB,CAAC;gBACxD,IAAI,OAAO,CAAC,WAAW,EAAE;oBACvB,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;iBACxB;qBAAM;oBACL,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;iBACnB;gBACD,IAAI,OAAO,CAAC,WAAW,EAAE;oBACvB,MAAM,IAAI,GAAW,IAAI,CAAC,mBAAmB,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;oBAChE,MAAM,KAAK,GAAa,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;oBAC7C,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC,CAAC;iBAChD;qBAAM;oBACL,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;iBAChC;gBACD,IAAI,OAAO,CAAC,WAAW,EAAE;oBACvB,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;iBACzB;qBAAM;oBACL,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;iBACnB;gBACD,MAAM;aACP;YACD,4BAAwB,CAAC,CAAC;gBACxB,MAAM,UAAU,GAAe,OAAqB,CAAC;gBACrD,IAAI,UAAU,CAAC,eAAe,EAAE;oBAC9B,IAAI,CAAC,+BAA+B,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;iBAC3D;qBAAM,IAAI,UAAU,CAAC,cAAc,EAAE;oBACpC,IAAI,CAAC,8BAA8B,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;iBAC1D;qBAAM,IAAI,UAAU,CAAC,QAAQ,EAAE;oBAC9B,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;iBACnD;gBACD,MAAM;aACP;YACD,gCAA0B,CAAC,CAAC;gBAC1B,MAAM,YAAY,GAAiB,OAAuB,CAAC;gBAC3D,MAAM,gBAAgB,GAAiB,yBAAiB,CAAC,qBAAqB,CAC5E,YAAY,CACb,CAAC;gBACF,IAAI,OAAO,CAAC,WAAW,EAAE;oBACvB,IAAI,eAAe,EAAE;wBACnB,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;wBACpB,IAAI,CAAC,UAAU,CAAC,gBAAgB,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;wBACjD,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;qBACtB;yBAAM;wBACL,4GAA4G;wBAC5G,IAAI,CAAC,UAAU,CAAC,gBAAgB,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;qBAClD;iBACF;qBAAM;oBACL,IAAI,CAAC,UAAU,CAAC,gBAAgB,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;oBACjD,MAAM,CAAC,aAAa,EAAE,CAAC;oBACvB,MAAM,CAAC,SAAS,EAAE,CAAC;iBACpB;gBACD,MAAM;aACP;YACD,kCAA2B,CAAC,CAAC;gBAC3B,MAAM,aAAa,GAAkB,OAAwB,CAAC;gBAC9D,MAAM,CAAC,aAAa,EAAE,CAAC;gBACvB,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;gBACpB,MAAM,CAAC,KAAK,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;gBACrC,MAAM,CAAC,SAAS,EAAE,CAAC;gBACnB,MAAM,CAAC,KAAK,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;gBACjC,MAAM,CAAC,SAAS,EAAE,CAAC;gBACnB,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;gBACxB,MAAM;aACP;YACD,4BAAwB,CAAC,CAAC;gBACxB,MAAM,UAAU,GAAe,OAAqB,CAAC;gBACrD,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;gBAC3C,MAAM;aACP;YACD,gCAA0B,CAAC,CAAC;gBAC1B,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,iBAAiB,EAAE,CAAC,EAAE;oBAC7C,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;iBACnB;gBACD,MAAM;aACP;YACD,oCAA4B,CAAC,CAAC;gBAC5B,MAAM,cAAc,GAAmB,OAAyB,CAAC;gBACjE,IAAI,CAAC,cAAc,CAAC,cAAc,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;gBACzD,MAAM;aACP;YACD,gCAA0B,CAAC,CAAC;gBAC1B,MAAM,YAAY,GAAiB,OAAuB,CAAC;gBAC3D,IAAI,CAAC,cAAc,CAAC,YAAY,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;gBAChD,MAAM;aACP;YACD,gCAA0B,CAAC,CAAC;gBAC1B,MAAM;aACP;YACD,8BAAyB,CAAC,CAAC;gBACzB,MAAM,OAAO,GAAgB,OAAsB,CAAC;gBACpD,OAAO,CAAC,IAAI,CAAC,yBAAyB,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;gBAC1D,MAAM;aACP;YACD;gBACE,MAAM,IAAI,iCAAa,CACrB,gCAAgC,GAAG,OAAO,CAAC,IAAI,CAChD,CAAC;SACL;IACH,CAAC;IAED,eAAe;IACL,+BAA+B,CACvC,UAAsB,EACtB,OAAgC;QAEhC,oEAAoE;QACpE,MAAM,IAAI,iCAAa,CAAC,mCAAmC,CAAC,CAAC;IAC/D,CAAC;IAED,eAAe;IACL,8BAA8B,CACtC,UAAsB,EACtB,OAAgC;QAEhC,MAAM,QAAQ,GACZ,UAAU,CAAC,QAAQ,KAAK,SAAS;YAC/B,CAAC,CAAC,UAAU,CAAC,QAAQ;YACrB,CAAC,CAAC,UAAU,CAAC,cAAe,CAAC;QAEjC,MAAM,eAAe,GAAW,IAAI,CAAC,cAAc,CACjD,QAAQ,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAC9B,CAAC;QAEF,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC1B,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;QACtC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,UAAU,CAAC,cAAe,GAAG,CAAC,CAAC;IAC3D,CAAC;IAES,cAAc,CACtB,IAAY,EACZ,OAAgC;QAEhC,MAAM,MAAM,GAAmB,OAAO,CAAC,MAAM,CAAC;QAE9C,qEAAqE;QACrE,MAAM,KAAK,GAAa,IAAI,CAAC,KAAK,CAAC,mBAAmB,CAAC,IAAI,EAAE,CAAC;QAE9D,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,2BAA2B;QAEnD,MAAM,MAAM,GAAW,KAAK,CAAC,CAAC,CAAC,CAAC;QAEhC,IAAI,MAAM,KAAK,EAAE,EAAE;YACjB,QAAQ,MAAM,CAAC,iBAAiB,EAAE,EAAE;gBAClC,KAAK,EAAE,CAAC;gBACR,KAAK,IAAI,CAAC;gBACV,KAAK,GAAG,CAAC;gBACT,KAAK,GAAG,CAAC;gBACT,KAAK,GAAG;oBACN,uBAAuB;oBACvB,MAAM;gBACR;oBACE,uDAAuD;oBACvD,qDAAqD;oBACrD,qEAAqE;oBACrE,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;oBACzB,MAAM;aACT;YAED,IAAI,OAAO,CAAC,aAAa,EAAE;gBACzB,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;aACrB;YACD,IAAI,OAAO,CAAC,eAAe,EAAE;gBAC3B,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;aACrB;YAED,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC;YAE1C,IAAI,OAAO,CAAC,eAAe,EAAE;gBAC3B,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;aACtB;YACD,IAAI,OAAO,CAAC,aAAa,EAAE;gBACzB,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;aACtB;SACF;QAED,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,4BAA4B;IACtD,CAAC;IAES,UAAU,CAClB,QAAgC,EAChC,OAAgC;QAEhC,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE;YAC9B,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;SACvD;IACH,CAAC;CACF;AAnQD,0CAmQC"}

package/dist/markdown/test/CustomMarkdownEmitter.test.d.ts

@@ -0,0 +1,17 @@
+/**
+ * @license
+ * Copyright 2020 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export {};