@firebase/api-documenter 0.2.1-canary.012fd763c → 0.3.0-canary.243e47d6f
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/CHANGELOG.md +3 -0
- package/dist/cli/TocAction.js +1 -1
- package/dist/cli/TocAction.js.map +1 -1
- package/dist/documenters/MarkdownDocumenter.js +81 -81
- package/dist/documenters/MarkdownDocumenter.js.map +1 -1
- package/dist/documenters/MarkdownDocumenterHelpers.js +25 -25
- package/dist/documenters/MarkdownDocumenterHelpers.js.map +1 -1
- package/dist/markdown/CustomMarkdownEmitter.js +4 -4
- 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 +12 -12
- package/dist/nodes/CustomDocNodeKind.js.map +1 -1
- package/dist/nodes/DocEmphasisSpan.js +1 -1
- package/dist/nodes/DocEmphasisSpan.js.map +1 -1
- package/dist/nodes/DocHeading.js +1 -1
- package/dist/nodes/DocHeading.js.map +1 -1
- package/dist/nodes/DocNoteBox.js +1 -1
- package/dist/nodes/DocNoteBox.js.map +1 -1
- package/dist/nodes/DocTable.js +1 -1
- package/dist/nodes/DocTable.js.map +1 -1
- package/dist/nodes/DocTableCell.js +1 -1
- package/dist/nodes/DocTableCell.js.map +1 -1
- package/dist/nodes/DocTableRow.js +1 -1
- package/dist/nodes/DocTableRow.js.map +1 -1
- package/dist/plugin/PluginLoader.js +3 -4
- package/dist/plugin/PluginLoader.js.map +1 -1
- package/dist/toc.js +6 -6
- package/dist/toc.js.map +1 -1
- package/dist/utils/test/IndentedWriter.test.js +8 -8
- package/dist/utils/test/IndentedWriter.test.js.map +1 -1
- package/package.json +2 -2
package/dist/toc.js
CHANGED
|
@@ -32,26 +32,26 @@ function generateToc({ apiModel, g3Path, outputFolder, addFileNameSuffix, jsSdk
|
|
|
32
32
|
toc.push(firebaseToc);
|
|
33
33
|
}
|
|
34
34
|
generateTocRecursively(apiModel, g3Path, addFileNameSuffix, toc);
|
|
35
|
-
fs_1.writeFileSync(path_1.resolve(outputFolder, 'toc.yaml'), js_yaml_1.default.dump({ toc }, {
|
|
35
|
+
(0, fs_1.writeFileSync)((0, path_1.resolve)(outputFolder, 'toc.yaml'), js_yaml_1.default.dump({ toc }, {
|
|
36
36
|
quotingType: '"'
|
|
37
37
|
}));
|
|
38
38
|
}
|
|
39
39
|
exports.generateToc = generateToc;
|
|
40
40
|
function generateTocRecursively(apiItem, g3Path, addFileNameSuffix, toc) {
|
|
41
41
|
// generate toc item only for entry points
|
|
42
|
-
if (apiItem.kind === "EntryPoint" /* EntryPoint */) {
|
|
42
|
+
if (apiItem.kind === "EntryPoint" /* ApiItemKind.EntryPoint */) {
|
|
43
43
|
// Entry point
|
|
44
44
|
const entryPointName = apiItem.canonicalReference.source.escapedPath.replace('@firebase/', '');
|
|
45
45
|
const entryPointToc = {
|
|
46
46
|
title: entryPointName,
|
|
47
|
-
path: `${g3Path}/${MarkdownDocumenterHelpers_1.getFilenameForApiItem(apiItem, addFileNameSuffix)}`,
|
|
47
|
+
path: `${g3Path}/${(0, MarkdownDocumenterHelpers_1.getFilenameForApiItem)(apiItem, addFileNameSuffix)}`,
|
|
48
48
|
section: []
|
|
49
49
|
};
|
|
50
50
|
for (const member of apiItem.members) {
|
|
51
51
|
// only classes and interfaces have dedicated pages
|
|
52
|
-
if (member.kind === "Class" /* Class */ ||
|
|
53
|
-
member.kind === "Interface" /* Interface */) {
|
|
54
|
-
const fileName = MarkdownDocumenterHelpers_1.getFilenameForApiItem(member, addFileNameSuffix);
|
|
52
|
+
if (member.kind === "Class" /* ApiItemKind.Class */ ||
|
|
53
|
+
member.kind === "Interface" /* ApiItemKind.Interface */) {
|
|
54
|
+
const fileName = (0, MarkdownDocumenterHelpers_1.getFilenameForApiItem)(member, addFileNameSuffix);
|
|
55
55
|
entryPointToc.section.push({
|
|
56
56
|
title: member.displayName,
|
|
57
57
|
path: `${g3Path}/${fileName}`
|
package/dist/toc.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"toc.js","sourceRoot":"","sources":["../src/toc.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;GAeG;;;;AAEH,8DAA2B;AAE3B,uFAAgF;AAEhF,2BAAmC;AACnC,+BAA+B;AAgB/B,SAAgB,WAAW,CAAC,EAC1B,QAAQ,EACR,MAAM,EACN,YAAY,EACZ,iBAAiB,EACjB,KAAK,EACiB;IACtB,MAAM,GAAG,GAAG,EAAE,CAAC;IAEf,IAAI,KAAK,EAAE;QACT,MAAM,WAAW,GAAa;YAC5B,KAAK,EAAE,UAAU;YACjB,IAAI,EAAE,GAAG,MAAM,QAAQ;SACxB,CAAC;QACF,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;KACvB;IAED,sBAAsB,CAAC,QAAQ,EAAE,MAAM,EAAE,iBAAiB,EAAE,GAAG,CAAC,CAAC;IAEjE,kBAAa,
|
|
1
|
+
{"version":3,"file":"toc.js","sourceRoot":"","sources":["../src/toc.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;GAeG;;;;AAEH,8DAA2B;AAE3B,uFAAgF;AAEhF,2BAAmC;AACnC,+BAA+B;AAgB/B,SAAgB,WAAW,CAAC,EAC1B,QAAQ,EACR,MAAM,EACN,YAAY,EACZ,iBAAiB,EACjB,KAAK,EACiB;IACtB,MAAM,GAAG,GAAG,EAAE,CAAC;IAEf,IAAI,KAAK,EAAE;QACT,MAAM,WAAW,GAAa;YAC5B,KAAK,EAAE,UAAU;YACjB,IAAI,EAAE,GAAG,MAAM,QAAQ;SACxB,CAAC;QACF,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;KACvB;IAED,sBAAsB,CAAC,QAAQ,EAAE,MAAM,EAAE,iBAAiB,EAAE,GAAG,CAAC,CAAC;IAEjE,IAAA,kBAAa,EACX,IAAA,cAAO,EAAC,YAAY,EAAE,UAAU,CAAC,EACjC,iBAAI,CAAC,IAAI,CACP,EAAE,GAAG,EAAE,EACP;QACE,WAAW,EAAE,GAAG;KACjB,CACF,CACF,CAAC;AACJ,CAAC;AA5BD,kCA4BC;AAED,SAAS,sBAAsB,CAC7B,OAAgB,EAChB,MAAc,EACd,iBAA0B,EAC1B,GAAe;IAEf,0CAA0C;IAC1C,IAAI,OAAO,CAAC,IAAI,8CAA2B,EAAE;QAC3C,cAAc;QACd,MAAM,cAAc,GAClB,OAAO,CAAC,kBAAkB,CAAC,MAC5B,CAAC,WAAW,CAAC,OAAO,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC;QACxC,MAAM,aAAa,GAAa;YAC9B,KAAK,EAAE,cAAc;YACrB,IAAI,EAAE,GAAG,MAAM,IAAI,IAAA,iDAAqB,EAAC,OAAO,EAAE,iBAAiB,CAAC,EAAE;YACtE,OAAO,EAAE,EAAE;SACZ,CAAC;QAEF,KAAK,MAAM,MAAM,IAAI,OAAO,CAAC,OAAO,EAAE;YACpC,mDAAmD;YACnD,IACE,MAAM,CAAC,IAAI,oCAAsB;gBACjC,MAAM,CAAC,IAAI,4CAA0B,EACrC;gBACA,MAAM,QAAQ,GAAG,IAAA,iDAAqB,EAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC;gBAClE,aAAa,CAAC,OAAQ,CAAC,IAAI,CAAC;oBAC1B,KAAK,EAAE,MAAM,CAAC,WAAW;oBACzB,IAAI,EAAE,GAAG,MAAM,IAAI,QAAQ,EAAE;iBAC9B,CAAC,CAAC;aACJ;SACF;QAED,GAAG,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;KACzB;SAAM;QACL,mDAAmD;QACnD,KAAK,MAAM,MAAM,IAAI,OAAO,CAAC,OAAO,EAAE;YACpC,sBAAsB,CAAC,MAAM,EAAE,MAAM,EAAE,iBAAiB,EAAE,GAAG,CAAC,CAAC;SAChE;KACF;AACH,CAAC"}
|
|
@@ -21,7 +21,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
21
21
|
const IndentedWriter_1 = require("../IndentedWriter");
|
|
22
22
|
const chai_1 = require("chai");
|
|
23
23
|
const mocha_chai_jest_snapshot_1 = require("mocha-chai-jest-snapshot");
|
|
24
|
-
chai_1.use(mocha_chai_jest_snapshot_1.jestSnapshotPlugin());
|
|
24
|
+
(0, chai_1.use)((0, mocha_chai_jest_snapshot_1.jestSnapshotPlugin)());
|
|
25
25
|
it('01 Demo from docs', () => {
|
|
26
26
|
const indentedWriter = new IndentedWriter_1.IndentedWriter();
|
|
27
27
|
indentedWriter.write('begin\n');
|
|
@@ -31,7 +31,7 @@ it('01 Demo from docs', () => {
|
|
|
31
31
|
indentedWriter.increaseIndent();
|
|
32
32
|
indentedWriter.decreaseIndent();
|
|
33
33
|
indentedWriter.write('end');
|
|
34
|
-
chai_1.expect(indentedWriter.toString()).toMatchSnapshot();
|
|
34
|
+
(0, chai_1.expect)(indentedWriter.toString()).toMatchSnapshot();
|
|
35
35
|
});
|
|
36
36
|
it('02 Indent something', () => {
|
|
37
37
|
const indentedWriter = new IndentedWriter_1.IndentedWriter();
|
|
@@ -47,7 +47,7 @@ it('02 Indent something', () => {
|
|
|
47
47
|
indentedWriter.writeLine();
|
|
48
48
|
indentedWriter.writeLine('g');
|
|
49
49
|
indentedWriter.decreaseIndent();
|
|
50
|
-
chai_1.expect(indentedWriter.toString()).toMatchSnapshot();
|
|
50
|
+
(0, chai_1.expect)(indentedWriter.toString()).toMatchSnapshot();
|
|
51
51
|
});
|
|
52
52
|
it('03 Two kinds of indents', () => {
|
|
53
53
|
const indentedWriter = new IndentedWriter_1.IndentedWriter();
|
|
@@ -60,28 +60,28 @@ it('03 Two kinds of indents', () => {
|
|
|
60
60
|
indentedWriter.write('e\n');
|
|
61
61
|
}, '> ');
|
|
62
62
|
indentedWriter.writeLine('---');
|
|
63
|
-
chai_1.expect(indentedWriter.toString()).toMatchSnapshot();
|
|
63
|
+
(0, chai_1.expect)(indentedWriter.toString()).toMatchSnapshot();
|
|
64
64
|
});
|
|
65
65
|
it('04 Edge cases for ensureNewLine()', () => {
|
|
66
66
|
let indentedWriter = new IndentedWriter_1.IndentedWriter();
|
|
67
67
|
indentedWriter.ensureNewLine();
|
|
68
68
|
indentedWriter.write('line');
|
|
69
|
-
chai_1.expect(indentedWriter.toString()).toMatchSnapshot();
|
|
69
|
+
(0, chai_1.expect)(indentedWriter.toString()).toMatchSnapshot();
|
|
70
70
|
indentedWriter = new IndentedWriter_1.IndentedWriter();
|
|
71
71
|
indentedWriter.write('previous');
|
|
72
72
|
indentedWriter.ensureNewLine();
|
|
73
73
|
indentedWriter.write('line');
|
|
74
|
-
chai_1.expect(indentedWriter.toString()).toMatchSnapshot();
|
|
74
|
+
(0, chai_1.expect)(indentedWriter.toString()).toMatchSnapshot();
|
|
75
75
|
});
|
|
76
76
|
it('04 Edge cases for ensureSkippedLine()', () => {
|
|
77
77
|
let indentedWriter = new IndentedWriter_1.IndentedWriter();
|
|
78
78
|
indentedWriter.ensureSkippedLine();
|
|
79
79
|
indentedWriter.write('line');
|
|
80
|
-
chai_1.expect(indentedWriter.toString()).toMatchSnapshot();
|
|
80
|
+
(0, chai_1.expect)(indentedWriter.toString()).toMatchSnapshot();
|
|
81
81
|
indentedWriter = new IndentedWriter_1.IndentedWriter();
|
|
82
82
|
indentedWriter.write('previous');
|
|
83
83
|
indentedWriter.ensureSkippedLine();
|
|
84
84
|
indentedWriter.write('line');
|
|
85
|
-
chai_1.expect(indentedWriter.toString()).toMatchSnapshot();
|
|
85
|
+
(0, chai_1.expect)(indentedWriter.toString()).toMatchSnapshot();
|
|
86
86
|
});
|
|
87
87
|
//# sourceMappingURL=IndentedWriter.test.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"IndentedWriter.test.js","sourceRoot":"","sources":["../../../src/utils/test/IndentedWriter.test.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;GAeG;;AAEH,4FAA4F;AAC5F,2DAA2D;AAE3D,sDAAmD;AACnD,+BAAmC;AACnC,uEAA8D;AAE9D,UAAG,
|
|
1
|
+
{"version":3,"file":"IndentedWriter.test.js","sourceRoot":"","sources":["../../../src/utils/test/IndentedWriter.test.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;GAeG;;AAEH,4FAA4F;AAC5F,2DAA2D;AAE3D,sDAAmD;AACnD,+BAAmC;AACnC,uEAA8D;AAE9D,IAAA,UAAG,EAAC,IAAA,6CAAkB,GAAE,CAAC,CAAC;AAE1B,EAAE,CAAC,mBAAmB,EAAE,GAAG,EAAE;IAC3B,MAAM,cAAc,GAAmB,IAAI,+BAAc,EAAE,CAAC;IAC5D,cAAc,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;IAChC,cAAc,CAAC,cAAc,EAAE,CAAC;IAChC,cAAc,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;IACnC,cAAc,CAAC,cAAc,EAAE,CAAC;IAChC,cAAc,CAAC,cAAc,EAAE,CAAC;IAChC,cAAc,CAAC,cAAc,EAAE,CAAC;IAChC,cAAc,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IAE5B,IAAA,aAAM,EAAC,cAAc,CAAC,QAAQ,EAAE,CAAC,CAAC,eAAe,EAAE,CAAC;AACtD,CAAC,CAAC,CAAC;AAEH,EAAE,CAAC,qBAAqB,EAAE,GAAG,EAAE;IAC7B,MAAM,cAAc,GAAmB,IAAI,+BAAc,EAAE,CAAC;IAC5D,cAAc,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAC1B,cAAc,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAC1B,cAAc,CAAC,cAAc,EAAE,CAAC;IAChC,cAAc,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;IAC9B,cAAc,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;IAC9B,cAAc,CAAC,cAAc,EAAE,CAAC;IAChC,cAAc,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;IAE9B,cAAc,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;IACtC,cAAc,CAAC,SAAS,EAAE,CAAC;IAC3B,cAAc,CAAC,SAAS,EAAE,CAAC;IAC3B,cAAc,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;IAC9B,cAAc,CAAC,cAAc,EAAE,CAAC;IAEhC,IAAA,aAAM,EAAC,cAAc,CAAC,QAAQ,EAAE,CAAC,CAAC,eAAe,EAAE,CAAC;AACtD,CAAC,CAAC,CAAC;AAEH,EAAE,CAAC,yBAAyB,EAAE,GAAG,EAAE;IACjC,MAAM,cAAc,GAAmB,IAAI,+BAAc,EAAE,CAAC;IAE5D,cAAc,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;IAChC,cAAc,CAAC,WAAW,CAAC,GAAG,EAAE;QAC9B,cAAc,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAC7B,cAAc,CAAC,WAAW,CAAC,GAAG,EAAE;YAC9B,cAAc,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QACjC,CAAC,CAAC,CAAC;QACH,cAAc,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IAC9B,CAAC,EAAE,IAAI,CAAC,CAAC;IACT,cAAc,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;IAEhC,IAAA,aAAM,EAAC,cAAc,CAAC,QAAQ,EAAE,CAAC,CAAC,eAAe,EAAE,CAAC;AACtD,CAAC,CAAC,CAAC;AAEH,EAAE,CAAC,mCAAmC,EAAE,GAAG,EAAE;IAC3C,IAAI,cAAc,GAAmB,IAAI,+BAAc,EAAE,CAAC;IAC1D,cAAc,CAAC,aAAa,EAAE,CAAC;IAC/B,cAAc,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IAC7B,IAAA,aAAM,EAAC,cAAc,CAAC,QAAQ,EAAE,CAAC,CAAC,eAAe,EAAE,CAAC;IAEpD,cAAc,GAAG,IAAI,+BAAc,EAAE,CAAC;IACtC,cAAc,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IACjC,cAAc,CAAC,aAAa,EAAE,CAAC;IAC/B,cAAc,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IAC7B,IAAA,aAAM,EAAC,cAAc,CAAC,QAAQ,EAAE,CAAC,CAAC,eAAe,EAAE,CAAC;AACtD,CAAC,CAAC,CAAC;AAEH,EAAE,CAAC,uCAAuC,EAAE,GAAG,EAAE;IAC/C,IAAI,cAAc,GAAmB,IAAI,+BAAc,EAAE,CAAC;IAC1D,cAAc,CAAC,iBAAiB,EAAE,CAAC;IACnC,cAAc,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IAC7B,IAAA,aAAM,EAAC,cAAc,CAAC,QAAQ,EAAE,CAAC,CAAC,eAAe,EAAE,CAAC;IAEpD,cAAc,GAAG,IAAI,+BAAc,EAAE,CAAC;IACtC,cAAc,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IACjC,cAAc,CAAC,iBAAiB,EAAE,CAAC;IACnC,cAAc,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IAC7B,IAAA,aAAM,EAAC,cAAc,CAAC,QAAQ,EAAE,CAAC,CAAC,eAAe,EAAE,CAAC;AACtD,CAAC,CAAC,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@firebase/api-documenter",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.3.0-canary.243e47d6f",
|
|
4
4
|
"description": "Read JSON files from api-extractor, generate documentation pages",
|
|
5
5
|
"repository": {
|
|
6
6
|
"directory": "repo-scripts/documenter",
|
|
@@ -24,7 +24,7 @@
|
|
|
24
24
|
"api-extractor-model-me": "0.1.1",
|
|
25
25
|
"@microsoft/tsdoc": "0.12.24",
|
|
26
26
|
"@rushstack/node-core-library": "3.45.5",
|
|
27
|
-
"@rushstack/ts-command-line": "4.
|
|
27
|
+
"@rushstack/ts-command-line": "4.13.0",
|
|
28
28
|
"colors": "~1.4.0",
|
|
29
29
|
"resolve": "~1.22.0",
|
|
30
30
|
"tslib": "^2.1.0",
|