@firebase/api-documenter 0.1.2-canary.d38eced3b → 0.1.2-canary.d6338f0af
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/plugin/PluginLoader.js +6 -3
- package/dist/plugin/PluginLoader.js.map +1 -1
- package/dist/toc.js +11 -0
- package/dist/toc.js.map +1 -1
- package/package.json +4 -4
|
@@ -26,6 +26,7 @@ const MarkdownDocumenterFeature_1 = require("./MarkdownDocumenterFeature");
|
|
|
26
26
|
const PluginFeature_1 = require("./PluginFeature");
|
|
27
27
|
class PluginLoader {
|
|
28
28
|
load(documenterConfig, createContext) {
|
|
29
|
+
var _a, _b, _c;
|
|
29
30
|
const configFileFolder = path.dirname(documenterConfig.configFilePath);
|
|
30
31
|
for (const configPlugin of documenterConfig.configFile.plugins || []) {
|
|
31
32
|
try {
|
|
@@ -71,7 +72,8 @@ class PluginLoader {
|
|
|
71
72
|
markdownDocumenterFeature = new featureDefinition.subclass(initialization);
|
|
72
73
|
}
|
|
73
74
|
catch (e) {
|
|
74
|
-
throw new Error(`Failed to construct feature subclass:\n` +
|
|
75
|
+
throw new Error(`Failed to construct feature subclass:\n` +
|
|
76
|
+
((_a = e) === null || _a === void 0 ? void 0 : _a.toString()));
|
|
75
77
|
}
|
|
76
78
|
if (!(markdownDocumenterFeature instanceof MarkdownDocumenterFeature_1.MarkdownDocumenterFeature)) {
|
|
77
79
|
throw new Error('The constructed subclass was not an instance of MarkdownDocumenterFeature');
|
|
@@ -81,7 +83,7 @@ class PluginLoader {
|
|
|
81
83
|
}
|
|
82
84
|
catch (e) {
|
|
83
85
|
throw new Error('Error occurred during the onInitialized() event: ' +
|
|
84
|
-
e.toString());
|
|
86
|
+
((_b = e) === null || _b === void 0 ? void 0 : _b.toString()));
|
|
85
87
|
}
|
|
86
88
|
this.markdownDocumenterFeature = markdownDocumenterFeature;
|
|
87
89
|
}
|
|
@@ -91,7 +93,8 @@ class PluginLoader {
|
|
|
91
93
|
}
|
|
92
94
|
}
|
|
93
95
|
catch (e) {
|
|
94
|
-
throw new Error(`Error loading plugin ${configPlugin.packageName}: ` +
|
|
96
|
+
throw new Error(`Error loading plugin ${configPlugin.packageName}: ` +
|
|
97
|
+
((_c = e) === null || _c === void 0 ? void 0 : _c.message));
|
|
95
98
|
}
|
|
96
99
|
}
|
|
97
100
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"PluginLoader.js","sourceRoot":"","sources":["../../src/plugin/PluginLoader.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;GAeG;;;;AAEH,4FAA4F;AAC5F,2DAA2D;AAE3D,mDAA6B;AAC7B,yDAAmC;AAMnC,2EAGqC;AACrC,mDAA8D;AAQ9D,MAAa,YAAY;IAGhB,IAAI,CACT,gBAAkC,EAClC,aAAqD
|
|
1
|
+
{"version":3,"file":"PluginLoader.js","sourceRoot":"","sources":["../../src/plugin/PluginLoader.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;GAeG;;;;AAEH,4FAA4F;AAC5F,2DAA2D;AAE3D,mDAA6B;AAC7B,yDAAmC;AAMnC,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;YACpE,IAAI;gBACF,iEAAiE;gBACjE,MAAM,sBAAsB,GAAW,OAAO,CAAC,IAAI,CACjD,YAAY,CAAC,WAAW,EACxB;oBACE,OAAO,EAAE,gBAAgB;iBAC1B,CACF,CAAC;gBAEF,mBAAmB;gBACnB,MAAM,UAAU,GAEA,OAAO,CAAC,sBAAsB,CAAC,CAAC;gBAEhD,IAAI,CAAC,UAAU,EAAE;oBACf,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC;iBACxC;gBAED,IAAI,CAAC,UAAU,CAAC,2BAA2B,EAAE;oBAC3C,MAAM,IAAI,KAAK,CACb,8CAA8C;wBAC5C,yDAAyD,CAC5D,CAAC;iBACH;gBAED,MAAM,QAAQ,GACZ,UAAU,CAAC,2BAA2B,CAAC;gBAEzC,IAAI,QAAQ,CAAC,eAAe,KAAK,IAAI,EAAE;oBACrC,MAAM,IAAI,KAAK,CACb,mEAAmE;wBACjE,8BAA8B,CACjC,CAAC;iBACH;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;oBACjD,wBAAwB,CAAC,GAAG,CAC1B,iBAAiB,CAAC,WAAW,EAC7B,iBAAiB,CAClB,CAAC;iBACH;gBAED,KAAK,MAAM,WAAW,IAAI,YAAY,CAAC,mBAAmB,EAAE;oBAC1D,MAAM,iBAAiB,GACrB,wBAAwB,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;oBAC5C,IAAI,CAAC,iBAAiB,EAAE;wBACtB,MAAM,IAAI,KAAK,CACb,cAAc,YAAY,CAAC,WAAW,uCAAuC,WAAW,GAAG,CAC5F,CAAC;qBACH;oBAED,IAAI,iBAAiB,CAAC,IAAI,KAAK,2BAA2B,EAAE;wBAC1D,IAAI,IAAI,CAAC,yBAAyB,EAAE;4BAClC,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAC;yBAClE;wBAED,MAAM,cAAc,GAClB,IAAI,2CAA2B,EAAE,CAAC;wBACpC,cAAc,CAAC,QAAQ,GAAG,aAAa,EAAE,CAAC;wBAE1C,IAAI,yBAAyB,GAEb,SAAS,CAAC;wBAC1B,IAAI;4BACF,yBAAyB,GAAG,IAAI,iBAAiB,CAAC,QAAQ,CACxD,cAAc,CACf,CAAC;yBACH;wBAAC,OAAO,CAAC,EAAE;4BACV,MAAM,IAAI,KAAK,CACb,yCAAyC;iCACvC,MAAC,CAAW,0CAAE,QAAQ,EAAE,CAAA,CAC3B,CAAC;yBACH;wBACD,IACE,CAAC,CAAC,yBAAyB,YAAY,qDAAyB,CAAC,EACjE;4BACA,MAAM,IAAI,KAAK,CACb,2EAA2E,CAC5E,CAAC;yBACH;wBAED,IAAI;4BACF,yBAAyB,CAAC,aAAa,EAAE,CAAC;yBAC3C;wBAAC,OAAO,CAAC,EAAE;4BACV,MAAM,IAAI,KAAK,CACb,mDAAmD;iCACjD,MAAC,CAAW,0CAAE,QAAQ,EAAE,CAAA,CAC3B,CAAC;yBACH;wBAED,IAAI,CAAC,yBAAyB,GAAG,yBAAyB,CAAC;qBAC5D;yBAAM;wBACL,MAAM,IAAI,KAAK,CACb,qCAAqC,iBAAiB,CAAC,IAAI,GAAG,CAC/D,CAAC;qBACH;iBACF;aACF;YAAC,OAAO,CAAC,EAAE;gBACV,MAAM,IAAI,KAAK,CACb,wBAAwB,YAAY,CAAC,WAAW,IAAI;qBAClD,MAAC,CAAW,0CAAE,OAAO,CAAA,CACxB,CAAC;aACH;SACF;IACH,CAAC;CACF;AA3HD,oCA2HC"}
|
package/dist/toc.js
CHANGED
|
@@ -48,6 +48,17 @@ function generateTocRecursively(apiItem, g3Path, addFileNameSuffix, toc) {
|
|
|
48
48
|
path: `${g3Path}/${MarkdownDocumenterHelpers_1.getFilenameForApiItem(apiItem, addFileNameSuffix)}`,
|
|
49
49
|
section: []
|
|
50
50
|
};
|
|
51
|
+
for (const member of apiItem.members) {
|
|
52
|
+
// only classes and interfaces have dedicated pages
|
|
53
|
+
if (member.kind === "Class" /* Class */ ||
|
|
54
|
+
member.kind === "Interface" /* Interface */) {
|
|
55
|
+
const fileName = MarkdownDocumenterHelpers_1.getFilenameForApiItem(member, addFileNameSuffix);
|
|
56
|
+
entryPointToc.section.push({
|
|
57
|
+
title: member.displayName,
|
|
58
|
+
path: `${g3Path}/${fileName}`
|
|
59
|
+
});
|
|
60
|
+
}
|
|
61
|
+
}
|
|
51
62
|
toc.push(entryPointToc);
|
|
52
63
|
}
|
|
53
64
|
else {
|
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;YACvB,OAAO,EAAE,EAAE;SACZ,CAAC;QACF,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;KACvB;IAED,sBAAsB,CAAC,QAAQ,EAAE,MAAM,EAAE,iBAAiB,EAAE,GAAG,CAAC,CAAC;IAEjE,kBAAa,CACX,cAAO,CAAC,YAAY,EAAE,UAAU,CAAC,EACjC,iBAAI,CAAC,IAAI,CACP,EAAE,GAAG,EAAE,EACP;QACE,WAAW,EAAE,GAAG;KACjB,CACF,CACF,CAAC;AACJ,CAAC;AA7BD,kCA6BC;AAED,SAAS,sBAAsB,CAC7B,OAAgB,EAChB,MAAc,EACd,iBAA0B,EAC1B,GAAe;IAEf,0CAA0C;IAC1C,IAAI,OAAO,CAAC,IAAI,kCAA2B,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,iDAAqB,CAAC,OAAO,EAAE,iBAAiB,CAAC,EAAE;YACtE,OAAO,EAAE,EAAE;SACZ,CAAC;QAEF,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"}
|
|
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;YACvB,OAAO,EAAE,EAAE;SACZ,CAAC;QACF,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;KACvB;IAED,sBAAsB,CAAC,QAAQ,EAAE,MAAM,EAAE,iBAAiB,EAAE,GAAG,CAAC,CAAC;IAEjE,kBAAa,CACX,cAAO,CAAC,YAAY,EAAE,UAAU,CAAC,EACjC,iBAAI,CAAC,IAAI,CACP,EAAE,GAAG,EAAE,EACP;QACE,WAAW,EAAE,GAAG;KACjB,CACF,CACF,CAAC;AACJ,CAAC;AA7BD,kCA6BC;AAED,SAAS,sBAAsB,CAC7B,OAAgB,EAChB,MAAc,EACd,iBAA0B,EAC1B,GAAe;IAEf,0CAA0C;IAC1C,IAAI,OAAO,CAAC,IAAI,kCAA2B,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,iDAAqB,CAAC,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,wBAAsB;gBACjC,MAAM,CAAC,IAAI,gCAA0B,EACrC;gBACA,MAAM,QAAQ,GAAG,iDAAqB,CAAC,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"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@firebase/api-documenter",
|
|
3
|
-
"version": "0.1.2-canary.
|
|
3
|
+
"version": "0.1.2-canary.d6338f0af",
|
|
4
4
|
"description": "Read JSON files from api-extractor, generate documentation pages",
|
|
5
5
|
"repository": {
|
|
6
6
|
"directory": "repo-scripts/documenter",
|
|
@@ -23,8 +23,8 @@
|
|
|
23
23
|
"dependencies": {
|
|
24
24
|
"api-extractor-model-me": "0.1.1",
|
|
25
25
|
"@microsoft/tsdoc": "0.12.24",
|
|
26
|
-
"@rushstack/node-core-library": "3.45.
|
|
27
|
-
"@rushstack/ts-command-line": "4.
|
|
26
|
+
"@rushstack/node-core-library": "3.45.5",
|
|
27
|
+
"@rushstack/ts-command-line": "4.11.0",
|
|
28
28
|
"colors": "~1.4.0",
|
|
29
29
|
"resolve": "~1.22.0",
|
|
30
30
|
"tslib": "^2.1.0",
|
|
@@ -32,7 +32,7 @@
|
|
|
32
32
|
},
|
|
33
33
|
"devDependencies": {
|
|
34
34
|
"@types/js-yaml": "4.0.5",
|
|
35
|
-
"@types/resolve": "1.20.
|
|
35
|
+
"@types/resolve": "1.20.2",
|
|
36
36
|
"mocha-chai-jest-snapshot": "1.1.3"
|
|
37
37
|
}
|
|
38
38
|
}
|