@firebase/api-documenter 0.5.0-ssl-check.4f23f3343 → 0.6.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cli/ApiDocumenterCommandLine.d.ts +0 -2
- package/dist/cli/ApiDocumenterCommandLine.js +0 -7
- package/dist/cli/ApiDocumenterCommandLine.js.map +1 -1
- package/dist/cli/BaseAction.d.ts +6 -3
- package/dist/cli/BaseAction.js +19 -11
- package/dist/cli/BaseAction.js.map +1 -1
- package/dist/cli/MarkdownAction.d.ts +1 -2
- package/dist/cli/MarkdownAction.js +4 -6
- package/dist/cli/MarkdownAction.js.map +1 -1
- package/dist/cli/TocAction.d.ts +1 -2
- package/dist/cli/TocAction.js +4 -6
- package/dist/cli/TocAction.js.map +1 -1
- package/dist/documenters/MarkdownDocumenter.d.ts +7 -2
- package/dist/documenters/MarkdownDocumenter.js +89 -77
- package/dist/documenters/MarkdownDocumenter.js.map +1 -1
- package/dist/documenters/MarkdownDocumenterHelpers.d.ts +38 -6
- package/dist/documenters/MarkdownDocumenterHelpers.js +168 -45
- package/dist/documenters/MarkdownDocumenterHelpers.js.map +1 -1
- package/dist/markdown/CustomMarkdownEmitter.d.ts +1 -1
- package/dist/markdown/CustomMarkdownEmitter.js +23 -5
- package/dist/markdown/CustomMarkdownEmitter.js.map +1 -1
- package/dist/markdown/MarkdownEmitter.js +13 -13
- package/dist/markdown/MarkdownEmitter.js.map +1 -1
- package/dist/markdown/test/CustomMarkdownEmitter.test.js +2 -2
- package/dist/markdown/test/CustomMarkdownEmitter.test.js.map +1 -1
- package/dist/nodes/CustomDocNodeKind.js +3 -3
- package/dist/nodes/CustomDocNodeKind.js.map +1 -1
- package/dist/nodes/DocEmphasisSpan.js.map +1 -1
- package/dist/plugin/MarkdownDocumenterAccessor.d.ts +1 -1
- package/dist/plugin/MarkdownDocumenterFeature.d.ts +1 -1
- package/dist/plugin/PluginLoader.js +2 -3
- package/dist/plugin/PluginLoader.js.map +1 -1
- package/dist/start.js +3 -3
- package/dist/start.js.map +1 -1
- package/dist/toc.d.ts +4 -2
- package/dist/toc.js +22 -13
- package/dist/toc.js.map +1 -1
- package/dist/utils/Utilities.d.ts +1 -1
- package/dist/utils/Utilities.js +2 -2
- package/dist/utils/Utilities.js.map +1 -1
- package/dist/utils/style.d.ts +18 -0
- package/dist/utils/style.js +31 -0
- package/dist/utils/style.js.map +1 -0
- package/package.json +12 -13
|
@@ -66,19 +66,19 @@ class MarkdownEmitter {
|
|
|
66
66
|
writeNode(docNode, context, docNodeSiblings) {
|
|
67
67
|
const writer = context.writer;
|
|
68
68
|
switch (docNode.kind) {
|
|
69
|
-
case
|
|
69
|
+
case tsdoc_1.DocNodeKind.PlainText: {
|
|
70
70
|
const docPlainText = docNode;
|
|
71
71
|
this.writePlainText(docPlainText.text, context);
|
|
72
72
|
break;
|
|
73
73
|
}
|
|
74
|
-
case
|
|
75
|
-
case
|
|
74
|
+
case tsdoc_1.DocNodeKind.HtmlStartTag:
|
|
75
|
+
case tsdoc_1.DocNodeKind.HtmlEndTag: {
|
|
76
76
|
const docHtmlTag = docNode;
|
|
77
77
|
// write the HTML element verbatim into the output
|
|
78
78
|
writer.write(docHtmlTag.emitAsHtml());
|
|
79
79
|
break;
|
|
80
80
|
}
|
|
81
|
-
case
|
|
81
|
+
case tsdoc_1.DocNodeKind.CodeSpan: {
|
|
82
82
|
const docCodeSpan = docNode;
|
|
83
83
|
if (context.insideTable) {
|
|
84
84
|
writer.write('<code>');
|
|
@@ -102,7 +102,7 @@ class MarkdownEmitter {
|
|
|
102
102
|
}
|
|
103
103
|
break;
|
|
104
104
|
}
|
|
105
|
-
case
|
|
105
|
+
case tsdoc_1.DocNodeKind.LinkTag: {
|
|
106
106
|
const docLinkTag = docNode;
|
|
107
107
|
if (docLinkTag.codeDestination) {
|
|
108
108
|
this.writeLinkTagWithCodeDestination(docLinkTag, context);
|
|
@@ -115,7 +115,7 @@ class MarkdownEmitter {
|
|
|
115
115
|
}
|
|
116
116
|
break;
|
|
117
117
|
}
|
|
118
|
-
case
|
|
118
|
+
case tsdoc_1.DocNodeKind.Paragraph: {
|
|
119
119
|
const docParagraph = docNode;
|
|
120
120
|
const trimmedParagraph = tsdoc_1.DocNodeTransforms.trimSpacesInParagraph(docParagraph);
|
|
121
121
|
if (context.insideTable) {
|
|
@@ -136,7 +136,7 @@ class MarkdownEmitter {
|
|
|
136
136
|
}
|
|
137
137
|
break;
|
|
138
138
|
}
|
|
139
|
-
case
|
|
139
|
+
case tsdoc_1.DocNodeKind.FencedCode: {
|
|
140
140
|
const docFencedCode = docNode;
|
|
141
141
|
writer.ensureNewLine();
|
|
142
142
|
writer.write('```');
|
|
@@ -147,31 +147,31 @@ class MarkdownEmitter {
|
|
|
147
147
|
writer.writeLine('```');
|
|
148
148
|
break;
|
|
149
149
|
}
|
|
150
|
-
case
|
|
150
|
+
case tsdoc_1.DocNodeKind.Section: {
|
|
151
151
|
const docSection = docNode;
|
|
152
152
|
this.writeNodes(docSection.nodes, context);
|
|
153
153
|
break;
|
|
154
154
|
}
|
|
155
|
-
case
|
|
155
|
+
case tsdoc_1.DocNodeKind.SoftBreak: {
|
|
156
156
|
if (!/^\s?$/.test(writer.peekLastCharacter())) {
|
|
157
157
|
writer.write(' ');
|
|
158
158
|
}
|
|
159
159
|
break;
|
|
160
160
|
}
|
|
161
|
-
case
|
|
161
|
+
case tsdoc_1.DocNodeKind.EscapedText: {
|
|
162
162
|
const docEscapedText = docNode;
|
|
163
163
|
this.writePlainText(docEscapedText.decodedText, context);
|
|
164
164
|
break;
|
|
165
165
|
}
|
|
166
|
-
case
|
|
166
|
+
case tsdoc_1.DocNodeKind.ErrorText: {
|
|
167
167
|
const docErrorText = docNode;
|
|
168
168
|
this.writePlainText(docErrorText.text, context);
|
|
169
169
|
break;
|
|
170
170
|
}
|
|
171
|
-
case
|
|
171
|
+
case tsdoc_1.DocNodeKind.InlineTag: {
|
|
172
172
|
break;
|
|
173
173
|
}
|
|
174
|
-
case
|
|
174
|
+
case tsdoc_1.DocNodeKind.BlockTag: {
|
|
175
175
|
const tagNode = docNode;
|
|
176
176
|
console.warn('Unsupported block tag: ' + tagNode.tagName);
|
|
177
177
|
break;
|
|
@@ -1 +1 @@
|
|
|
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,CAAC;YACrB,
|
|
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,CAAC;YACrB,KAAK,mBAAW,CAAC,SAAS,CAAC,CAAC,CAAC;gBAC3B,MAAM,YAAY,GAAiB,OAAuB,CAAC;gBAC3D,IAAI,CAAC,cAAc,CAAC,YAAY,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;gBAChD,MAAM;YACR,CAAC;YACD,KAAK,mBAAW,CAAC,YAAY,CAAC;YAC9B,KAAK,mBAAW,CAAC,UAAU,CAAC,CAAC,CAAC;gBAC5B,MAAM,UAAU,GAAoC,OACnB,CAAC;gBAClC,kDAAkD;gBAClD,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,UAAU,EAAE,CAAC,CAAC;gBACtC,MAAM;YACR,CAAC;YACD,KAAK,mBAAW,CAAC,QAAQ,CAAC,CAAC,CAAC;gBAC1B,MAAM,WAAW,GAAgB,OAAsB,CAAC;gBACxD,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC;oBACxB,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;gBACzB,CAAC;qBAAM,CAAC;oBACN,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;gBACpB,CAAC;gBACD,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC;oBACxB,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;gBACjD,CAAC;qBAAM,CAAC;oBACN,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;gBACjC,CAAC;gBACD,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC;oBACxB,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;gBAC1B,CAAC;qBAAM,CAAC;oBACN,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;gBACpB,CAAC;gBACD,MAAM;YACR,CAAC;YACD,KAAK,mBAAW,CAAC,OAAO,CAAC,CAAC,CAAC;gBACzB,MAAM,UAAU,GAAe,OAAqB,CAAC;gBACrD,IAAI,UAAU,CAAC,eAAe,EAAE,CAAC;oBAC/B,IAAI,CAAC,+BAA+B,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;gBAC5D,CAAC;qBAAM,IAAI,UAAU,CAAC,cAAc,EAAE,CAAC;oBACrC,IAAI,CAAC,8BAA8B,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;gBAC3D,CAAC;qBAAM,IAAI,UAAU,CAAC,QAAQ,EAAE,CAAC;oBAC/B,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;gBACpD,CAAC;gBACD,MAAM;YACR,CAAC;YACD,KAAK,mBAAW,CAAC,SAAS,CAAC,CAAC,CAAC;gBAC3B,MAAM,YAAY,GAAiB,OAAuB,CAAC;gBAC3D,MAAM,gBAAgB,GACpB,yBAAiB,CAAC,qBAAqB,CAAC,YAAY,CAAC,CAAC;gBACxD,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC;oBACxB,IAAI,eAAe,EAAE,CAAC;wBACpB,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;oBACvB,CAAC;yBAAM,CAAC;wBACN,4GAA4G;wBAC5G,IAAI,CAAC,UAAU,CAAC,gBAAgB,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;oBACnD,CAAC;gBACH,CAAC;qBAAM,CAAC;oBACN,IAAI,CAAC,UAAU,CAAC,gBAAgB,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;oBACjD,MAAM,CAAC,aAAa,EAAE,CAAC;oBACvB,MAAM,CAAC,SAAS,EAAE,CAAC;gBACrB,CAAC;gBACD,MAAM;YACR,CAAC;YACD,KAAK,mBAAW,CAAC,UAAU,CAAC,CAAC,CAAC;gBAC5B,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;YACR,CAAC;YACD,KAAK,mBAAW,CAAC,OAAO,CAAC,CAAC,CAAC;gBACzB,MAAM,UAAU,GAAe,OAAqB,CAAC;gBACrD,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;gBAC3C,MAAM;YACR,CAAC;YACD,KAAK,mBAAW,CAAC,SAAS,CAAC,CAAC,CAAC;gBAC3B,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,iBAAiB,EAAE,CAAC,EAAE,CAAC;oBAC9C,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;gBACpB,CAAC;gBACD,MAAM;YACR,CAAC;YACD,KAAK,mBAAW,CAAC,WAAW,CAAC,CAAC,CAAC;gBAC7B,MAAM,cAAc,GAAmB,OAAyB,CAAC;gBACjE,IAAI,CAAC,cAAc,CAAC,cAAc,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;gBACzD,MAAM;YACR,CAAC;YACD,KAAK,mBAAW,CAAC,SAAS,CAAC,CAAC,CAAC;gBAC3B,MAAM,YAAY,GAAiB,OAAuB,CAAC;gBAC3D,IAAI,CAAC,cAAc,CAAC,YAAY,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;gBAChD,MAAM;YACR,CAAC;YACD,KAAK,mBAAW,CAAC,SAAS,CAAC,CAAC,CAAC;gBAC3B,MAAM;YACR,CAAC;YACD,KAAK,mBAAW,CAAC,QAAQ,CAAC,CAAC,CAAC;gBAC1B,MAAM,OAAO,GAAgB,OAAsB,CAAC;gBACpD,OAAO,CAAC,IAAI,CAAC,yBAAyB,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;gBAC1D,MAAM;YACR,CAAC;YACD;gBACE,MAAM,IAAI,iCAAa,CACrB,gCAAgC,GAAG,OAAO,CAAC,IAAI,CAChD,CAAC;QACN,CAAC;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,CAAC;YAClB,QAAQ,MAAM,CAAC,iBAAiB,EAAE,EAAE,CAAC;gBACnC,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;YACV,CAAC;YAED,IAAI,OAAO,CAAC,aAAa,EAAE,CAAC;gBAC1B,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YACtB,CAAC;YACD,IAAI,OAAO,CAAC,eAAe,EAAE,CAAC;gBAC5B,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YACtB,CAAC;YAED,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC;YAE1C,IAAI,OAAO,CAAC,eAAe,EAAE,CAAC;gBAC5B,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;YACvB,CAAC;YACD,IAAI,OAAO,CAAC,aAAa,EAAE,CAAC;gBAC1B,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;YACvB,CAAC;QACH,CAAC;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,CAAC;YAC/B,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QACxD,CAAC;IACH,CAAC;CACF;AAjQD,0CAiQC"}
|
|
@@ -26,7 +26,7 @@ const DocTable_1 = require("../../nodes/DocTable");
|
|
|
26
26
|
const DocTableRow_1 = require("../../nodes/DocTableRow");
|
|
27
27
|
const DocTableCell_1 = require("../../nodes/DocTableCell");
|
|
28
28
|
const CustomMarkdownEmitter_1 = require("../CustomMarkdownEmitter");
|
|
29
|
-
const
|
|
29
|
+
const api_extractor_model_1 = require("@microsoft/api-extractor-model");
|
|
30
30
|
const chai_1 = require("chai");
|
|
31
31
|
const mocha_chai_jest_snapshot_1 = require("mocha-chai-jest-snapshot");
|
|
32
32
|
(0, chai_1.use)((0, mocha_chai_jest_snapshot_1.jestSnapshotPlugin)());
|
|
@@ -192,7 +192,7 @@ it('render Markdown from TSDoc', () => {
|
|
|
192
192
|
])
|
|
193
193
|
]);
|
|
194
194
|
const stringBuilder = new tsdoc_1.StringBuilder();
|
|
195
|
-
const apiModel = new
|
|
195
|
+
const apiModel = new api_extractor_model_1.ApiModel();
|
|
196
196
|
const markdownEmitter = new CustomMarkdownEmitter_1.CustomMarkdownEmitter(apiModel);
|
|
197
197
|
markdownEmitter.emit(stringBuilder, output, {
|
|
198
198
|
contextApiItem: undefined,
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"CustomMarkdownEmitter.test.js","sourceRoot":"","sources":["../../../src/markdown/test/CustomMarkdownEmitter.test.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;GAeG;;AAEH,4FAA4F;AAC5F,2DAA2D;AAE3D,4CAW0B;AAE1B,qEAA+D;AAC/D,uDAAoD;AACpD,iEAA8D;AAC9D,mDAAgD;AAChD,yDAAsD;AACtD,2DAAwD;AACxD,oEAAiE;AACjE,
|
|
1
|
+
{"version":3,"file":"CustomMarkdownEmitter.test.js","sourceRoot":"","sources":["../../../src/markdown/test/CustomMarkdownEmitter.test.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;GAeG;;AAEH,4FAA4F;AAC5F,2DAA2D;AAE3D,4CAW0B;AAE1B,qEAA+D;AAC/D,uDAAoD;AACpD,iEAA8D;AAC9D,mDAAgD;AAChD,yDAAsD;AACtD,2DAAwD;AACxD,oEAAiE;AACjE,wEAAmE;AACnE,+BAAmC;AACnC,uEAA8D;AAE9D,IAAA,UAAG,EAAC,IAAA,6CAAkB,GAAE,CAAC,CAAC;AAE1B,EAAE,CAAC,4BAA4B,EAAE,GAAG,EAAE;IACpC,MAAM,aAAa,GAAuB,kCAAc,CAAC,aAAa,CAAC;IAEvE,MAAM,MAAM,GAAe,IAAI,kBAAU,CAAC,EAAE,aAAa,EAAE,CAAC,CAAC;IAE7D,MAAM,CAAC,WAAW,CAAC;QACjB,IAAI,uBAAU,CAAC,EAAE,aAAa,EAAE,KAAK,EAAE,kBAAkB,EAAE,CAAC;QAC5D,IAAI,oBAAY,CAAC,EAAE,aAAa,EAAE,EAAE;YAClC,IAAI,oBAAY,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,YAAY,EAAE,CAAC;YACvD,IAAI,iCAAe,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE;gBACjD,IAAI,oBAAY,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;aAClD,CAAC;YACF,IAAI,oBAAY,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;SACpD,CAAC;KACH,CAAC,CAAC;IAEH,MAAM,CAAC,WAAW,CAAC;QACjB,IAAI,uBAAU,CAAC,EAAE,aAAa,EAAE,KAAK,EAAE,qBAAqB,EAAE,CAAC;QAC/D,IAAI,oBAAY,CAAC,EAAE,aAAa,EAAE,EAAE;YAClC,IAAI,iCAAe,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE;gBACjD,IAAI,oBAAY,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;aAChD,CAAC;SACH,CAAC;KACH,CAAC,CAAC;IAEH,MAAM,CAAC,WAAW,CAAC;QACjB,IAAI,uBAAU,CAAC,EAAE,aAAa,EAAE,KAAK,EAAE,cAAc,EAAE,CAAC;QACxD,IAAI,oBAAY,CAAC,EAAE,aAAa,EAAE,EAAE;YAClC,IAAI,iCAAe,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE;gBACjD,IAAI,oBAAY,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;gBACnD,IAAI,oBAAY,CAAC,EAAE,aAAa,EAAE,CAAC;gBACnC,IAAI,oBAAY,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;aACpD,CAAC;SACH,CAAC;KACH,CAAC,CAAC;IAEH,MAAM,CAAC,WAAW,CAAC;QACjB,IAAI,uBAAU,CAAC,EAAE,aAAa,EAAE,KAAK,EAAE,0BAA0B,EAAE,CAAC;QACpE,IAAI,oBAAY,CAAC,EAAE,aAAa,EAAE,EAAE;YAClC,IAAI,iCAAe,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE;gBACjD,IAAI,oBAAY,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,YAAY,EAAE,CAAC;gBACvD,IAAI,oBAAY,CAAC,EAAE,aAAa,EAAE,CAAC;gBACnC,IAAI,oBAAY,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,YAAY,EAAE,CAAC;gBACvD,IAAI,oBAAY,CAAC,EAAE,aAAa,EAAE,CAAC;gBACnC,IAAI,oBAAY,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,YAAY,EAAE,CAAC;aACxD,CAAC;SACH,CAAC;KACH,CAAC,CAAC;IAEH,MAAM,CAAC,WAAW,CAAC;QACjB,IAAI,uBAAU,CAAC,EAAE,aAAa,EAAE,KAAK,EAAE,uBAAuB,EAAE,CAAC;QACjE,IAAI,oBAAY,CAAC,EAAE,aAAa,EAAE,EAAE;YAClC,IAAI,iCAAe,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE;gBACjD,IAAI,oBAAY,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;aACjD,CAAC;YACF,IAAI,iCAAe,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE;gBACjD,IAAI,oBAAY,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;aACjD,CAAC;YACF,IAAI,iCAAe,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE;gBACjD,IAAI,oBAAY,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;aACrD,CAAC;YACF,IAAI,oBAAY,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC;YAC7C,IAAI,iCAAe,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE;gBACjD,IAAI,oBAAY,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;aAClD,CAAC;YACF,IAAI,oBAAY,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC;YACrD,IAAI,iCAAe,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE;gBACjD,IAAI,oBAAY,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;aAClD,CAAC;SACH,CAAC;KACH,CAAC,CAAC;IAEH,MAAM,CAAC,WAAW,CAAC;QACjB,IAAI,uBAAU,CAAC,EAAE,aAAa,EAAE,KAAK,EAAE,8BAA8B,EAAE,CAAC;QACxE,IAAI,oBAAY,CAAC,EAAE,aAAa,EAAE,EAAE;YAClC,IAAI,kBAAU,CAAC;gBACb,aAAa;gBACb,OAAO,EAAE,OAAO;gBAChB,QAAQ,EAAE,QAAQ;gBAClB,cAAc,EAAE,YAAY;aAC7B,CAAC;YACF,IAAI,iCAAe,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE;gBACjD,IAAI,oBAAY,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;aAClD,CAAC;YACF,IAAI,oBAAY,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC;YACrD,IAAI,oBAAY,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,eAAe,EAAE,CAAC;SAC3D,CAAC;KACH,CAAC,CAAC;IAEH,MAAM,CAAC,WAAW,CAAC;QACjB,IAAI,uBAAU,CAAC,EAAE,aAAa,EAAE,KAAK,EAAE,mBAAmB,EAAE,CAAC;QAC7D,IAAI,oBAAY,CAAC,EAAE,aAAa,EAAE,EAAE;YAClC,IAAI,mBAAW,CAAC;gBACd,aAAa;gBACb,OAAO,EAAE,UAAU;aACpB,CAAC;YACF,IAAI,iCAAe,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE;gBACjD,IAAI,oBAAY,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;aAClD,CAAC;YACF,IAAI,oBAAY,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC;YACrD,IAAI,oBAAY,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,eAAe,EAAE,CAAC;SAC3D,CAAC;KACH,CAAC,CAAC;IAEH,MAAM,CAAC,WAAW,CAAC;QACjB,IAAI,uBAAU,CAAC,EAAE,aAAa,EAAE,KAAK,EAAE,gBAAgB,EAAE,CAAC;QAC1D,IAAI,oBAAY,CAAC,EAAE,aAAa,EAAE,EAAE;YAClC,IAAI,iCAAe,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE;gBACjD,IAAI,oBAAY,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC;aACvD,CAAC;YACF,IAAI,iCAAe,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE;gBACjD,IAAI,oBAAY,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,YAAY,EAAE,CAAC;aACxD,CAAC;SACH,CAAC;KACH,CAAC,CAAC;IAEH,MAAM,CAAC,WAAW,CAAC;QACjB,IAAI,uBAAU,CAAC;YACb,aAAa;YACb,KAAK,EAAE,mCAAmC;SAC3C,CAAC;QACF,IAAI,oBAAY,CAAC,EAAE,aAAa,EAAE,EAAE;YAClC,IAAI,oBAAY,CAAC;gBACf,aAAa;gBACb,IAAI,EAAE,wCAAwC;aAC/C,CAAC;SACH,CAAC;QACF,IAAI,oBAAY,CAAC,EAAE,aAAa,EAAE,EAAE;YAClC,IAAI,oBAAY,CAAC;gBACf,aAAa;gBACb,IAAI,EAAE,sDAAsD;aAC7D,CAAC;SACH,CAAC;QACF,IAAI,oBAAY,CAAC,EAAE,aAAa,EAAE,EAAE;YAClC,IAAI,oBAAY,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,qBAAqB,EAAE,CAAC;SACjE,CAAC;QACF,IAAI,oBAAY,CAAC,EAAE,aAAa,EAAE,EAAE;YAClC,IAAI,oBAAY,CAAC;gBACf,aAAa;gBACb,IAAI,EAAE,+CAA+C;aACtD,CAAC;SACH,CAAC;KACH,CAAC,CAAC;IAEH,MAAM,CAAC,WAAW,CAAC;QACjB,IAAI,uBAAU,CAAC,EAAE,aAAa,EAAE,KAAK,EAAE,UAAU,EAAE,CAAC;QACpD,IAAI,oBAAY,CAAC,EAAE,aAAa,EAAE,EAAE;YAClC,IAAI,uBAAe,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC;YACjD,IAAI,oBAAY,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;YACjD,IAAI,qBAAa,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC;SAChD,CAAC;KACH,CAAC,CAAC;IAEH,MAAM,CAAC,WAAW,CAAC;QACjB,IAAI,uBAAU,CAAC,EAAE,aAAa,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC;QACjD,IAAI,mBAAQ,CACV;YACE,aAAa;YACb,YAAY,EAAE,CAAC,UAAU,EAAE,UAAU,CAAC;SACvC,EACD;YACE,IAAI,yBAAW,CAAC,EAAE,aAAa,EAAE,EAAE;gBACjC,IAAI,2BAAY,CAAC,EAAE,aAAa,EAAE,EAAE;oBAClC,IAAI,oBAAY,CAAC,EAAE,aAAa,EAAE,EAAE;wBAClC,IAAI,oBAAY,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;qBACpD,CAAC;iBACH,CAAC;gBACF,IAAI,2BAAY,CAAC,EAAE,aAAa,EAAE,EAAE;oBAClC,IAAI,oBAAY,CAAC,EAAE,aAAa,EAAE,EAAE;wBAClC,IAAI,oBAAY,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;qBACpD,CAAC;iBACH,CAAC;aACH,CAAC;SACH,CACF;KACF,CAAC,CAAC;IAEH,MAAM,aAAa,GAAkB,IAAI,qBAAa,EAAE,CAAC;IACzD,MAAM,QAAQ,GAAa,IAAI,8BAAQ,EAAE,CAAC;IAC1C,MAAM,eAAe,GAA0B,IAAI,6CAAqB,CACtE,QAAQ,CACT,CAAC;IACF,eAAe,CAAC,IAAI,CAAC,aAAa,EAAE,MAAM,EAAE;QAC1C,cAAc,EAAE,SAAS;QACzB,uBAAuB,EAAE,CAAC,OAAgB,EAAE,EAAE;YAC5C,OAAO,GAAG,CAAC;QACb,CAAC;KACF,CAAC,CAAC;IAEH,IAAA,aAAM,EAAC,aAAa,CAAC,CAAC,eAAe,EAAE,CAAC;AAC1C,CAAC,CAAC,CAAC"}
|
|
@@ -42,13 +42,13 @@ class CustomDocNodes {
|
|
|
42
42
|
},
|
|
43
43
|
{ docNodeKind: "TableRow" /* CustomDocNodeKind.TableRow */, constructor: DocTableRow_1.DocTableRow }
|
|
44
44
|
]);
|
|
45
|
-
configuration.docNodeManager.registerAllowableChildren("EmphasisSpan" /* CustomDocNodeKind.EmphasisSpan */, [
|
|
46
|
-
configuration.docNodeManager.registerAllowableChildren(
|
|
45
|
+
configuration.docNodeManager.registerAllowableChildren("EmphasisSpan" /* CustomDocNodeKind.EmphasisSpan */, [tsdoc_1.DocNodeKind.PlainText, tsdoc_1.DocNodeKind.SoftBreak]);
|
|
46
|
+
configuration.docNodeManager.registerAllowableChildren(tsdoc_1.DocNodeKind.Section, [
|
|
47
47
|
"Heading" /* CustomDocNodeKind.Heading */,
|
|
48
48
|
"NoteBox" /* CustomDocNodeKind.NoteBox */,
|
|
49
49
|
"Table" /* CustomDocNodeKind.Table */
|
|
50
50
|
]);
|
|
51
|
-
configuration.docNodeManager.registerAllowableChildren(
|
|
51
|
+
configuration.docNodeManager.registerAllowableChildren(tsdoc_1.DocNodeKind.Paragraph, ["EmphasisSpan" /* CustomDocNodeKind.EmphasisSpan */]);
|
|
52
52
|
CustomDocNodes._configuration = configuration;
|
|
53
53
|
}
|
|
54
54
|
return CustomDocNodes._configuration;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"CustomDocNodeKind.js","sourceRoot":"","sources":["../../src/nodes/CustomDocNodeKind.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;GAeG;;;AAEH,4CAAmE;AACnE,uDAAoD;AACpD,6CAA0C;AAC1C,6CAA0C;AAC1C,yCAAsC;AACtC,iDAA8C;AAC9C,+CAA4C;AAiB5C,MAAa,cAAc;IAGlB,MAAM,KAAK,aAAa;QAC7B,IAAI,cAAc,CAAC,cAAc,KAAK,SAAS,EAAE,CAAC;YAChD,MAAM,aAAa,GAAuB,IAAI,0BAAkB,EAAE,CAAC;YAEnE,aAAa,CAAC,cAAc,CAAC,gBAAgB,CAC3C,4BAA4B,EAC5B;gBACE;oBACE,WAAW,qDAAgC;oBAC3C,WAAW,EAAE,iCAAe;iBAC7B;gBACD,EAAE,WAAW,2CAA2B,EAAE,WAAW,EAAE,uBAAU,EAAE;gBACnE,EAAE,WAAW,2CAA2B,EAAE,WAAW,EAAE,uBAAU,EAAE;gBACnE,EAAE,WAAW,uCAAyB,EAAE,WAAW,EAAE,mBAAQ,EAAE;gBAC/D;oBACE,WAAW,+CAA6B;oBACxC,WAAW,EAAE,2BAAY;iBAC1B;gBACD,EAAE,WAAW,6CAA4B,EAAE,WAAW,EAAE,yBAAW,EAAE;aACtE,CACF,CAAC;YAEF,aAAa,CAAC,cAAc,CAAC,yBAAyB,sDAEpD,
|
|
1
|
+
{"version":3,"file":"CustomDocNodeKind.js","sourceRoot":"","sources":["../../src/nodes/CustomDocNodeKind.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;GAeG;;;AAEH,4CAAmE;AACnE,uDAAoD;AACpD,6CAA0C;AAC1C,6CAA0C;AAC1C,yCAAsC;AACtC,iDAA8C;AAC9C,+CAA4C;AAiB5C,MAAa,cAAc;IAGlB,MAAM,KAAK,aAAa;QAC7B,IAAI,cAAc,CAAC,cAAc,KAAK,SAAS,EAAE,CAAC;YAChD,MAAM,aAAa,GAAuB,IAAI,0BAAkB,EAAE,CAAC;YAEnE,aAAa,CAAC,cAAc,CAAC,gBAAgB,CAC3C,4BAA4B,EAC5B;gBACE;oBACE,WAAW,qDAAgC;oBAC3C,WAAW,EAAE,iCAAe;iBAC7B;gBACD,EAAE,WAAW,2CAA2B,EAAE,WAAW,EAAE,uBAAU,EAAE;gBACnE,EAAE,WAAW,2CAA2B,EAAE,WAAW,EAAE,uBAAU,EAAE;gBACnE,EAAE,WAAW,uCAAyB,EAAE,WAAW,EAAE,mBAAQ,EAAE;gBAC/D;oBACE,WAAW,+CAA6B;oBACxC,WAAW,EAAE,2BAAY;iBAC1B;gBACD,EAAE,WAAW,6CAA4B,EAAE,WAAW,EAAE,yBAAW,EAAE;aACtE,CACF,CAAC;YAEF,aAAa,CAAC,cAAc,CAAC,yBAAyB,sDAEpD,CAAC,mBAAW,CAAC,SAAS,EAAE,mBAAW,CAAC,SAAS,CAAC,CAC/C,CAAC;YAEF,aAAa,CAAC,cAAc,CAAC,yBAAyB,CACpD,mBAAW,CAAC,OAAO,EACnB;;;;aAIC,CACF,CAAC;YAEF,aAAa,CAAC,cAAc,CAAC,yBAAyB,CACpD,mBAAW,CAAC,SAAS,EACrB,qDAAgC,CACjC,CAAC;YAEF,cAAc,CAAC,cAAc,GAAG,aAAa,CAAC;QAChD,CAAC;QACD,OAAO,cAAc,CAAC,cAAc,CAAC;IACvC,CAAC;CACF;AAhDD,wCAgDC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"DocEmphasisSpan.js","sourceRoot":"","sources":["../../src/nodes/DocEmphasisSpan.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;GAeG;;;AAEH,4FAA4F;AAC5F,2DAA2D;AAE3D,4CAI0B;
|
|
1
|
+
{"version":3,"file":"DocEmphasisSpan.js","sourceRoot":"","sources":["../../src/nodes/DocEmphasisSpan.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;GAeG;;;AAEH,4FAA4F;AAC5F,2DAA2D;AAE3D,4CAI0B;AAW1B;;;GAGG;AACH,MAAa,eAAgB,SAAQ,wBAAgB;IAInD,YACE,UAAsC,EACtC,QAAoB;QAEpB,KAAK,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;QAC5B,IAAI,CAAC,IAAI,GAAG,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC;QAC9B,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,UAAU,CAAC,MAAM,CAAC;IACpC,CAAC;IAED,gBAAgB;IAChB,IAAW,IAAI;QACb,2DAAsC;IACxC,CAAC;CACF;AAjBD,0CAiBC"}
|
|
@@ -14,7 +14,7 @@
|
|
|
14
14
|
* See the License for the specific language governing permissions and
|
|
15
15
|
* limitations under the License.
|
|
16
16
|
*/
|
|
17
|
-
import { ApiItem } from 'api-extractor-model
|
|
17
|
+
import { ApiItem } from '@microsoft/api-extractor-model';
|
|
18
18
|
/** @internal */
|
|
19
19
|
export interface IMarkdownDocumenterAccessorImplementation {
|
|
20
20
|
getLinkForApiItem(apiItem: ApiItem): string | undefined;
|
|
@@ -14,7 +14,7 @@
|
|
|
14
14
|
* See the License for the specific language governing permissions and
|
|
15
15
|
* limitations under the License.
|
|
16
16
|
*/
|
|
17
|
-
import { ApiItem, ApiModel } from 'api-extractor-model
|
|
17
|
+
import { ApiItem, ApiModel } from '@microsoft/api-extractor-model';
|
|
18
18
|
import { PluginFeature } from './PluginFeature';
|
|
19
19
|
import { MarkdownDocumenterAccessor } from './MarkdownDocumenterAccessor';
|
|
20
20
|
/**
|
|
@@ -21,7 +21,6 @@ const tslib_1 = require("tslib");
|
|
|
21
21
|
// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
|
|
22
22
|
// See LICENSE in the project root for license information.
|
|
23
23
|
const path = tslib_1.__importStar(require("path"));
|
|
24
|
-
const resolve = tslib_1.__importStar(require("resolve"));
|
|
25
24
|
const MarkdownDocumenterFeature_1 = require("./MarkdownDocumenterFeature");
|
|
26
25
|
const PluginFeature_1 = require("./PluginFeature");
|
|
27
26
|
class PluginLoader {
|
|
@@ -30,8 +29,8 @@ class PluginLoader {
|
|
|
30
29
|
for (const configPlugin of documenterConfig.configFile.plugins || []) {
|
|
31
30
|
try {
|
|
32
31
|
// Look for the package name in the same place as the config file
|
|
33
|
-
const resolvedEntryPointPath = resolve
|
|
34
|
-
|
|
32
|
+
const resolvedEntryPointPath = require.resolve(configPlugin.packageName, {
|
|
33
|
+
paths: [path.resolve(configFileFolder)]
|
|
35
34
|
});
|
|
36
35
|
// Load the package
|
|
37
36
|
const entryPoint = require(resolvedEntryPointPath);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"PluginLoader.js","sourceRoot":"","sources":["../../src/plugin/PluginLoader.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;GAeG;;;;AAEH,4FAA4F;AAC5F,2DAA2D;AAE3D,mDAA6B;
|
|
1
|
+
{"version":3,"file":"PluginLoader.js","sourceRoot":"","sources":["../../src/plugin/PluginLoader.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;GAeG;;;;AAEH,4FAA4F;AAC5F,2DAA2D;AAE3D,mDAA6B;AAM7B,2EAGqC;AACrC,mDAA8D;AAQ9D,MAAa,YAAY;IAGhB,IAAI,CACT,gBAAkC,EAClC,aAAqD;QAErD,MAAM,gBAAgB,GAAW,IAAI,CAAC,OAAO,CAC3C,gBAAgB,CAAC,cAAc,CAChC,CAAC;QACF,KAAK,MAAM,YAAY,IAAI,gBAAgB,CAAC,UAAU,CAAC,OAAO,IAAI,EAAE,EAAE,CAAC;YACrE,IAAI,CAAC;gBACH,iEAAiE;gBACjE,MAAM,sBAAsB,GAAW,OAAO,CAAC,OAAO,CACpD,YAAY,CAAC,WAAW,EACxB;oBACE,KAAK,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC;iBACxC,CACF,CAAC;gBAEF,mBAAmB;gBACnB,MAAM,UAAU,GAEA,OAAO,CAAC,sBAAsB,CAAC,CAAC;gBAEhD,IAAI,CAAC,UAAU,EAAE,CAAC;oBAChB,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC;gBACzC,CAAC;gBAED,IAAI,CAAC,UAAU,CAAC,2BAA2B,EAAE,CAAC;oBAC5C,MAAM,IAAI,KAAK,CACb,8CAA8C;wBAC5C,yDAAyD,CAC5D,CAAC;gBACJ,CAAC;gBAED,MAAM,QAAQ,GACZ,UAAU,CAAC,2BAA2B,CAAC;gBAEzC,IAAI,QAAQ,CAAC,eAAe,KAAK,IAAI,EAAE,CAAC;oBACtC,MAAM,IAAI,KAAK,CACb,mEAAmE;wBACjE,8BAA8B,CACjC,CAAC;gBACJ,CAAC;gBAED,MAAM,YAAY,GAAkB;oBAClC,WAAW,EAAE,YAAY,CAAC,WAAW;oBACrC,QAAQ;iBACT,CAAC;gBAEF,MAAM,wBAAwB,GAC5B,IAAI,GAAG,EAA8B,CAAC;gBACxC,KAAK,MAAM,iBAAiB,IAAI,QAAQ,CAAC,QAAQ,EAAE,CAAC;oBAClD,wBAAwB,CAAC,GAAG,CAC1B,iBAAiB,CAAC,WAAW,EAC7B,iBAAiB,CAClB,CAAC;gBACJ,CAAC;gBAED,KAAK,MAAM,WAAW,IAAI,YAAY,CAAC,mBAAmB,EAAE,CAAC;oBAC3D,MAAM,iBAAiB,GACrB,wBAAwB,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;oBAC5C,IAAI,CAAC,iBAAiB,EAAE,CAAC;wBACvB,MAAM,IAAI,KAAK,CACb,cAAc,YAAY,CAAC,WAAW,uCAAuC,WAAW,GAAG,CAC5F,CAAC;oBACJ,CAAC;oBAED,IAAI,iBAAiB,CAAC,IAAI,KAAK,2BAA2B,EAAE,CAAC;wBAC3D,IAAI,IAAI,CAAC,yBAAyB,EAAE,CAAC;4BACnC,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAC;wBACnE,CAAC;wBAED,MAAM,cAAc,GAClB,IAAI,2CAA2B,EAAE,CAAC;wBACpC,cAAc,CAAC,QAAQ,GAAG,aAAa,EAAE,CAAC;wBAE1C,IAAI,yBAAyB,GACa,SAAS,CAAC;wBACpD,IAAI,CAAC;4BACH,yBAAyB,GAAG,IAAI,iBAAiB,CAAC,QAAQ,CACxD,cAAc,CACf,CAAC;wBACJ,CAAC;wBAAC,OAAO,CAAC,EAAE,CAAC;4BACX,MAAM,IAAI,KAAK,CACb,yCAAyC;iCACtC,CAAW,aAAX,CAAC,uBAAD,CAAC,CAAY,QAAQ,EAAE,CAAA,CAC3B,CAAC;wBACJ,CAAC;wBACD,IACE,CAAC,CAAC,yBAAyB,YAAY,qDAAyB,CAAC,EACjE,CAAC;4BACD,MAAM,IAAI,KAAK,CACb,2EAA2E,CAC5E,CAAC;wBACJ,CAAC;wBAED,IAAI,CAAC;4BACH,yBAAyB,CAAC,aAAa,EAAE,CAAC;wBAC5C,CAAC;wBAAC,OAAO,CAAC,EAAE,CAAC;4BACX,MAAM,IAAI,KAAK,CACb,mDAAmD;iCAChD,CAAW,aAAX,CAAC,uBAAD,CAAC,CAAY,QAAQ,EAAE,CAAA,CAC3B,CAAC;wBACJ,CAAC;wBAED,IAAI,CAAC,yBAAyB,GAAG,yBAAyB,CAAC;oBAC7D,CAAC;yBAAM,CAAC;wBACN,MAAM,IAAI,KAAK,CACb,qCAAqC,iBAAiB,CAAC,IAAI,GAAG,CAC/D,CAAC;oBACJ,CAAC;gBACH,CAAC;YACH,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACX,MAAM,IAAI,KAAK,CACb,wBAAwB,YAAY,CAAC,WAAW,IAAI;qBACjD,CAAW,aAAX,CAAC,uBAAD,CAAC,CAAY,OAAO,CAAA,CACxB,CAAC;YACJ,CAAC;QACH,CAAC;IACH,CAAC;CACF;AA1HD,oCA0HC"}
|
package/dist/start.js
CHANGED
|
@@ -21,11 +21,11 @@ const tslib_1 = require("tslib");
|
|
|
21
21
|
// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
|
|
22
22
|
// See LICENSE in the project root for license information.
|
|
23
23
|
const os = tslib_1.__importStar(require("os"));
|
|
24
|
-
const
|
|
24
|
+
const style_1 = require("./utils/style");
|
|
25
25
|
const node_core_library_1 = require("@rushstack/node-core-library");
|
|
26
26
|
const ApiDocumenterCommandLine_1 = require("./cli/ApiDocumenterCommandLine");
|
|
27
27
|
const myPackageVersion = node_core_library_1.PackageJsonLookup.loadOwnPackageJson(__dirname).version;
|
|
28
|
-
console.log(os.EOL +
|
|
28
|
+
console.log(os.EOL + (0, style_1.bold)(`@firebase/api-documenter ${myPackageVersion} ` + os.EOL));
|
|
29
29
|
const parser = new ApiDocumenterCommandLine_1.ApiDocumenterCommandLine();
|
|
30
|
-
parser.
|
|
30
|
+
parser.executeAsync().catch(console.error); // CommandLineParser.executeAsync() should never reject the promise
|
|
31
31
|
//# sourceMappingURL=start.js.map
|
package/dist/start.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"start.js","sourceRoot":"","sources":["../src/start.ts"],"names":[],"mappings":";;AAEA;;;;;;;;;;;;;;;GAeG;;;AAEH,4FAA4F;AAC5F,2DAA2D;AAE3D,+CAAyB;AACzB,
|
|
1
|
+
{"version":3,"file":"start.js","sourceRoot":"","sources":["../src/start.ts"],"names":[],"mappings":";;AAEA;;;;;;;;;;;;;;;GAeG;;;AAEH,4FAA4F;AAC5F,2DAA2D;AAE3D,+CAAyB;AACzB,yCAAqC;AAErC,oEAAiE;AAEjE,6EAA0E;AAE1E,MAAM,gBAAgB,GACpB,qCAAiB,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC;AAE1D,OAAO,CAAC,GAAG,CACT,EAAE,CAAC,GAAG,GAAG,IAAA,YAAI,EAAC,4BAA4B,gBAAgB,GAAG,GAAG,EAAE,CAAC,GAAG,CAAC,CACxE,CAAC;AAEF,MAAM,MAAM,GAA6B,IAAI,mDAAwB,EAAE,CAAC;AAExE,MAAM,CAAC,YAAY,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,mEAAmE"}
|
package/dist/toc.d.ts
CHANGED
|
@@ -14,12 +14,14 @@
|
|
|
14
14
|
* See the License for the specific language governing permissions and
|
|
15
15
|
* limitations under the License.
|
|
16
16
|
*/
|
|
17
|
-
import { ApiModel } from 'api-extractor-model
|
|
17
|
+
import { ApiModel } from '@microsoft/api-extractor-model';
|
|
18
|
+
import { ISubpackageInfo } from './documenters/MarkdownDocumenterHelpers';
|
|
18
19
|
export interface ITocGenerationOptions {
|
|
19
20
|
apiModel: ApiModel;
|
|
20
21
|
g3Path: string;
|
|
21
22
|
outputFolder: string;
|
|
22
23
|
addFileNameSuffix: boolean;
|
|
23
24
|
jsSdk: boolean;
|
|
25
|
+
subpackages?: Map<string, ISubpackageInfo>;
|
|
24
26
|
}
|
|
25
|
-
export declare function generateToc({ apiModel, g3Path, outputFolder, addFileNameSuffix, jsSdk }: ITocGenerationOptions): void;
|
|
27
|
+
export declare function generateToc({ apiModel, g3Path, outputFolder, addFileNameSuffix, jsSdk, subpackages }: ITocGenerationOptions): void;
|
package/dist/toc.js
CHANGED
|
@@ -19,10 +19,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
19
19
|
exports.generateToc = generateToc;
|
|
20
20
|
const tslib_1 = require("tslib");
|
|
21
21
|
const js_yaml_1 = tslib_1.__importDefault(require("js-yaml"));
|
|
22
|
+
const api_extractor_model_1 = require("@microsoft/api-extractor-model");
|
|
22
23
|
const MarkdownDocumenterHelpers_1 = require("./documenters/MarkdownDocumenterHelpers");
|
|
24
|
+
const node_core_library_1 = require("@rushstack/node-core-library");
|
|
23
25
|
const fs_1 = require("fs");
|
|
24
26
|
const path_1 = require("path");
|
|
25
|
-
function generateToc({ apiModel, g3Path, outputFolder, addFileNameSuffix, jsSdk }) {
|
|
27
|
+
function generateToc({ apiModel, g3Path, outputFolder, addFileNameSuffix, jsSdk, subpackages }) {
|
|
26
28
|
const toc = [];
|
|
27
29
|
if (jsSdk) {
|
|
28
30
|
const firebaseToc = {
|
|
@@ -31,27 +33,34 @@ function generateToc({ apiModel, g3Path, outputFolder, addFileNameSuffix, jsSdk
|
|
|
31
33
|
};
|
|
32
34
|
toc.push(firebaseToc);
|
|
33
35
|
}
|
|
34
|
-
generateTocRecursively(apiModel, g3Path, addFileNameSuffix, toc);
|
|
36
|
+
generateTocRecursively(apiModel, apiModel, g3Path, addFileNameSuffix, toc, subpackages);
|
|
35
37
|
(0, fs_1.writeFileSync)((0, path_1.resolve)(outputFolder, 'toc.yaml'), js_yaml_1.default.dump({ toc }, {
|
|
36
|
-
|
|
37
|
-
|
|
38
|
+
quoteStyle: 'double',
|
|
39
|
+
seqNoIndent: true
|
|
38
40
|
}));
|
|
39
41
|
}
|
|
40
|
-
function generateTocRecursively(apiItem, g3Path, addFileNameSuffix, toc) {
|
|
42
|
+
function generateTocRecursively(apiModel, apiItem, g3Path, addFileNameSuffix, toc, subpackages) {
|
|
41
43
|
// generate toc item only for entry points
|
|
42
|
-
if (apiItem.kind ===
|
|
44
|
+
if (apiItem.kind === api_extractor_model_1.ApiItemKind.EntryPoint) {
|
|
43
45
|
// Entry point
|
|
44
|
-
const
|
|
46
|
+
const escapedPath = apiItem.canonicalReference.source
|
|
47
|
+
.escapedPath;
|
|
48
|
+
let title = node_core_library_1.PackageName.getUnscopedName(escapedPath);
|
|
49
|
+
const info = (0, MarkdownDocumenterHelpers_1.getSubpackageInfo)(apiItem.parent, subpackages);
|
|
50
|
+
if (info) {
|
|
51
|
+
const unscopedParent = node_core_library_1.PackageName.getUnscopedName(info.parentPackageName);
|
|
52
|
+
title = `${unscopedParent}/${info.subpath}`;
|
|
53
|
+
}
|
|
45
54
|
const entryPointToc = {
|
|
46
|
-
title
|
|
47
|
-
path: `${g3Path}/${(0, MarkdownDocumenterHelpers_1.getFilenameForApiItem)(apiItem, addFileNameSuffix)}`,
|
|
55
|
+
title,
|
|
56
|
+
path: `${g3Path}/${(0, MarkdownDocumenterHelpers_1.getFilenameForApiItem)(apiItem, addFileNameSuffix, subpackages)}`,
|
|
48
57
|
section: []
|
|
49
58
|
};
|
|
50
59
|
for (const member of apiItem.members) {
|
|
51
60
|
// only classes and interfaces have dedicated pages
|
|
52
|
-
if (member.kind ===
|
|
53
|
-
member.kind ===
|
|
54
|
-
const fileName = (0, MarkdownDocumenterHelpers_1.getFilenameForApiItem)(member, addFileNameSuffix);
|
|
61
|
+
if (member.kind === api_extractor_model_1.ApiItemKind.Class ||
|
|
62
|
+
member.kind === api_extractor_model_1.ApiItemKind.Interface) {
|
|
63
|
+
const fileName = (0, MarkdownDocumenterHelpers_1.getFilenameForApiItem)(member, addFileNameSuffix, subpackages);
|
|
55
64
|
entryPointToc.section.push({
|
|
56
65
|
title: member.displayName,
|
|
57
66
|
path: `${g3Path}/${fileName}`
|
|
@@ -63,7 +72,7 @@ function generateTocRecursively(apiItem, g3Path, addFileNameSuffix, toc) {
|
|
|
63
72
|
else {
|
|
64
73
|
// travel the api tree to find the next entry point
|
|
65
74
|
for (const member of apiItem.members) {
|
|
66
|
-
generateTocRecursively(member, g3Path, addFileNameSuffix, toc);
|
|
75
|
+
generateTocRecursively(apiModel, member, g3Path, addFileNameSuffix, toc, subpackages);
|
|
67
76
|
}
|
|
68
77
|
}
|
|
69
78
|
}
|
package/dist/toc.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"toc.js","sourceRoot":"","sources":["../src/toc.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;GAeG;;
|
|
1
|
+
{"version":3,"file":"toc.js","sourceRoot":"","sources":["../src/toc.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;GAeG;;AAkCH,kCAqCC;;AArED,8DAA2B;AAC3B,wEAKwC;AACxC,uFAIiD;AACjD,oEAA2D;AAE3D,2BAAmC;AACnC,+BAA+B;AAiB/B,SAAgB,WAAW,CAAC,EAC1B,QAAQ,EACR,MAAM,EACN,YAAY,EACZ,iBAAiB,EACjB,KAAK,EACL,WAAW,EACW;IACtB,MAAM,GAAG,GAAG,EAAE,CAAC;IAEf,IAAI,KAAK,EAAE,CAAC;QACV,MAAM,WAAW,GAAa;YAC5B,KAAK,EAAE,UAAU;YACjB,IAAI,EAAE,GAAG,MAAM,QAAQ;SACxB,CAAC;QACF,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IACxB,CAAC;IAED,sBAAsB,CACpB,QAAQ,EACR,QAAQ,EACR,MAAM,EACN,iBAAiB,EACjB,GAAG,EACH,WAAW,CACZ,CAAC;IAEF,IAAA,kBAAa,EACX,IAAA,cAAO,EAAC,YAAY,EAAE,UAAU,CAAC,EACjC,iBAAI,CAAC,IAAI,CACP,EAAE,GAAG,EAAE,EACP;QACE,UAAU,EAAE,QAAQ;QACpB,WAAW,EAAE,IAAI;KAClB,CACF,CACF,CAAC;AACJ,CAAC;AAED,SAAS,sBAAsB,CAC7B,QAAkB,EAClB,OAAgB,EAChB,MAAc,EACd,iBAA0B,EAC1B,GAAe,EACf,WAA0C;IAE1C,0CAA0C;IAC1C,IAAI,OAAO,CAAC,IAAI,KAAK,iCAAW,CAAC,UAAU,EAAE,CAAC;QAC5C,cAAc;QACd,MAAM,WAAW,GAAI,OAAO,CAAC,kBAAkB,CAAC,MAAwB;aACrE,WAAW,CAAC;QACf,IAAI,KAAK,GAAG,+BAAW,CAAC,eAAe,CAAC,WAAW,CAAC,CAAC;QACrD,MAAM,IAAI,GAAG,IAAA,6CAAiB,EAAC,OAAO,CAAC,MAAoB,EAAE,WAAW,CAAC,CAAC;QAC1E,IAAI,IAAI,EAAE,CAAC;YACT,MAAM,cAAc,GAAG,+BAAW,CAAC,eAAe,CAChD,IAAI,CAAC,iBAAiB,CACvB,CAAC;YACF,KAAK,GAAG,GAAG,cAAc,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;QAC9C,CAAC;QACD,MAAM,aAAa,GAAa;YAC9B,KAAK;YACL,IAAI,EAAE,GAAG,MAAM,IAAI,IAAA,iDAAqB,EACtC,OAAO,EACP,iBAAiB,EACjB,WAAW,CACZ,EAAE;YACH,OAAO,EAAE,EAAE;SACZ,CAAC;QAEF,KAAK,MAAM,MAAM,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;YACrC,mDAAmD;YACnD,IACE,MAAM,CAAC,IAAI,KAAK,iCAAW,CAAC,KAAK;gBACjC,MAAM,CAAC,IAAI,KAAK,iCAAW,CAAC,SAAS,EACrC,CAAC;gBACD,MAAM,QAAQ,GAAG,IAAA,iDAAqB,EACpC,MAAM,EACN,iBAAiB,EACjB,WAAW,CACZ,CAAC;gBACF,aAAa,CAAC,OAAQ,CAAC,IAAI,CAAC;oBAC1B,KAAK,EAAE,MAAM,CAAC,WAAW;oBACzB,IAAI,EAAE,GAAG,MAAM,IAAI,QAAQ,EAAE;iBAC9B,CAAC,CAAC;YACL,CAAC;QACH,CAAC;QAED,GAAG,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;IAC1B,CAAC;SAAM,CAAC;QACN,mDAAmD;QACnD,KAAK,MAAM,MAAM,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;YACrC,sBAAsB,CACpB,QAAQ,EACR,MAAM,EACN,MAAM,EACN,iBAAiB,EACjB,GAAG,EACH,WAAW,CACZ,CAAC;QACJ,CAAC;IACH,CAAC;AACH,CAAC"}
|
|
@@ -14,7 +14,7 @@
|
|
|
14
14
|
* See the License for the specific language governing permissions and
|
|
15
15
|
* limitations under the License.
|
|
16
16
|
*/
|
|
17
|
-
import { ApiItem } from 'api-extractor-model
|
|
17
|
+
import { ApiItem } from '@microsoft/api-extractor-model';
|
|
18
18
|
export declare class Utilities {
|
|
19
19
|
private static readonly _badFilenameCharsRegExp;
|
|
20
20
|
/**
|
package/dist/utils/Utilities.js
CHANGED
|
@@ -19,13 +19,13 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
19
19
|
exports.Utilities = void 0;
|
|
20
20
|
// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
|
|
21
21
|
// See LICENSE in the project root for license information.
|
|
22
|
-
const
|
|
22
|
+
const api_extractor_model_1 = require("@microsoft/api-extractor-model");
|
|
23
23
|
class Utilities {
|
|
24
24
|
/**
|
|
25
25
|
* Generates a concise signature for a function. Example: "getArea(width, height)"
|
|
26
26
|
*/
|
|
27
27
|
static getConciseSignature(apiItem) {
|
|
28
|
-
if (
|
|
28
|
+
if (api_extractor_model_1.ApiParameterListMixin.isBaseClassOf(apiItem)) {
|
|
29
29
|
return (apiItem.displayName +
|
|
30
30
|
'(' +
|
|
31
31
|
apiItem.parameters.map(x => x.name).join(', ') +
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Utilities.js","sourceRoot":"","sources":["../../src/utils/Utilities.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;GAeG;;;AAEH,4FAA4F;AAC5F,2DAA2D;AAE3D,
|
|
1
|
+
{"version":3,"file":"Utilities.js","sourceRoot":"","sources":["../../src/utils/Utilities.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;GAeG;;;AAEH,4FAA4F;AAC5F,2DAA2D;AAE3D,wEAAgF;AAEhF,MAAa,SAAS;IAEpB;;OAEG;IACI,MAAM,CAAC,mBAAmB,CAAC,OAAgB;QAChD,IAAI,2CAAqB,CAAC,aAAa,CAAC,OAAO,CAAC,EAAE,CAAC;YACjD,OAAO,CACL,OAAO,CAAC,WAAW;gBACnB,GAAG;gBACH,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;gBAC9C,GAAG,CACJ,CAAC;QACJ,CAAC;QACD,OAAO,OAAO,CAAC,WAAW,CAAC;IAC7B,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,sBAAsB,CAAC,IAAY;QAC/C,8CAA8C;QAC9C,iFAAiF;QACjF,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,uBAAuB,EAAE,GAAG,CAAC,CAAC,WAAW,EAAE,CAAC;IAC5E,CAAC;;AAxBH,8BAyBC;AAxByB,iCAAuB,GAAW,kBAAkB,CAAC"}
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @license
|
|
3
|
+
* Copyright 2026 Google LLC
|
|
4
|
+
*
|
|
5
|
+
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
6
|
+
* you may not use this file except in compliance with the License.
|
|
7
|
+
* You may obtain a copy of the License at
|
|
8
|
+
*
|
|
9
|
+
* http://www.apache.org/licenses/LICENSE-2.0
|
|
10
|
+
*
|
|
11
|
+
* Unless required by applicable law or agreed to in writing, software
|
|
12
|
+
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
13
|
+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
14
|
+
* See the License for the specific language governing permissions and
|
|
15
|
+
* limitations under the License.
|
|
16
|
+
*/
|
|
17
|
+
export declare function bold(text: string): string;
|
|
18
|
+
export declare function yellow(text: string): string;
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* @license
|
|
4
|
+
* Copyright 2026 Google LLC
|
|
5
|
+
*
|
|
6
|
+
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
7
|
+
* you may not use this file except in compliance with the License.
|
|
8
|
+
* You may obtain a copy of the License at
|
|
9
|
+
*
|
|
10
|
+
* http://www.apache.org/licenses/LICENSE-2.0
|
|
11
|
+
*
|
|
12
|
+
* Unless required by applicable law or agreed to in writing, software
|
|
13
|
+
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
14
|
+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
15
|
+
* See the License for the specific language governing permissions and
|
|
16
|
+
* limitations under the License.
|
|
17
|
+
*/
|
|
18
|
+
var _a;
|
|
19
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
20
|
+
exports.bold = bold;
|
|
21
|
+
exports.yellow = yellow;
|
|
22
|
+
const useColors = typeof process !== 'undefined' &&
|
|
23
|
+
(process.env.FORCE_COLOR !== undefined ||
|
|
24
|
+
(!!((_a = process.stdout) === null || _a === void 0 ? void 0 : _a.isTTY) && !process.env.NO_COLOR));
|
|
25
|
+
function bold(text) {
|
|
26
|
+
return useColors ? `\x1b[1m${text}\x1b[22m` : text;
|
|
27
|
+
}
|
|
28
|
+
function yellow(text) {
|
|
29
|
+
return useColors ? `\x1b[33m${text}\x1b[39m` : text;
|
|
30
|
+
}
|
|
31
|
+
//# sourceMappingURL=style.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"style.js","sourceRoot":"","sources":["../../src/utils/style.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;GAeG;;;AAOH,oBAEC;AAED,wBAEC;AAXD,MAAM,SAAS,GACb,OAAO,OAAO,KAAK,WAAW;IAC9B,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,KAAK,SAAS;QACpC,CAAC,CAAC,CAAC,CAAA,MAAA,OAAO,CAAC,MAAM,0CAAE,KAAK,CAAA,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC;AAExD,SAAgB,IAAI,CAAC,IAAY;IAC/B,OAAO,SAAS,CAAC,CAAC,CAAC,UAAU,IAAI,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC;AACrD,CAAC;AAED,SAAgB,MAAM,CAAC,IAAY;IACjC,OAAO,SAAS,CAAC,CAAC,CAAC,WAAW,IAAI,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC;AACtD,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@firebase/api-documenter",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.6.0",
|
|
4
4
|
"description": "Read JSON files from api-extractor, generate documentation pages",
|
|
5
5
|
"repository": {
|
|
6
6
|
"directory": "repo-scripts/documenter",
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
"license": "Apache-2.0",
|
|
11
11
|
"scripts": {
|
|
12
12
|
"build": "tsc && gulp copy-resources",
|
|
13
|
-
"test": "
|
|
13
|
+
"test": "nyc --reporter lcovonly -- node test/run.js"
|
|
14
14
|
},
|
|
15
15
|
"bin": {
|
|
16
16
|
"api-documenter-fire": "dist/start.js"
|
|
@@ -21,22 +21,21 @@
|
|
|
21
21
|
"main": "dist/index.js",
|
|
22
22
|
"typings": "dist/rollup.d.ts",
|
|
23
23
|
"dependencies": {
|
|
24
|
-
"api-extractor-model
|
|
25
|
-
"@microsoft/tsdoc": "0.
|
|
26
|
-
"@rushstack/node-core-library": "
|
|
27
|
-
"@rushstack/ts-command-line": "
|
|
28
|
-
"colors": "~1.4.0",
|
|
29
|
-
"resolve": "~1.22.0",
|
|
24
|
+
"@microsoft/api-extractor-model": "7.33.11",
|
|
25
|
+
"@microsoft/tsdoc": "0.16.0",
|
|
26
|
+
"@rushstack/node-core-library": "5.24.0",
|
|
27
|
+
"@rushstack/ts-command-line": "5.3.13",
|
|
30
28
|
"tslib": "^2.1.0",
|
|
31
|
-
"js-yaml": "4.1
|
|
29
|
+
"js-yaml": "5.4.1"
|
|
32
30
|
},
|
|
33
31
|
"devDependencies": {
|
|
34
32
|
"@types/js-yaml": "4.0.9",
|
|
35
|
-
"
|
|
33
|
+
"gulp": "5.0.1",
|
|
36
34
|
"jest-resolve": "29.7.0",
|
|
37
35
|
"mocha-chai-jest-snapshot": "1.1.6"
|
|
38
36
|
},
|
|
39
37
|
"engines": {
|
|
40
|
-
"node": ">=
|
|
41
|
-
}
|
|
42
|
-
|
|
38
|
+
"node": ">=20.0.0"
|
|
39
|
+
},
|
|
40
|
+
"type": "commonjs"
|
|
41
|
+
}
|