@appium/docutils 0.3.13 → 0.4.1
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/bin/appium-docs.js +2 -0
- package/build/lib/builder/deploy.d.ts.map +1 -1
- package/build/lib/builder/deploy.js +15 -11
- package/build/lib/builder/deploy.js.map +1 -1
- package/build/lib/builder/nav.d.ts.map +1 -1
- package/build/lib/builder/nav.js +11 -5
- package/build/lib/builder/nav.js.map +1 -1
- package/build/lib/cli/check.d.ts.map +1 -1
- package/build/lib/cli/check.js +1 -1
- package/build/lib/cli/check.js.map +1 -1
- package/build/lib/cli/command/build.d.ts +4 -3
- package/build/lib/cli/command/build.d.ts.map +1 -1
- package/build/lib/cli/command/build.js +4 -3
- package/build/lib/cli/command/build.js.map +1 -1
- package/build/lib/cli/command/init.d.ts +22 -0
- package/build/lib/cli/command/init.d.ts.map +1 -1
- package/build/lib/cli/command/init.js +22 -0
- package/build/lib/cli/command/init.js.map +1 -1
- package/build/lib/cli/index.d.ts +2 -2
- package/build/lib/cli/index.d.ts.map +1 -1
- package/build/lib/cli/index.js +22 -3
- package/build/lib/cli/index.js.map +1 -1
- package/build/lib/fs.d.ts +4 -0
- package/build/lib/fs.d.ts.map +1 -1
- package/build/lib/fs.js +29 -1
- package/build/lib/fs.js.map +1 -1
- package/build/lib/init.d.ts +24 -10
- package/build/lib/init.d.ts.map +1 -1
- package/build/lib/init.js +31 -2
- package/build/lib/init.js.map +1 -1
- package/build/lib/scaffold.d.ts +1 -1
- package/build/lib/scaffold.d.ts.map +1 -1
- package/build/lib/scaffold.js +11 -3
- package/build/lib/scaffold.js.map +1 -1
- package/lib/builder/deploy.ts +17 -12
- package/lib/builder/nav.ts +11 -9
- package/lib/cli/check.ts +4 -1
- package/lib/cli/command/build.ts +4 -3
- package/lib/cli/command/init.ts +22 -0
- package/lib/cli/index.ts +27 -4
- package/lib/fs.ts +30 -0
- package/lib/init.ts +49 -2
- package/lib/scaffold.ts +11 -4
- package/package.json +7 -7
- package/requirements.txt +1 -1
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../lib/cli/index.ts"],"names":[],"mappings":";;AACA,+BAA+B;;;;;;AAE/B;;;GAGG;AAEH,sCAAoC;AAEpC,oDAAuB;AACvB,2CAAsC;AACtC,wDAAgC;AAChC,4CAAsE;AACtE,oCAAuC;AACvC,uCAAgD;AAChD,qCAAoC;
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../lib/cli/index.ts"],"names":[],"mappings":";;AACA,+BAA+B;;;;;;AAE/B;;;GAGG;AAEH,sCAAoC;AAEpC,6CAAmC;AACnC,oDAAuB;AACvB,uCAAyC;AACzC,2CAAsC;AACtC,wDAAgC;AAChC,4CAAsE;AACtE,oCAAuC;AACvC,uCAAgD;AAChD,qCAAoC;AAEpC,MAAM,GAAG,GAAG,IAAA,eAAO,EAAC,EAAC,GAAG,EAAE,YAAE,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAC,CAAC,CAAC;AACnD,MAAM,GAAG,GAAG,IAAA,kBAAS,EAAC,KAAK,CAAC,CAAC;AAC7B,MAAM,yBAAyB,GAAG,6CAA6C,CAAC;AAEzE,KAAK,UAAU,IAAI,CAAC,IAAI,GAAG,IAAA,iBAAO,EAAC,OAAO,CAAC,IAAI,CAAC;IACrD,MAAM,MAAM,GAAG,MAAM,IAAA,mBAAU,EAAC,IAAI,CAAC,CAAC;IAEtC,MAAM,CAAC,GAAG,IAAA,eAAK,EAAC,IAAI,CAAC,CAAC;IACtB,OAAO,MAAM,CAAC;SACX,UAAU,CAAC,oBAAQ,CAAC;SACpB,OAAO,CAAC,eAAK,CAAC;SACd,OAAO,CAAC,cAAI,CAAC;SACb,OAAO,CAAC,kBAAQ,CAAC;SACjB,OAAO,CAAC;QACP,OAAO,EAAE;YACP,IAAI,EAAE,SAAS;YACf,QAAQ,EAAE,6BAA6B;SACxC;QACD,WAAW,EAAE;YACX,KAAK,EAAE,GAAG;YACV,OAAO,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,CAAC;YACrD,QAAQ,EAAE,oBAAoB;YAC9B,OAAO,EAAE,6BAAiB;YAC1B,MAAM,EAAE,gBAAC,CAAC,QAAmD;SAC9D;QACD,MAAM,EAAE;YACN,KAAK,EAAE,GAAG;YACV,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,qBAAqB;YAC/B,SAAS,EAAE,IAAI;YACf,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,IAAI;YACjB,kBAAkB,EAAE,4BAA4B;SACjD;QACD,WAAW,EAAE;YACX,IAAI,EAAE,SAAS;YACf,QAAQ,EAAE,+BAA+B;SAC1C;KACF,CAAC;SACD,UAAU;IACT;;OAEG;IACH,GAAG,EAAE;QACH,GAAG,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC,IAAI,OAAO,GAAG,CAAC,OAAO,aAAa,OAAO,CAAC,OAAO,GAAG,CAAC,CAAC;IACzE,CAAC,CACF;SACA,MAAM,CAAC,yBAAyB,GAAG,CAAC,IAAI,EAAE,GAAG,EAAE,CAAC;SAChD,IAAI;IACH;;OAEG;IACH,CAAC,GAAkB,EAAE,KAAK,EAAE,EAAE;QAC5B;;;;;;WAMG;QACH,MAAM,wBAAwB,GAAG,CAAC,GAAkB,EAAW,EAAE;YAC/D,IAAI,KAA0C,CAAC;YAC/C,IAAI,CAAC,CAAC,KAAK,GAAG,GAAG,EAAE,KAAK,CAAC,yBAAyB,CAAC,CAAC,EAAE;gBACpD,OAAO,KAAK,CAAC;aACd;YACD,MAAM,CAAC,EAAE,GAAG,EAAE,UAAU,CAAC,GAAG,KAAK,CAAC;YAClC,GAAG,CAAC,KAAK,CACP,eAAe,GAAG,iBAAiB,UAAU,mBAAmB,GAAG,6BAA6B,CACjG,CAAC;YACF,OAAO,IAAI,CAAC;QACd,CAAC,CAAC;QAEF,8DAA8D;QAC9D,IAAI,KAAK,YAAY,qBAAa,EAAE;YAClC,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;SAC1B;aAAM;YACL,CAAC,CAAC,QAAQ,EAAE,CAAC;YAEb,IAAI,CAAC,wBAAwB,CAAC,GAAG,CAAC,EAAE;gBAClC,GAAG,CAAC,KAAK,CAAC,OAAO,GAAG,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;aAC1C;SACF;QACD,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;IACnB,CAAC,CACF;SACA,MAAM,CAAC,MAAM,CAAC;QACf,qEAAqE;SACpE,aAAa,CAAC,CAAC,CAAC;QACjB,gDAAgD;SAC/C,MAAM,EAAE;SACR,UAAU,EAAE,CAAC;AAClB,CAAC;AAvFD,oBAuFC;AAED,IAAI,OAAO,CAAC,IAAI,KAAK,MAAM,EAAE;IAC3B,2FAA2F;IAC3F,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;QACnB,GAAG,CAAC,KAAK,CAAC,gEAAgE,EAAE,GAAG,CAAC,CAAC;IACnF,CAAC,CAAC,CAAC;CACJ"}
|
package/build/lib/fs.d.ts
CHANGED
|
@@ -108,6 +108,10 @@ export declare function safeWriteFile(filepath: string, content: JsonValue, over
|
|
|
108
108
|
* Finds `npm` executable
|
|
109
109
|
*/
|
|
110
110
|
export declare const whichNpm: () => Promise<string>;
|
|
111
|
+
/**
|
|
112
|
+
* `mike` cannot be invoked via `python -m`, so we need to find the script.
|
|
113
|
+
*/
|
|
114
|
+
export declare const findMike: () => Promise<string | undefined>;
|
|
111
115
|
/**
|
|
112
116
|
* Finds the `typedoc` executable.
|
|
113
117
|
*
|
package/build/lib/fs.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"fs.d.ts","sourceRoot":"","sources":["../../lib/fs.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAKH,OAAO,CAAC,MAAM,QAAQ,CAAC;AAGvB,OAAgB,EAAC,qBAAqB,EAAE,WAAW,EAAC,MAAM,UAAU,CAAC;AACrE,OAAO,EAAC,SAAS,EAAC,MAAM,WAAW,CAAC;
|
|
1
|
+
{"version":3,"file":"fs.d.ts","sourceRoot":"","sources":["../../lib/fs.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAKH,OAAO,CAAC,MAAM,QAAQ,CAAC;AAGvB,OAAgB,EAAC,qBAAqB,EAAE,WAAW,EAAC,MAAM,UAAU,CAAC;AACrE,OAAO,EAAC,SAAS,EAAC,MAAM,WAAW,CAAC;AAcpC,OAAO,EAAC,SAAS,EAAC,MAAM,SAAS,CAAC;AAKlC;;;;GAIG;AACH,eAAO,MAAM,UAAU;;;sBAAqB,CAAC;AAE7C;;;;GAIG;AACH,eAAO,MAAM,aAAa,EAAE,CAAC,KAAK,EAAE,SAAS,KAAK,MAIjD,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,cAAc,EAAE,CAAC,KAAK,EAAE,SAAS,KAAK,MAEjD,CAAC;AAEH;;;;GAIG;AACH,eAAO,MAAM,aAAa,EAAE,CAAC,KAAK,EAAE,SAAS,KAAK,MAIjD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,QAAQ,cAA8B,MAAM,uCAKxD,CAAC;AAEF;;;;;;GAMG;AACH,wBAAsB,YAAY,CAChC,QAAQ,EAAE,MAAM,EAChB,GAAG,SAAgB,GAClB,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAM7B;AAED;;;;;;GAMG;AACH,eAAO,MAAM,mBAAmB,mEAI9B,CAAC;AAEH;;;;;;GAMG;AACH,eAAO,MAAM,aAAa,kFAAsD,CAAC;AAEjF;;;;;GAKG;AACH,iBAAe,YAAY,CACzB,GAAG,EAAE,MAAM,EACX,SAAS,EAAE,IAAI,GACd,OAAO,CAAC;IAAC,OAAO,EAAE,MAAM,CAAC;IAAC,GAAG,EAAE,qBAAqB,CAAA;CAAC,CAAC,CAAC;AAC1D,iBAAe,YAAY,CACzB,GAAG,EAAE,MAAM,EACX,SAAS,CAAC,EAAE,KAAK,GAChB,OAAO,CAAC;IAAC,OAAO,EAAE,MAAM,CAAC;IAAC,GAAG,EAAE,WAAW,CAAA;CAAC,CAAC,CAAC;AAsBhD;;GAEG;AACH,eAAO,MAAM,eAAe,0CAA0B,CAAC;AAEvD;;;;;GAKG;AACH,eAAO,MAAM,eAAe,qBAA+B,MAAM,8EAO/D,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,SAAS,mCACkB,MAAM,qCAE7C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,QAAQ,mCACmB,MAAM,qCAE7C,CAAC;AAEF;;;;;;;GAOG;AACH,wBAAgB,aAAa,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,SAAS,UAAQ,iBAMpF;AAOD;;GAEG;AACH,eAAO,MAAM,QAAQ,uBAAoD,CAAC;AAiB1E;;GAEG;AACH,eAAO,MAAM,QAAQ,mCAuBnB,CAAC;AAEH;;;;GAIG;AACH,eAAO,MAAM,WAAW,kBAA0C,QAAQ,MAAM,GAAG,SAAS,CAAC,sBAM3F,CAAC;AAEH;;;;GAIG;AACH,eAAO,MAAM,UAAU,SACX,QAAQ,MAAM,GAAG,SAAS,CAAC,sBACtC,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,aAAa,cACP,MAAM,gBAAwB,QAAQ,SAAS,CAAC,sBAyBlE,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,UAAU,aAA6B,MAAM,KAAG,QAAQ,MAAM,EAAE,CAAC,sBAM5E,CAAC"}
|
package/build/lib/fs.js
CHANGED
|
@@ -30,7 +30,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
|
30
30
|
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
31
31
|
};
|
|
32
32
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
33
|
-
exports.findDirsIn = exports.readMkDocsYml = exports.findPython = exports.findTypeDoc = exports.whichNpm = exports.safeWriteFile = exports.readJson = exports.readJson5 = exports.readTypedocJson = exports.readPackageJson = exports.findMkDocsYml = exports.findTypeDocJsonPath = exports.findInPkgDir = exports.readYaml = exports.stringifyJson = exports.stringifyJson5 = exports.stringifyYaml = exports.findPkgDir = void 0;
|
|
33
|
+
exports.findDirsIn = exports.readMkDocsYml = exports.findPython = exports.findTypeDoc = exports.findMike = exports.whichNpm = exports.safeWriteFile = exports.readJson = exports.readJson5 = exports.readTypedocJson = exports.readPackageJson = exports.findMkDocsYml = exports.findTypeDocJsonPath = exports.findInPkgDir = exports.readYaml = exports.stringifyJson = exports.stringifyJson5 = exports.stringifyYaml = exports.findPkgDir = void 0;
|
|
34
34
|
const support_1 = require("@appium/support");
|
|
35
35
|
const find_up_1 = __importDefault(require("find-up"));
|
|
36
36
|
const JSON5 = __importStar(require("json5"));
|
|
@@ -43,6 +43,7 @@ const yaml_1 = __importDefault(require("yaml"));
|
|
|
43
43
|
const constants_1 = require("./constants");
|
|
44
44
|
const error_1 = require("./error");
|
|
45
45
|
const logger_1 = require("./logger");
|
|
46
|
+
const teen_process_1 = require("teen_process");
|
|
46
47
|
const log = (0, logger_1.getLogger)('fs');
|
|
47
48
|
/**
|
|
48
49
|
* Finds path to closest `package.json`
|
|
@@ -191,6 +192,33 @@ const whichPython3 = lodash_1.default.partial(cachedWhich, `${constants_1.NAME_P
|
|
|
191
192
|
* Finds `typedoc` executable
|
|
192
193
|
*/
|
|
193
194
|
const whichTypeDoc = lodash_1.default.partial(cachedWhich, constants_1.NAME_TYPEDOC, { nothrow: true });
|
|
195
|
+
/**
|
|
196
|
+
* `mike` cannot be invoked via `python -m`, so we need to find the script.
|
|
197
|
+
*/
|
|
198
|
+
exports.findMike = lodash_1.default.partial(async () => {
|
|
199
|
+
// see if it's in PATH
|
|
200
|
+
let mikePath = await cachedWhich(constants_1.NAME_MIKE, { nothrow: true });
|
|
201
|
+
if (mikePath) {
|
|
202
|
+
return mikePath;
|
|
203
|
+
}
|
|
204
|
+
// if it isn't, it may be in a user dir
|
|
205
|
+
const pythonPath = await (0, exports.findPython)();
|
|
206
|
+
if (!pythonPath) {
|
|
207
|
+
return;
|
|
208
|
+
}
|
|
209
|
+
try {
|
|
210
|
+
// the user dir can be found this way.
|
|
211
|
+
// usually it's something like ~/.local
|
|
212
|
+
const { stdout } = await (0, teen_process_1.exec)(pythonPath, ['-m', 'site', '--user-base']);
|
|
213
|
+
if (stdout) {
|
|
214
|
+
mikePath = node_path_1.default.join(stdout.trim(), 'bin', 'mike');
|
|
215
|
+
if (await support_1.fs.isExecutable(mikePath)) {
|
|
216
|
+
return mikePath;
|
|
217
|
+
}
|
|
218
|
+
}
|
|
219
|
+
}
|
|
220
|
+
catch { }
|
|
221
|
+
});
|
|
194
222
|
/**
|
|
195
223
|
* Finds the `typedoc` executable.
|
|
196
224
|
*
|
package/build/lib/fs.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"fs.js","sourceRoot":"","sources":["../../lib/fs.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,6CAAmC;AACnC,sDAA6B;AAC7B,6CAA+B;AAC/B,oDAAuB;AACvB,0DAA6B;AAC7B,sDAA8B;AAC9B,wDAAqE;AAErE,qCAAmD;AACnD,gDAAwB;AACxB,
|
|
1
|
+
{"version":3,"file":"fs.js","sourceRoot":"","sources":["../../lib/fs.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,6CAAmC;AACnC,sDAA6B;AAC7B,6CAA+B;AAC/B,oDAAuB;AACvB,0DAA6B;AAC7B,sDAA8B;AAC9B,wDAAqE;AAErE,qCAAmD;AACnD,gDAAwB;AACxB,2CAQqB;AACrB,mCAAsC;AACtC,qCAAmC;AAEnC,+CAAoC;AAEpC,MAAM,GAAG,GAAG,IAAA,kBAAS,EAAC,IAAI,CAAC,CAAC;AAE5B;;;;GAIG;AACU,QAAA,UAAU,GAAG,gBAAC,CAAC,OAAO,CAAC,iBAAO,CAAC,CAAC;AAE7C;;;;GAIG;AACU,QAAA,aAAa,GAAiC,gBAAC,CAAC,YAAY,CACvE,cAAI,CAAC,SAAS,EACd,EAAC,MAAM,EAAE,CAAC,EAAC,EACX,SAAS,CACV,CAAC;AAEF;;;;;GAKG;AACU,QAAA,cAAc,GAAiC,gBAAC,CAAC,YAAY,CAAC,KAAK,CAAC,SAAS,EAAE;IAC1F,MAAM,EAAE,CAAC;CACV,CAAC,CAAC;AAEH;;;;GAIG;AACU,QAAA,aAAa,GAAiC,gBAAC,CAAC,YAAY,CACvE,IAAI,CAAC,SAAS,EACd,CAAC,EACD,SAAS,CACV,CAAC;AAEF;;GAEG;AACU,QAAA,QAAQ,GAAG,gBAAC,CAAC,OAAO,CAAC,KAAK,EAAE,QAAgB,EAAE,EAAE,CAC3D,cAAI,CAAC,KAAK,CAAC,MAAM,YAAE,CAAC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,EAAE;IAC9C,YAAY,EAAE,KAAK;IACnB,QAAQ,EAAE,QAAQ;CACnB,CAAC,CACH,CAAC;AAEF;;;;;;GAMG;AACI,KAAK,UAAU,YAAY,CAChC,QAAgB,EAChB,GAAG,GAAG,OAAO,CAAC,GAAG,EAAE;IAEnB,MAAM,MAAM,GAAG,MAAM,IAAA,kBAAU,EAAC,GAAG,CAAC,CAAC;IACrC,IAAI,CAAC,MAAM,EAAE;QACX,OAAO;KACR;IACD,OAAO,mBAAI,CAAC,IAAI,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;AACrC,CAAC;AATD,oCASC;AAED;;;;;;GAMG;AACU,QAAA,mBAAmB,GAAG,gBAAC,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,GAAG,OAAO,CAAC,GAAG,EAAE,EAAE,EAAE;IACzE,MAAM,QAAQ,GAAG,MAAM,IAAA,iBAAM,EAAC,6BAAiB,EAAE,EAAC,GAAG,EAAE,IAAI,EAAE,MAAM,EAAC,CAAC,CAAC;IACtE,GAAG,CAAC,KAAK,CAAC,4BAA4B,EAAE,QAAQ,CAAC,CAAC;IAClD,OAAO,QAAQ,CAAC;AAClB,CAAC,CAAC,CAAC;AAEH;;;;;;GAMG;AACU,QAAA,aAAa,GAAG,gBAAC,CAAC,OAAO,CAAC,gBAAC,CAAC,OAAO,CAAC,YAAY,EAAE,2BAAe,CAAC,CAAC,CAAC;AAgBjF,KAAK,UAAU,YAAY,CACzB,GAAW,EACX,SAAmB;IAEnB,MAAM,MAAM,GAAG,MAAM,IAAA,kBAAU,EAAC,GAAG,CAAC,CAAC;IACrC,IAAI,CAAC,MAAM,EAAE;QACX,MAAM,IAAI,qBAAa,CACrB,oBAAoB,6BAAiB,SAAS,GAAG,8CAA8C,CAChG,CAAC;KACH;IACD,MAAM,OAAO,GAAG,mBAAI,CAAC,IAAI,CAAC,MAAM,EAAE,6BAAiB,CAAC,CAAC;IACrD,GAAG,CAAC,KAAK,CAAC,4BAA4B,EAAE,OAAO,CAAC,CAAC;IACjD,IAAI,SAAS,EAAE;QACb,MAAM,GAAG,GAAG,MAAM,IAAA,kBAAO,EAAC,EAAC,GAAG,EAAE,MAAM,EAAE,SAAS,EAAC,CAAC,CAAC;QACpD,OAAO,EAAC,GAAG,EAAE,OAAO,EAAC,CAAC;KACvB;SAAM;QACL,MAAM,GAAG,GAAG,MAAM,IAAA,kBAAO,EAAC,EAAC,GAAG,EAAE,MAAM,EAAC,CAAC,CAAC;QACzC,OAAO,EAAC,GAAG,EAAE,OAAO,EAAC,CAAC;KACvB;AACH,CAAC;AAED;;GAEG;AACU,QAAA,eAAe,GAAG,gBAAC,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;AAEvD;;;;;GAKG;AACU,QAAA,eAAe,GAAG,gBAAC,CAAC,OAAO,CAAC,CAAC,eAAuB,EAAE,EAAE;IACnE,MAAM,GAAG,GAAG,IAAI,qBAAW,EAAE,CAAC;IAC9B,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IACvC,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IACvC,GAAG,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,uBAAa,EAAE,CAAC,CAAC;IAC3C,GAAG,CAAC,SAAS,CAAC,EAAC,OAAO,EAAE,mBAAI,CAAC,OAAO,CAAC,eAAe,CAAC,EAAC,CAAC,CAAC;IACxD,OAAO,GAAG,CAAC,OAAO,CAAC,YAAY,EAAE,CAAC;AACpC,CAAC,CAAC,CAAC;AAEH;;GAEG;AACU,QAAA,SAAS,GAAG,gBAAC,CAAC,OAAO,CAChC,KAAK,EAAuB,QAAgB,EAAc,EAAE,CAC1D,KAAK,CAAC,KAAK,CAAC,MAAM,YAAE,CAAC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,CACnD,CAAC;AAEF;;GAEG;AACU,QAAA,QAAQ,GAAG,gBAAC,CAAC,OAAO,CAC/B,KAAK,EAAuB,QAAgB,EAAc,EAAE,CAC1D,IAAI,CAAC,KAAK,CAAC,MAAM,YAAE,CAAC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,CAClD,CAAC;AAEF;;;;;;;GAOG;AACH,SAAgB,aAAa,CAAC,QAAgB,EAAE,OAAkB,EAAE,SAAS,GAAG,KAAK;IACnF,MAAM,IAAI,GAAW,gBAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC;IAC3F,OAAO,YAAE,CAAC,SAAS,CAAC,QAAQ,EAAE,IAAI,EAAE;QAClC,QAAQ,EAAE,MAAM;QAChB,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI;KAC7B,CAAC,CAAC;AACL,CAAC;AAND,sCAMC;AAED;;GAEG;AACH,MAAM,WAAW,GAAG,gBAAC,CAAC,OAAO,CAAC,YAAE,CAAC,KAA+B,CAAC,CAAC;AAElE;;GAEG;AACU,QAAA,QAAQ,GAAG,gBAAC,CAAC,OAAO,CAAC,WAAW,EAAE,oBAAQ,EAAE,EAAC,OAAO,EAAE,IAAI,EAAC,CAAC,CAAC;AAE1E;;GAEG;AACH,MAAM,WAAW,GAAG,gBAAC,CAAC,OAAO,CAAC,WAAW,EAAE,uBAAW,EAAE,EAAC,OAAO,EAAE,IAAI,EAAC,CAAC,CAAC;AAEzE;;GAEG;AACH,MAAM,YAAY,GAAG,gBAAC,CAAC,OAAO,CAAC,WAAW,EAAE,GAAG,uBAAW,GAAG,EAAE,EAAC,OAAO,EAAE,IAAI,EAAC,CAAC,CAAC;AAEhF;;GAEG;AACH,MAAM,YAAY,GAAG,gBAAC,CAAC,OAAO,CAAC,WAAW,EAAE,wBAAY,EAAE,EAAC,OAAO,EAAE,IAAI,EAAC,CAAC,CAAC;AAE3E;;GAEG;AACU,QAAA,QAAQ,GAAG,gBAAC,CAAC,OAAO,CAAC,KAAK,IAAI,EAAE;IAC3C,sBAAsB;IACtB,IAAI,QAAQ,GAAG,MAAM,WAAW,CAAC,qBAAS,EAAE,EAAC,OAAO,EAAE,IAAI,EAAC,CAAC,CAAC;IAC7D,IAAI,QAAQ,EAAE;QACZ,OAAO,QAAQ,CAAC;KACjB;IACD,uCAAuC;IACvC,MAAM,UAAU,GAAG,MAAM,IAAA,kBAAU,GAAE,CAAC;IACtC,IAAI,CAAC,UAAU,EAAE;QACf,OAAO;KACR;IACD,IAAI;QACF,sCAAsC;QACtC,uCAAuC;QACvC,MAAM,EAAC,MAAM,EAAC,GAAG,MAAM,IAAA,mBAAI,EAAC,UAAU,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,aAAa,CAAC,CAAC,CAAC;QACvE,IAAI,MAAM,EAAE;YACV,QAAQ,GAAG,mBAAI,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC;YACnD,IAAI,MAAM,YAAE,CAAC,YAAY,CAAC,QAAQ,CAAC,EAAE;gBACnC,OAAO,QAAQ,CAAC;aACjB;SACF;KACF;IACD,MAAM,GAAE;AACV,CAAC,CAAC,CAAC;AAEH;;;;GAIG;AACU,QAAA,WAAW,GAAG,gBAAC,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,GAAG,OAAO,CAAC,GAAG,EAAE,EAA+B,EAAE;IAC9F,mFAAmF;IACnF,MAAM,UAAU,GACd,CAAC,MAAM,YAAE,CAAC,IAAI,CAAC,kCAAkC,EAAE,EAAC,GAAG,EAAE,KAAK,EAAE,IAAI,EAAC,CAAC,CAAC;QACvE,CAAC,MAAM,YAAE,CAAC,IAAI,CAAC,qCAAqC,EAAE,EAAC,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAC,CAAC,CAAC,CAAC;IAC3F,OAAO,gBAAC,CAAC,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,YAAY,EAAE,CAAC,CAAC;AACvD,CAAC,CAAC,CAAC;AAEH;;;;GAIG;AACU,QAAA,UAAU,GAAG,gBAAC,CAAC,OAAO,CACjC,KAAK,IAAiC,EAAE,CAAC,CAAC,MAAM,YAAY,EAAE,CAAC,IAAI,CAAC,MAAM,WAAW,EAAE,CAAC,CACzF,CAAC;AAEF;;;;;;;GAOG;AACU,QAAA,aAAa,GAAG,gBAAC,CAAC,OAAO,CACpC,KAAK,EAAE,QAAgB,EAAE,GAAG,GAAG,OAAO,CAAC,GAAG,EAAE,EAAsB,EAAE;IAClE,IAAI,SAAS,GAAG,CAAC,MAAM,IAAA,gBAAQ,EAAC,QAAQ,CAAC,CAAc,CAAC;IACxD,IAAI,SAAS,CAAC,QAAQ,EAAE;QACtB,SAAS,CAAC,QAAQ,GAAG,mBAAI,CAAC,OAAO,CAAC,GAAG,EAAE,mBAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,SAAS,CAAC,QAAQ,CAAC,CAAC;KACpF;IACD,IAAI,SAAS,CAAC,OAAO,EAAE;QACrB,IAAI,WAAW,GAAuB,mBAAI,CAAC,OAAO,CAAC,mBAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,SAAS,CAAC,OAAO,CAAC,CAAC;QAC9F,OAAO,WAAW,EAAE;YAClB,MAAM,UAAU,GAAG,CAAC,MAAM,IAAA,gBAAQ,EAAC,WAAW,CAAC,CAAc,CAAC;YAC9D,IAAI,UAAU,CAAC,QAAQ,EAAE;gBACvB,UAAU,CAAC,QAAQ,GAAG,mBAAI,CAAC,OAAO,CAAC,mBAAI,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,UAAU,CAAC,QAAQ,CAAC,CAAC;gBACnF,GAAG,CAAC,KAAK,CAAC,yBAAyB,EAAE,UAAU,CAAC,QAAQ,CAAC,CAAC;aAC3D;YACD,IAAI,UAAU,CAAC,QAAQ,EAAE;gBACvB,UAAU,CAAC,QAAQ,GAAG,mBAAI,CAAC,OAAO,CAAC,mBAAI,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,UAAU,CAAC,QAAQ,CAAC,CAAC;gBACnF,GAAG,CAAC,KAAK,CAAC,yBAAyB,EAAE,UAAU,CAAC,QAAQ,CAAC,CAAC;aAC3D;YACD,SAAS,GAAG,gBAAC,CAAC,YAAY,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;YAClD,WAAW,GAAG,UAAU,CAAC,OAAO;gBAC9B,CAAC,CAAC,mBAAI,CAAC,OAAO,CAAC,mBAAI,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,UAAU,CAAC,OAAO,CAAC;gBAC7D,CAAC,CAAC,SAAS,CAAC;SACf;KACF;IACD,OAAO,SAAS,CAAC;AACnB,CAAC,CACF,CAAC;AAEF;;GAEG;AACU,QAAA,UAAU,GAAG,gBAAC,CAAC,OAAO,CAAC,KAAK,EAAE,OAAe,EAAqB,EAAE;IAC/E,IAAI,CAAC,mBAAI,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE;QAC7B,MAAM,IAAI,qBAAa,CAAC,gCAAgC,OAAO,GAAG,CAAC,CAAC;KACrE;IACD,MAAM,OAAO,GAAG,MAAM,YAAE,CAAC,OAAO,CAAC,OAAO,EAAE,EAAC,aAAa,EAAE,IAAI,EAAC,CAAC,CAAC;IACjE,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,mBAAI,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC;AAC/F,CAAC,CAAC,CAAC"}
|
package/build/lib/init.d.ts
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
*
|
|
4
4
|
* @module
|
|
5
5
|
*/
|
|
6
|
-
import { Simplify } from 'type-fest';
|
|
6
|
+
import { PackageJson, Simplify } from 'type-fest';
|
|
7
7
|
import { ScaffoldTaskOptions } from './scaffold';
|
|
8
8
|
import { TsConfigJson } from './model';
|
|
9
9
|
/**
|
|
@@ -13,9 +13,9 @@ export declare const initTsConfigJson: import("./scaffold").ScaffoldTask<InitTsC
|
|
|
13
13
|
/**
|
|
14
14
|
* Function which scaffolds a `typedoc.json` file
|
|
15
15
|
*/
|
|
16
|
-
export declare const initTypeDocJson: import("./scaffold").ScaffoldTask<
|
|
16
|
+
export declare const initTypeDocJson: import("./scaffold").ScaffoldTask<InitTypeDocOptions, import("type-fest/source/jsonify").JsonifyObject<{
|
|
17
|
+
$schema?: string | undefined;
|
|
17
18
|
includes?: string | undefined;
|
|
18
|
-
logLevel?: import("typedoc").LogLevel | "Verbose" | "Info" | "Warn" | "Error" | undefined;
|
|
19
19
|
options?: string | undefined;
|
|
20
20
|
tsconfig?: string | undefined;
|
|
21
21
|
entryPoints?: string[] | undefined;
|
|
@@ -24,7 +24,7 @@ export declare const initTypeDocJson: import("./scaffold").ScaffoldTask<Scaffold
|
|
|
24
24
|
externalPattern?: string[] | undefined;
|
|
25
25
|
excludeExternals?: boolean | undefined;
|
|
26
26
|
excludeNotDocumented?: boolean | undefined;
|
|
27
|
-
excludeNotDocumentedKinds?: ("Project" | "Module" | "Namespace" | "Enum" | "EnumMember" | "Variable" | "Function" | "Class" | "Interface" | "Constructor" | "Property" | "Method" | "CallSignature" | "IndexSignature" | "ConstructorSignature" | "Parameter" | "TypeLiteral" | "TypeParameter" | "Accessor" | "GetSignature" | "SetSignature" | "ObjectLiteral" | "TypeAlias" | "
|
|
27
|
+
excludeNotDocumentedKinds?: ("Reference" | "Project" | "Module" | "Namespace" | "Enum" | "EnumMember" | "Variable" | "Function" | "Class" | "Interface" | "Constructor" | "Property" | "Method" | "CallSignature" | "IndexSignature" | "ConstructorSignature" | "Parameter" | "TypeLiteral" | "TypeParameter" | "Accessor" | "GetSignature" | "SetSignature" | "ObjectLiteral" | "TypeAlias" | "All" | "ClassOrInterface" | "VariableOrProperty" | "FunctionOrMethod" | "ClassMember" | "SomeSignature" | "SomeModule" | "SomeType" | "SomeValue" | "SomeMember" | "SomeExport" | "ExportContainer" | "Inheritable" | "ContainsCallSignatures" | "SignatureContainer")[] | undefined;
|
|
28
28
|
excludeInternal?: boolean | undefined;
|
|
29
29
|
excludePrivate?: boolean | undefined;
|
|
30
30
|
excludeProtected?: boolean | undefined;
|
|
@@ -33,7 +33,7 @@ export declare const initTypeDocJson: import("./scaffold").ScaffoldTask<Scaffold
|
|
|
33
33
|
out?: string | undefined;
|
|
34
34
|
json?: string | undefined;
|
|
35
35
|
pretty?: boolean | undefined;
|
|
36
|
-
emit?: "
|
|
36
|
+
emit?: "docs" | "both" | "none" | undefined;
|
|
37
37
|
theme?: string | undefined;
|
|
38
38
|
lightHighlightTheme?: import("shiki").Theme | undefined;
|
|
39
39
|
darkHighlightTheme?: import("shiki").Theme | undefined;
|
|
@@ -65,7 +65,7 @@ export declare const initTypeDocJson: import("./scaffold").ScaffoldTask<Scaffold
|
|
|
65
65
|
defaultCategory?: string | undefined;
|
|
66
66
|
categoryOrder?: string[] | undefined;
|
|
67
67
|
sort?: ("source-order" | "alphabetical" | "enum-value-ascending" | "enum-value-descending" | "static-first" | "instance-first" | "visibility" | "required-first" | "kind")[] | undefined;
|
|
68
|
-
kindSortOrder?: ("Project" | "Module" | "Namespace" | "Enum" | "EnumMember" | "Variable" | "Function" | "Class" | "Interface" | "Constructor" | "Property" | "Method" | "CallSignature" | "IndexSignature" | "ConstructorSignature" | "Parameter" | "TypeLiteral" | "TypeParameter" | "Accessor" | "GetSignature" | "SetSignature" | "ObjectLiteral" | "TypeAlias" | "
|
|
68
|
+
kindSortOrder?: ("Reference" | "Project" | "Module" | "Namespace" | "Enum" | "EnumMember" | "Variable" | "Function" | "Class" | "Interface" | "Constructor" | "Property" | "Method" | "CallSignature" | "IndexSignature" | "ConstructorSignature" | "Parameter" | "TypeLiteral" | "TypeParameter" | "Accessor" | "GetSignature" | "SetSignature" | "ObjectLiteral" | "TypeAlias" | "All" | "ClassOrInterface" | "VariableOrProperty" | "FunctionOrMethod" | "ClassMember" | "SomeSignature" | "SomeModule" | "SomeType" | "SomeValue" | "SomeMember" | "SomeExport" | "ExportContainer" | "Inheritable" | "ContainsCallSignatures" | "SignatureContainer")[] | undefined;
|
|
69
69
|
visibilityFilters?: {
|
|
70
70
|
[tag: `@${string}`]: boolean;
|
|
71
71
|
protected?: boolean | undefined;
|
|
@@ -82,14 +82,22 @@ export declare const initTypeDocJson: import("./scaffold").ScaffoldTask<Scaffold
|
|
|
82
82
|
version?: boolean | undefined;
|
|
83
83
|
showConfig?: boolean | undefined;
|
|
84
84
|
plugin?: string[] | undefined;
|
|
85
|
+
logLevel?: import("typedoc").LogLevel | "Verbose" | "Info" | "Warn" | "Error" | undefined;
|
|
85
86
|
treatWarningsAsErrors?: boolean | undefined;
|
|
86
87
|
treatValidationWarningsAsErrors?: boolean | undefined;
|
|
87
88
|
intentionallyNotExported?: string[] | undefined;
|
|
88
89
|
validation?: boolean | Partial<import("typedoc").ValidationOptions> | undefined;
|
|
89
|
-
requiredToBeDocumented?: ("Project" | "Module" | "Namespace" | "Enum" | "EnumMember" | "Variable" | "Function" | "Class" | "Interface" | "Constructor" | "Property" | "Method" | "CallSignature" | "IndexSignature" | "ConstructorSignature" | "Parameter" | "TypeLiteral" | "TypeParameter" | "Accessor" | "GetSignature" | "SetSignature" | "ObjectLiteral" | "TypeAlias" | "
|
|
90
|
-
$schema?: string | undefined;
|
|
90
|
+
requiredToBeDocumented?: ("Reference" | "Project" | "Module" | "Namespace" | "Enum" | "EnumMember" | "Variable" | "Function" | "Class" | "Interface" | "Constructor" | "Property" | "Method" | "CallSignature" | "IndexSignature" | "ConstructorSignature" | "Parameter" | "TypeLiteral" | "TypeParameter" | "Accessor" | "GetSignature" | "SetSignature" | "ObjectLiteral" | "TypeAlias" | "All" | "ClassOrInterface" | "VariableOrProperty" | "FunctionOrMethod" | "ClassMember" | "SomeSignature" | "SomeModule" | "SomeType" | "SomeValue" | "SomeMember" | "SomeExport" | "ExportContainer" | "Inheritable" | "ContainsCallSignatures" | "SignatureContainer")[] | undefined;
|
|
91
91
|
extends?: string | undefined;
|
|
92
92
|
}>>;
|
|
93
|
+
/**
|
|
94
|
+
* Function which scaffolds a `package.json` file
|
|
95
|
+
*
|
|
96
|
+
* This only amends prop `typedoc.entryPoint` to the `package.json` file.
|
|
97
|
+
*
|
|
98
|
+
* If, strangely, `package.json` did not exist, then it will now contain _only_ that prop.
|
|
99
|
+
*/
|
|
100
|
+
export declare const initTypeDocPkgJson: import("./scaffold").ScaffoldTask<InitTypeDocOptions, PackageJson>;
|
|
93
101
|
/**
|
|
94
102
|
* Function which scaffolds an `mkdocs.yml` file
|
|
95
103
|
*/
|
|
@@ -137,8 +145,10 @@ export interface InitMkDocsOptions extends ScaffoldTaskOptions {
|
|
|
137
145
|
* This runs tasks in serial; it _could_ run in parallel, but it has deleterious effects upon
|
|
138
146
|
* console output which would need mitigation.
|
|
139
147
|
*/
|
|
140
|
-
export declare function init({ typescript, typedoc, python, tsconfigJson: tsconfigJsonPath, packageJson: packageJsonPath, overwrite, include, mkdocs, mkdocsYml: mkdocsYmlPath, siteName, repoName, repoUrl, copyright, dryRun, cwd, pythonPath, upgrade, typedocJson: typeDocJsonPath, }?: InitOptions): Promise<void>;
|
|
141
|
-
export
|
|
148
|
+
export declare function init({ typescript, typedoc, python, tsconfigJson: tsconfigJsonPath, packageJson: packageJsonPath, overwrite, include, mkdocs, mkdocsYml: mkdocsYmlPath, siteName, repoName, repoUrl, copyright, dryRun, cwd, pythonPath, upgrade, typedocJson: typeDocJsonPath, entryPoint: typeDocEntryPoint, }?: InitOptions): Promise<void>;
|
|
149
|
+
export interface InitTypeDocOptions extends ScaffoldTaskOptions {
|
|
150
|
+
typeDocEntryPoint?: string;
|
|
151
|
+
}
|
|
142
152
|
export interface InitTsConfigOptions extends ScaffoldTaskOptions {
|
|
143
153
|
/**
|
|
144
154
|
* List of source files (globs supported); typically `src` or `lib`
|
|
@@ -197,5 +207,9 @@ export type InitOptions = Simplify<Omit<InitPythonOptions & InitTsConfigOptions
|
|
|
197
207
|
* If `true`, upgrade only
|
|
198
208
|
*/
|
|
199
209
|
upgrade?: boolean;
|
|
210
|
+
/**
|
|
211
|
+
* Path to entry point of extension (source; not "main" field)
|
|
212
|
+
*/
|
|
213
|
+
entryPoint?: string;
|
|
200
214
|
}>;
|
|
201
215
|
//# sourceMappingURL=init.d.ts.map
|
package/build/lib/init.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"init.d.ts","sourceRoot":"","sources":["../../lib/init.ts"],"names":[],"mappings":"AAAA;;;;GAIG;
|
|
1
|
+
{"version":3,"file":"init.d.ts","sourceRoot":"","sources":["../../lib/init.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAaH,OAAO,EAAC,WAAW,EAAE,QAAQ,EAAC,MAAM,WAAW,CAAC;AAEhD,OAAO,EAAqB,mBAAmB,EAAC,MAAM,YAAY,CAAC;AAEnE,OAAO,EAAY,YAAY,EAAc,MAAM,SAAS,CAAC;AAkD7D;;GAEG;AACH,eAAO,MAAM,gBAAgB,sEAyB5B,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAI3B,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,kBAAkB,oEAW9B,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,UAAU;;;;;;;;;;;;;;;;;;;;;;GAmDtB,CAAC;AAEF;;;GAGG;AACH,wBAAsB,UAAU,CAAC,EAC/B,UAAU,EACV,MAAc,EACd,OAAe,GAChB,GAAE,iBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC,CAyBxC;AAED;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,mBAAmB;IAC5D,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;;;;GAKG;AACH,wBAAsB,IAAI,CAAC,EACzB,UAAU,EACV,OAAO,EACP,MAAM,EACN,YAAY,EAAE,gBAAgB,EAC9B,WAAW,EAAE,eAAe,EAC5B,SAAS,EACT,OAAO,EACP,MAAM,EACN,SAAS,EAAE,aAAa,EACxB,QAAQ,EACR,QAAQ,EACR,OAAO,EACP,SAAS,EACT,MAAM,EACN,GAAG,EACH,UAAU,EACV,OAAO,EACP,WAAW,EAAE,eAAe,EAC5B,UAAU,EAAE,iBAAiB,GAC9B,GAAE,WAAgB,GAAG,OAAO,CAAC,IAAI,CAAC,CAoDlC;AAED,MAAM,WAAW,kBAAmB,SAAQ,mBAAmB;IAC7D,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,WAAW,mBAAoB,SAAQ,mBAAmB;IAC9D;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;CACpB;AACD,MAAM,WAAW,iBAAkB,SAAQ,mBAAmB;IAC5D;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED;;;;GAIG;AACH,MAAM,MAAM,WAAW,GAAG,QAAQ,CAChC,IAAI,CAAC,iBAAiB,GAAG,mBAAmB,GAAG,kBAAkB,GAAG,iBAAiB,EAAE,MAAM,CAAC,GAAG;IAC/F;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB,CACF,CAAC"}
|
package/build/lib/init.js
CHANGED
|
@@ -31,7 +31,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
|
31
31
|
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
32
32
|
};
|
|
33
33
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
34
|
-
exports.init = exports.initPython = exports.initMkDocs = exports.initTypeDocJson = exports.initTsConfigJson = void 0;
|
|
34
|
+
exports.init = exports.initPython = exports.initMkDocs = exports.initTypeDocPkgJson = exports.initTypeDocJson = exports.initTsConfigJson = void 0;
|
|
35
35
|
const JSON5 = __importStar(require("json5"));
|
|
36
36
|
const constants_1 = require("./constants");
|
|
37
37
|
const yaml_1 = __importDefault(require("yaml"));
|
|
@@ -70,8 +70,17 @@ const BASE_TSCONFIG_JSON = Object.freeze({
|
|
|
70
70
|
outDir: 'build',
|
|
71
71
|
},
|
|
72
72
|
});
|
|
73
|
+
/**
|
|
74
|
+
* Data for the base `package.json` file.
|
|
75
|
+
* We expect `package.json` to exist, and we are not in the business of creating it.
|
|
76
|
+
* However, we will need to add a `typedoc.entryPoint` prop to it.
|
|
77
|
+
*/
|
|
78
|
+
const BASE_PACKAGE_JSON = Object.freeze({});
|
|
73
79
|
const log = (0, logger_1.getLogger)('init');
|
|
74
80
|
const dryRunLog = (0, logger_1.getLogger)('dry-run', log);
|
|
81
|
+
/**
|
|
82
|
+
* Files included, by default, in `tsconfig.json`
|
|
83
|
+
*/
|
|
75
84
|
const DEFAULT_INCLUDE = ['lib', 'test', 'index.js'];
|
|
76
85
|
/**
|
|
77
86
|
* Function which scaffolds a `tsconfig.json` file
|
|
@@ -101,6 +110,19 @@ exports.initTsConfigJson = (0, scaffold_1.createScaffoldTask)(constants_1.NAME_T
|
|
|
101
110
|
* Function which scaffolds a `typedoc.json` file
|
|
102
111
|
*/
|
|
103
112
|
exports.initTypeDocJson = (0, scaffold_1.createScaffoldTask)(constants_1.NAME_TYPEDOC_JSON, BASE_TYPEDOC_JSON, 'TypeDoc configuration');
|
|
113
|
+
/**
|
|
114
|
+
* Function which scaffolds a `package.json` file
|
|
115
|
+
*
|
|
116
|
+
* This only amends prop `typedoc.entryPoint` to the `package.json` file.
|
|
117
|
+
*
|
|
118
|
+
* If, strangely, `package.json` did not exist, then it will now contain _only_ that prop.
|
|
119
|
+
*/
|
|
120
|
+
exports.initTypeDocPkgJson = (0, scaffold_1.createScaffoldTask)(constants_1.NAME_PACKAGE_JSON, BASE_PACKAGE_JSON, 'Package configuration for TypeDoc', {
|
|
121
|
+
transform: (content, opts) => ({
|
|
122
|
+
...content,
|
|
123
|
+
typedoc: { entryPoint: opts.typeDocEntryPoint },
|
|
124
|
+
}),
|
|
125
|
+
});
|
|
104
126
|
/**
|
|
105
127
|
* Function which scaffolds an `mkdocs.yml` file
|
|
106
128
|
*/
|
|
@@ -187,7 +209,7 @@ exports.initPython = initPython;
|
|
|
187
209
|
* This runs tasks in serial; it _could_ run in parallel, but it has deleterious effects upon
|
|
188
210
|
* console output which would need mitigation.
|
|
189
211
|
*/
|
|
190
|
-
async function init({ typescript, typedoc, python, tsconfigJson: tsconfigJsonPath, packageJson: packageJsonPath, overwrite, include, mkdocs, mkdocsYml: mkdocsYmlPath, siteName, repoName, repoUrl, copyright, dryRun, cwd, pythonPath, upgrade, typedocJson: typeDocJsonPath, } = {}) {
|
|
212
|
+
async function init({ typescript, typedoc, python, tsconfigJson: tsconfigJsonPath, packageJson: packageJsonPath, overwrite, include, mkdocs, mkdocsYml: mkdocsYmlPath, siteName, repoName, repoUrl, copyright, dryRun, cwd, pythonPath, upgrade, typedocJson: typeDocJsonPath, entryPoint: typeDocEntryPoint, } = {}) {
|
|
191
213
|
if (!typescript && typedoc) {
|
|
192
214
|
log.warn('Initialization of tsconfig.json disabled. TypeDoc requires a tsconfig.json; please ensure it exists');
|
|
193
215
|
}
|
|
@@ -209,6 +231,13 @@ async function init({ typescript, typedoc, python, tsconfigJson: tsconfigJsonPat
|
|
|
209
231
|
dryRun,
|
|
210
232
|
cwd,
|
|
211
233
|
});
|
|
234
|
+
await (0, exports.initTypeDocPkgJson)({
|
|
235
|
+
packageJson: packageJsonPath,
|
|
236
|
+
overwrite: true,
|
|
237
|
+
dryRun,
|
|
238
|
+
cwd,
|
|
239
|
+
typeDocEntryPoint,
|
|
240
|
+
});
|
|
212
241
|
}
|
|
213
242
|
if (python) {
|
|
214
243
|
await initPython({ pythonPath, dryRun, upgrade });
|
package/build/lib/init.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"init.js","sourceRoot":"","sources":["../../lib/init.ts"],"names":[],"mappings":";AAAA;;;;GAIG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,6CAA+B;AAC/B,
|
|
1
|
+
{"version":3,"file":"init.js","sourceRoot":"","sources":["../../lib/init.ts"],"names":[],"mappings":";AAAA;;;;GAIG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,6CAA+B;AAC/B,2CAOqB;AACrB,gDAAwB;AACxB,+CAAkC;AAElC,mCAAsC;AACtC,yCAAmE;AACnE,qCAAmC;AAEnC,oDAAuB;AACvB,6BAA+D;AAE/D;;GAEG;AACH,MAAM,eAAe,GAAwB,MAAM,CAAC,MAAM,CAAC;IACzD,OAAO,EAAE,iDAAiD;IAC1D,QAAQ,EAAE,MAAM;IAChB,QAAQ,EAAE,MAAM;CACjB,CAAC,CAAC;AAEH;;GAEG;AACH,MAAM,iBAAiB,GAA0B,MAAM,CAAC,MAAM,CAAC;IAC7D,OAAO,EAAE,iCAAiC;IAC1C,cAAc,EAAE,IAAI;IACpB,kBAAkB,EAAE,UAAU;IAC9B,KAAK,EAAE,QAAQ;IACf,MAAM,EAAE,MAAM;IACd,WAAW,EAAE,CAAC,GAAG,CAAC;CACnB,CAAC,CAAC;AAEH;;GAEG;AACH,MAAM,kBAAkB,GAA2B,MAAM,CAAC,MAAM,CAAC;IAC/D,OAAO,EAAE,uCAAuC;IAChD,OAAO,EAAE,gCAAgC;IACzC,eAAe,EAAE;QACf,MAAM,EAAE,OAAO;KAChB;CACF,CAAC,CAAC;AAEH;;;;GAIG;AACH,MAAM,iBAAiB,GAA0B,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;AAEnE,MAAM,GAAG,GAAG,IAAA,kBAAS,EAAC,MAAM,CAAC,CAAC;AAC9B,MAAM,SAAS,GAAG,IAAA,kBAAS,EAAC,SAAS,EAAE,GAAG,CAAC,CAAC;AAE5C;;GAEG;AACH,MAAM,eAAe,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,CAAC,CAAC;AACpD;;GAEG;AACU,QAAA,gBAAgB,GAAG,IAAA,6BAAkB,EAChD,8BAAkB,EAClB,kBAAkB,EAClB,0BAA0B,EAC1B;IACE;;;;;;OAMG;IACH,SAAS,EAAE,CAAC,OAAO,EAAE,EAAC,OAAO,EAAC,EAAE,EAAE;QAChC,OAAO,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,OAAO,IAAI,OAAO,IAAI,EAAE,CAAC,CAAC,CAAC;QAClD,IAAI,gBAAC,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE;YACtB,OAAO,GAAG,CAAC,GAAG,eAAe,CAAC,CAAC;SAChC;QACD,OAAO;YACL,GAAG,OAAO;YACV,OAAO,EAAE,gBAAC,CAAC,IAAI,CAAC,OAAO,CAAC;SACzB,CAAC;IACJ,CAAC;IACD,WAAW,EAAE,KAAK,CAAC,KAAK;IACxB,SAAS,EAAE,mBAAc;CAC1B,CACF,CAAC;AAEF;;GAEG;AACU,QAAA,eAAe,GAAG,IAAA,6BAAkB,EAC/C,6BAAiB,EACjB,iBAAiB,EACjB,uBAAuB,CACxB,CAAC;AAEF;;;;;;GAMG;AACU,QAAA,kBAAkB,GAAG,IAAA,6BAAkB,EAClD,6BAAiB,EACjB,iBAAiB,EACjB,mCAAmC,EACnC;IACE,SAAS,EAAE,CAAC,OAAO,EAAE,IAAI,EAAE,EAAE,CAC3B,CAAC;QACC,GAAG,OAAO;QACV,OAAO,EAAE,EAAC,UAAU,EAAE,IAAI,CAAC,iBAAiB,EAAC;KAC9B,CAAA;CACpB,CACF,CAAC;AAEF;;GAEG;AACU,QAAA,UAAU,GAAG,IAAA,6BAAkB,EAC1C,2BAAe,EACf,eAAe,EACf,sBAAsB,EACtB;IACE,WAAW,EAAE,cAAI,CAAC,KAAK;IACvB,SAAS,EAAE,kBAAa;IACxB,SAAS,EAAE,CAAC,OAAO,EAAE,IAAI,EAAE,GAAG,EAAE,EAAE;QAChC,IAAI,QAAQ,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,CAAC,SAAS,CAAC;QAClD,IAAI,CAAC,QAAQ,EAAE;YACb,QAAQ,GAAG,GAAG,CAAC,IAAI,IAAI,WAAW,CAAC;YACnC,IAAI,QAAQ,EAAE;gBACZ,GAAG,CAAC,IAAI,CAAC,uCAAuC,EAAE,QAAQ,CAAC,CAAC;aAC7D;SACF;QACD,IAAI,OAAO,GAAuB,IAAI,CAAC,OAAO,IAAI,OAAO,CAAC,QAAQ,CAAC;QACnE,IAAI,CAAC,OAAO,EAAE;YACZ,OAAO,GAAG,GAAG,CAAC,UAAU,EAAE,GAAG,CAAC;YAC9B,IAAI,OAAO,EAAE;gBACX,GAAG,CAAC,IAAI,CAAC,sCAAsC,EAAE,OAAO,CAAC,CAAC;aAC3D;SACF;QACD,IAAI,QAAQ,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,CAAC,SAAS,CAAC;QAClD,IAAI,OAAO,IAAI,CAAC,QAAQ,EAAE;YACxB,IAAI,EAAC,QAAQ,EAAC,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,CAAC;YAClC,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YAC7B,MAAM,SAAS,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YACtC,MAAM,KAAK,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC;YAC3B,IAAI,IAAI,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC;YACxB,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;YAClC,QAAQ,GAAG,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACnC,IAAI,QAAQ,EAAE;gBACZ,GAAG,CAAC,IAAI,CAAC,uCAAuC,EAAE,QAAQ,CAAC,CAAC;aAC7D;SACF;QACD,IAAI,eAAe,GAAG,IAAI,CAAC,eAAe,IAAI,OAAO,CAAC,gBAAgB,CAAC;QACvE,IAAI,CAAC,eAAe,EAAE;YACpB,eAAe,GAAG,GAAG,CAAC,WAAW,CAAC;YAClC,IAAI,eAAe,EAAE;gBACnB,GAAG,CAAC,IAAI,CAAC,kDAAkD,EAAE,eAAe,CAAC,CAAC;aAC/E;SACF;QACD,OAAO;YACL,GAAG,OAAO;YACV,SAAS,EAAE,QAAQ;YACnB,QAAQ,EAAE,OAAO;YACjB,SAAS,EAAE,QAAQ;YACnB,gBAAgB,EAAE,eAAe;SAClC,CAAC;IACJ,CAAC;CACF,CACF,CAAC;AAEF;;;GAGG;AACI,KAAK,UAAU,UAAU,CAAC,EAC/B,UAAU,EACV,MAAM,GAAG,KAAK,EACd,OAAO,GAAG,KAAK,MACM,EAAE;IACvB,UAAU,GAAG,UAAU,IAAI,CAAC,MAAM,IAAA,eAAU,GAAE,CAAC,IAAI,uBAAW,CAAC;IAE/D,MAAM,IAAI,GAAG,CAAC,IAAI,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,iCAAqB,CAAC,CAAC;IACnE,IAAI,OAAO,EAAE;QACX,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;KACxB;IACD,IAAI,MAAM,EAAE;QACV,SAAS,CAAC,IAAI,CAAC,8BAA8B,EAAE,UAAU,EAAE,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;KAC5E;SAAM;QACL,GAAG,CAAC,KAAK,CAAC,0BAA0B,EAAE,UAAU,EAAE,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;QAClE,GAAG,CAAC,IAAI,CAAC,mCAAmC,CAAC,CAAC;QAC9C,IAAI;YACF,MAAM,MAAM,GAAG,MAAM,IAAA,mBAAI,EAAC,UAAU,EAAE,IAAI,EAAE,EAAC,KAAK,EAAE,IAAI,EAAC,CAAC,CAAC;YAC3D,MAAM,EAAC,IAAI,EAAE,MAAM,EAAC,GAAG,MAAM,CAAC;YAC9B,IAAI,IAAI,KAAK,CAAC,EAAE;gBACd,MAAM,IAAI,qBAAa,CAAC,kDAAkD,MAAM,EAAE,CAAC,CAAC;aACrF;SACF;QAAC,OAAO,GAAG,EAAE;YACZ,MAAM,IAAI,qBAAa,CACrB,kDAAmD,GAAa,CAAC,OAAO,EAAE,CAC3E,CAAC;SACH;KACF;IACD,GAAG,CAAC,OAAO,CAAC,mEAAmE,CAAC,CAAC;AACnF,CAAC;AA7BD,gCA6BC;AAaD;;;;;GAKG;AACI,KAAK,UAAU,IAAI,CAAC,EACzB,UAAU,EACV,OAAO,EACP,MAAM,EACN,YAAY,EAAE,gBAAgB,EAC9B,WAAW,EAAE,eAAe,EAC5B,SAAS,EACT,OAAO,EACP,MAAM,EACN,SAAS,EAAE,aAAa,EACxB,QAAQ,EACR,QAAQ,EACR,OAAO,EACP,SAAS,EACT,MAAM,EACN,GAAG,EACH,UAAU,EACV,OAAO,EACP,WAAW,EAAE,eAAe,EAC5B,UAAU,EAAE,iBAAiB,MACd,EAAE;IACjB,IAAI,CAAC,UAAU,IAAI,OAAO,EAAE;QAC1B,GAAG,CAAC,IAAI,CACN,qGAAqG,CACtG,CAAC;KACH;IAED,IAAI,UAAU,IAAI,CAAC,OAAO,EAAE;QAC1B,MAAM,IAAA,wBAAgB,EAAC;YACrB,IAAI,EAAE,gBAAgB;YACtB,WAAW,EAAE,eAAe;YAC5B,SAAS;YACT,OAAO;YACP,MAAM;YACN,GAAG;SACJ,CAAC,CAAC;KACJ;IAED,IAAI,OAAO,IAAI,CAAC,OAAO,EAAE;QACvB,MAAM,IAAA,uBAAe,EAAC;YACpB,IAAI,EAAE,eAAe;YACrB,WAAW,EAAE,eAAe;YAC5B,SAAS;YACT,MAAM;YACN,GAAG;SACJ,CAAC,CAAC;QACH,MAAM,IAAA,0BAAkB,EAAC;YACvB,WAAW,EAAE,eAAe;YAC5B,SAAS,EAAE,IAAI;YACf,MAAM;YACN,GAAG;YACH,iBAAiB;SAClB,CAAC,CAAC;KACJ;IAED,IAAI,MAAM,EAAE;QACV,MAAM,UAAU,CAAC,EAAC,UAAU,EAAE,MAAM,EAAE,OAAO,EAAC,CAAC,CAAC;KACjD;IAED,IAAI,MAAM,IAAI,CAAC,OAAO,EAAE;QACtB,MAAM,IAAA,kBAAU,EAAC;YACf,IAAI,EAAE,aAAa;YACnB,GAAG;YACH,QAAQ;YACR,OAAO;YACP,QAAQ;YACR,SAAS;YACT,WAAW,EAAE,eAAe;YAC5B,SAAS;YACT,MAAM;SACP,CAAC,CAAC;KACJ;AACH,CAAC;AAxED,oBAwEC"}
|
package/build/lib/scaffold.d.ts
CHANGED
|
@@ -28,7 +28,7 @@ export declare function createScaffoldTask<Opts extends ScaffoldTaskOptions, T e
|
|
|
28
28
|
* Optional function which can be used to post-process the content of a file. Usually used to merge
|
|
29
29
|
* various options with existing content
|
|
30
30
|
*/
|
|
31
|
-
export type ScaffoldTaskTransformer<Opts extends ScaffoldTaskOptions, T extends JsonValue> = (content: Readonly<T>, opts: TaskSpecificOpts<Opts>, pkg: NormalizedPackageJson) => T;
|
|
31
|
+
export type ScaffoldTaskTransformer<Opts extends ScaffoldTaskOptions, T extends JsonValue> = (content: Readonly<T>, opts: TaskSpecificOpts<Opts>, pkg: Readonly<NormalizedPackageJson>) => T;
|
|
32
32
|
/**
|
|
33
33
|
* A function which deserializes a string into a JS value.
|
|
34
34
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"scaffold.d.ts","sourceRoot":"","sources":["../../lib/scaffold.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAMH,OAAO,EAAC,qBAAqB,EAAC,MAAM,UAAU,CAAC;AAC/C,OAAO,EAAC,SAAS,EAAE,UAAU,EAAC,MAAM,WAAW,CAAC;AA8BhD;;GAEG;AACH,MAAM,MAAM,gBAAgB,CAAC,IAAI,SAAS,mBAAmB,IAAI,IAAI,CACnE,IAAI,EACJ,MAAM,mBAAmB,CAC1B,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,YAAY,CAAC,IAAI,SAAS,mBAAmB,EAAE,CAAC,SAAS,UAAU,IAAI,CACjF,IAAI,EAAE,IAAI,KACP,OAAO,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,CAAC;AAEpC;;;;;;;;GAQG;AACH,wBAAgB,kBAAkB,CAAC,IAAI,SAAS,mBAAmB,EAAE,CAAC,SAAS,UAAU,EACvF,eAAe,EAAE,MAAM,EACvB,cAAc,EAAE,CAAC,EACjB,WAAW,EAAE,MAAM,EACnB,EACE,SAAsB,EACtB,WAAwB,EACxB,SAAyB,GAC1B,GAAE,yBAAyB,CAAC,IAAI,EAAE,CAAC,CAAM,GACzC,YAAY,CAAC,IAAI,EAAE,CAAC,CAAC,
|
|
1
|
+
{"version":3,"file":"scaffold.d.ts","sourceRoot":"","sources":["../../lib/scaffold.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAMH,OAAO,EAAC,qBAAqB,EAAC,MAAM,UAAU,CAAC;AAC/C,OAAO,EAAC,SAAS,EAAE,UAAU,EAAC,MAAM,WAAW,CAAC;AA8BhD;;GAEG;AACH,MAAM,MAAM,gBAAgB,CAAC,IAAI,SAAS,mBAAmB,IAAI,IAAI,CACnE,IAAI,EACJ,MAAM,mBAAmB,CAC1B,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,YAAY,CAAC,IAAI,SAAS,mBAAmB,EAAE,CAAC,SAAS,UAAU,IAAI,CACjF,IAAI,EAAE,IAAI,KACP,OAAO,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,CAAC;AAEpC;;;;;;;;GAQG;AACH,wBAAgB,kBAAkB,CAAC,IAAI,SAAS,mBAAmB,EAAE,CAAC,SAAS,UAAU,EACvF,eAAe,EAAE,MAAM,EACvB,cAAc,EAAE,CAAC,EACjB,WAAW,EAAE,MAAM,EACnB,EACE,SAAsB,EACtB,WAAwB,EACxB,SAAyB,GAC1B,GAAE,yBAAyB,CAAC,IAAI,EAAE,CAAC,CAAM,GACzC,YAAY,CAAC,IAAI,EAAE,CAAC,CAAC,CA8EvB;AAED;;;GAGG;AACH,MAAM,MAAM,uBAAuB,CAAC,IAAI,SAAS,mBAAmB,EAAE,CAAC,SAAS,SAAS,IAAI,CAC3F,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC,EACpB,IAAI,EAAE,gBAAgB,CAAC,IAAI,CAAC,EAC5B,GAAG,EAAE,QAAQ,CAAC,qBAAqB,CAAC,KACjC,CAAC,CAAC;AAEP;;GAEG;AACH,MAAM,MAAM,wBAAwB,CAAC,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,KAAK,CAAC,CAAC;AAEjE;;GAEG;AACH,MAAM,MAAM,sBAAsB,CAAC,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,KAAK,MAAM,CAAC;AAE/D;;GAEG;AACH,MAAM,WAAW,yBAAyB,CAAC,IAAI,SAAS,mBAAmB,EAAE,CAAC,SAAS,SAAS;IAC9F;;OAEG;IACH,SAAS,CAAC,EAAE,uBAAuB,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;IAC7C;;OAEG;IACH,WAAW,CAAC,EAAE,wBAAwB,CAAC,CAAC,CAAC,CAAC;IAC1C;;OAEG;IACH,SAAS,CAAC,EAAE,sBAAsB,CAAC,CAAC,CAAC,CAAC;CACvC;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB,CAAC,CAAC;IACnC;;OAEG;IACH,OAAO,EAAE,CAAC,CAAC;IACX;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd"}
|
package/build/lib/scaffold.js
CHANGED
|
@@ -47,6 +47,7 @@ function createScaffoldTask(defaultFilename, defaultContent, description, { tran
|
|
|
47
47
|
const relativeDest = relativePath(dest);
|
|
48
48
|
log.debug('Initializing %s', relativeDest);
|
|
49
49
|
let shouldWriteDest = false;
|
|
50
|
+
let isNew = false;
|
|
50
51
|
let destContent;
|
|
51
52
|
let result;
|
|
52
53
|
try {
|
|
@@ -61,12 +62,13 @@ function createScaffoldTask(defaultFilename, defaultContent, description, { tran
|
|
|
61
62
|
shouldWriteDest = true;
|
|
62
63
|
log.debug('Creating new file %s', relativeDest);
|
|
63
64
|
destContent = {};
|
|
65
|
+
isNew = true;
|
|
64
66
|
}
|
|
65
67
|
const defaults = transform(defaultContent, opts, pkg);
|
|
66
68
|
const finalDestContent = lodash_1.default.defaultsDeep({}, destContent, defaults);
|
|
67
69
|
shouldWriteDest = shouldWriteDest || !lodash_1.default.isEqual(destContent, finalDestContent);
|
|
68
70
|
if (shouldWriteDest) {
|
|
69
|
-
log.info('Changes needed
|
|
71
|
+
log.info('Changes needed in %s', relativeDest);
|
|
70
72
|
log.debug('Original %s: %O', relativeDest, destContent);
|
|
71
73
|
log.debug('Final %s: %O', relativeDest, finalDestContent);
|
|
72
74
|
const patch = makePatch(dest, destContent, finalDestContent, serialize);
|
|
@@ -77,6 +79,12 @@ function createScaffoldTask(defaultFilename, defaultContent, description, { tran
|
|
|
77
79
|
}
|
|
78
80
|
try {
|
|
79
81
|
await (0, fs_1.safeWriteFile)(dest, finalDestContent, overwrite);
|
|
82
|
+
if (isNew) {
|
|
83
|
+
log.success('Initialized %s', description);
|
|
84
|
+
}
|
|
85
|
+
else {
|
|
86
|
+
log.success('Updated %s', description);
|
|
87
|
+
}
|
|
80
88
|
}
|
|
81
89
|
catch (e) {
|
|
82
90
|
const err = e;
|
|
@@ -93,9 +101,9 @@ function createScaffoldTask(defaultFilename, defaultContent, description, { tran
|
|
|
93
101
|
}
|
|
94
102
|
}
|
|
95
103
|
else {
|
|
96
|
-
log.info('No changes
|
|
104
|
+
log.info('No changes necessary for %s', relativeDest);
|
|
97
105
|
}
|
|
98
|
-
log.success(
|
|
106
|
+
log.success(`${description}: done`);
|
|
99
107
|
return { path: dest, content: finalDestContent };
|
|
100
108
|
};
|
|
101
109
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"scaffold.js","sourceRoot":"","sources":["../../lib/scaffold.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;AAEH,6CAAmC;AACnC,qCAAmC;AACnC,0DAA6B;AAC7B,+BAAiC;AAGjC,mCAAsC;AACtC,iCAAgC;AAChC,oDAAuB;AACvB,6BAAmE;AACnE,2CAA6D;AAE7D,MAAM,GAAG,GAAG,IAAA,kBAAS,EAAC,MAAM,CAAC,CAAC;AAC9B,MAAM,SAAS,GAAG,IAAA,kBAAS,EAAC,SAAS,EAAE,GAAG,CAAC,CAAC;AAE5C;;;;;;GAMG;AACH,SAAS,SAAS,CAChB,QAAgB,EAChB,OAAmB,EACnB,OAAmB,EACnB,aAAwC,kBAAa;IAErD,OAAO,IAAA,kBAAW,EAChB,QAAQ,EACR,gBAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,CAAC,EACnD,gBAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,CAAC,CACpD,CAAC;AACJ,CAAC;AAmBD;;;;;;;;GAQG;AACH,SAAgB,kBAAkB,CAChC,eAAuB,EACvB,cAAiB,EACjB,WAAmB,EACnB,EACE,SAAS,GAAG,gBAAC,CAAC,QAAQ,EACtB,WAAW,GAAG,IAAI,CAAC,KAAK,EACxB,SAAS,GAAG,kBAAa,MACa,EAAE;IAE1C,OAAO,KAAK,EAAE,EACZ,SAAS,GAAG,KAAK,EACjB,GAAG,GAAG,OAAO,CAAC,GAAG,EAAE,EACnB,WAAW,EAAE,eAAe,EAC5B,IAAI,EACJ,MAAM,GAAG,KAAK,EACd,GAAG,IAAI,EACF,EAAkC,EAAE;QACzC,MAAM,YAAY,GAAG,IAAA,eAAQ,EAAC,GAAG,CAAC,CAAC;QACnC,MAAM,EAAC,OAAO,EAAE,GAAG,EAAC,GAAG,MAAM,IAAA,oBAAe,EAC1C,eAAe,CAAC,CAAC,CAAC,mBAAI,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,GAAG,EACrD,IAAI,CACL,CAAC;QACF,MAAM,MAAM,GAAG,mBAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACrC,IAAI,GAAG,IAAI,IAAI,mBAAI,CAAC,IAAI,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;QAClD,MAAM,YAAY,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC;QACxC,GAAG,CAAC,KAAK,CAAC,iBAAiB,EAAE,YAAY,CAAC,CAAC;QAC3C,IAAI,eAAe,GAAG,KAAK,CAAC;QAC5B,IAAI,WAAc,CAAC;QACnB,IAAI,MAA6B,CAAC;QAClC,IAAI;YACF,WAAW,GAAG,WAAW,CAAC,MAAM,YAAE,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC;YAC3D,GAAG,CAAC,KAAK,CAAC,wBAAwB,EAAE,YAAY,CAAC,CAAC;SACnD;QAAC,OAAO,CAAC,EAAE;YACV,MAAM,GAAG,GAAG,CAA0B,CAAC;YACvC,IAAI,GAAG,CAAC,IAAI,KAAK,2BAAe,EAAE;gBAChC,MAAM,GAAG,CAAC;aACX;YACD,eAAe,GAAG,IAAI,CAAC;YACvB,GAAG,CAAC,KAAK,CAAC,sBAAsB,EAAE,YAAY,CAAC,CAAC;YAChD,WAAW,GAAG,EAAO,CAAC;
|
|
1
|
+
{"version":3,"file":"scaffold.js","sourceRoot":"","sources":["../../lib/scaffold.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;AAEH,6CAAmC;AACnC,qCAAmC;AACnC,0DAA6B;AAC7B,+BAAiC;AAGjC,mCAAsC;AACtC,iCAAgC;AAChC,oDAAuB;AACvB,6BAAmE;AACnE,2CAA6D;AAE7D,MAAM,GAAG,GAAG,IAAA,kBAAS,EAAC,MAAM,CAAC,CAAC;AAC9B,MAAM,SAAS,GAAG,IAAA,kBAAS,EAAC,SAAS,EAAE,GAAG,CAAC,CAAC;AAE5C;;;;;;GAMG;AACH,SAAS,SAAS,CAChB,QAAgB,EAChB,OAAmB,EACnB,OAAmB,EACnB,aAAwC,kBAAa;IAErD,OAAO,IAAA,kBAAW,EAChB,QAAQ,EACR,gBAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,CAAC,EACnD,gBAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,CAAC,CACpD,CAAC;AACJ,CAAC;AAmBD;;;;;;;;GAQG;AACH,SAAgB,kBAAkB,CAChC,eAAuB,EACvB,cAAiB,EACjB,WAAmB,EACnB,EACE,SAAS,GAAG,gBAAC,CAAC,QAAQ,EACtB,WAAW,GAAG,IAAI,CAAC,KAAK,EACxB,SAAS,GAAG,kBAAa,MACa,EAAE;IAE1C,OAAO,KAAK,EAAE,EACZ,SAAS,GAAG,KAAK,EACjB,GAAG,GAAG,OAAO,CAAC,GAAG,EAAE,EACnB,WAAW,EAAE,eAAe,EAC5B,IAAI,EACJ,MAAM,GAAG,KAAK,EACd,GAAG,IAAI,EACF,EAAkC,EAAE;QACzC,MAAM,YAAY,GAAG,IAAA,eAAQ,EAAC,GAAG,CAAC,CAAC;QACnC,MAAM,EAAC,OAAO,EAAE,GAAG,EAAC,GAAG,MAAM,IAAA,oBAAe,EAC1C,eAAe,CAAC,CAAC,CAAC,mBAAI,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,GAAG,EACrD,IAAI,CACL,CAAC;QACF,MAAM,MAAM,GAAG,mBAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACrC,IAAI,GAAG,IAAI,IAAI,mBAAI,CAAC,IAAI,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;QAClD,MAAM,YAAY,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC;QACxC,GAAG,CAAC,KAAK,CAAC,iBAAiB,EAAE,YAAY,CAAC,CAAC;QAC3C,IAAI,eAAe,GAAG,KAAK,CAAC;QAC5B,IAAI,KAAK,GAAG,KAAK,CAAC;QAClB,IAAI,WAAc,CAAC;QACnB,IAAI,MAA6B,CAAC;QAClC,IAAI;YACF,WAAW,GAAG,WAAW,CAAC,MAAM,YAAE,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC;YAC3D,GAAG,CAAC,KAAK,CAAC,wBAAwB,EAAE,YAAY,CAAC,CAAC;SACnD;QAAC,OAAO,CAAC,EAAE;YACV,MAAM,GAAG,GAAG,CAA0B,CAAC;YACvC,IAAI,GAAG,CAAC,IAAI,KAAK,2BAAe,EAAE;gBAChC,MAAM,GAAG,CAAC;aACX;YACD,eAAe,GAAG,IAAI,CAAC;YACvB,GAAG,CAAC,KAAK,CAAC,sBAAsB,EAAE,YAAY,CAAC,CAAC;YAChD,WAAW,GAAG,EAAO,CAAC;YACtB,KAAK,GAAG,IAAI,CAAC;SACd;QAED,MAAM,QAAQ,GAAM,SAAS,CAAC,cAAc,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC;QACzD,MAAM,gBAAgB,GAAM,gBAAC,CAAC,YAAY,CAAC,EAAE,EAAE,WAAW,EAAE,QAAQ,CAAC,CAAC;QAEtE,eAAe,GAAG,eAAe,IAAI,CAAC,gBAAC,CAAC,OAAO,CAAC,WAAW,EAAE,gBAAgB,CAAC,CAAC;QAE/E,IAAI,eAAe,EAAE;YACnB,GAAG,CAAC,IAAI,CAAC,sBAAsB,EAAE,YAAY,CAAC,CAAC;YAC/C,GAAG,CAAC,KAAK,CAAC,iBAAiB,EAAE,YAAY,EAAE,WAAW,CAAC,CAAC;YACxD,GAAG,CAAC,KAAK,CAAC,cAAc,EAAE,YAAY,EAAE,gBAAgB,CAAC,CAAC;YAC1D,MAAM,KAAK,GAAG,SAAS,CAAC,IAAI,EAAE,WAAW,EAAE,gBAAgB,EAAE,SAAS,CAAC,CAAC;YAExE,IAAI,MAAM,EAAE;gBACV,SAAS,CAAC,IAAI,CAAC,yCAAyC,EAAE,KAAK,CAAC,CAAC;gBACjE,MAAM,GAAG,EAAC,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,gBAAgB,EAAC,CAAC;gBACjD,OAAO,MAAM,CAAC;aACf;YAED,IAAI;gBACF,MAAM,IAAA,kBAAa,EAAC,IAAI,EAAE,gBAAgB,EAAE,SAAS,CAAC,CAAC;gBACvD,IAAI,KAAK,EAAE;oBACT,GAAG,CAAC,OAAO,CAAC,gBAAgB,EAAE,WAAW,CAAC,CAAC;iBAC5C;qBAAM;oBACL,GAAG,CAAC,OAAO,CAAC,YAAY,EAAE,WAAW,CAAC,CAAC;iBACxC;aACF;YAAC,OAAO,CAAC,EAAE;gBACV,MAAM,GAAG,GAAG,CAA0B,CAAC;gBACvC,iDAAiD;gBACjD,IAAI,GAAG,CAAC,IAAI,KAAK,2BAAe,EAAE;oBAChC,GAAG,CAAC,IAAI,CAAC,GAAG,YAAY,gCAAgC,CAAC,CAAC;oBAC1D,GAAG,CAAC,KAAK,CAAC,4BAA4B,KAAK,EAAE,CAAC,CAAC;iBAChD;qBAAM;oBACL,MAAM,IAAI,qBAAa,CAAC,sBAAsB,YAAY,aAAa,GAAG,CAAC,OAAO,EAAE,EAAE;wBACpF,KAAK,EAAE,GAAG;qBACX,CAAC,CAAC;iBACJ;aACF;SACF;aAAM;YACL,GAAG,CAAC,IAAI,CAAC,6BAA6B,EAAE,YAAY,CAAC,CAAC;SACvD;QACD,GAAG,CAAC,OAAO,CAAC,GAAG,WAAW,QAAQ,CAAC,CAAC;QACpC,OAAO,EAAC,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,gBAAgB,EAAC,CAAC;IACjD,CAAC,CAAC;AACJ,CAAC;AAvFD,gDAuFC"}
|
package/lib/builder/deploy.ts
CHANGED
|
@@ -18,7 +18,7 @@ import {
|
|
|
18
18
|
NAME_PYTHON,
|
|
19
19
|
} from '../constants';
|
|
20
20
|
import {DocutilsError} from '../error';
|
|
21
|
-
import {findMkDocsYml, findPython, readPackageJson} from '../fs';
|
|
21
|
+
import {findMike, findMkDocsYml, findPython, readPackageJson} from '../fs';
|
|
22
22
|
import {getLogger} from '../logger';
|
|
23
23
|
import {argify, spawnBackgroundProcess, SpawnBackgroundProcessOpts, stopwatch} from '../util';
|
|
24
24
|
|
|
@@ -26,33 +26,33 @@ const log = getLogger('builder:deploy');
|
|
|
26
26
|
|
|
27
27
|
/**
|
|
28
28
|
* Runs `mike serve`
|
|
29
|
-
* @param
|
|
29
|
+
* @param mikePath Path to `mike` executable
|
|
30
30
|
* @param args Extra args to `mike build`
|
|
31
31
|
* @param opts Extra options for `teen_process.Subprocess.start`
|
|
32
32
|
*/
|
|
33
33
|
async function doServe(
|
|
34
|
-
|
|
34
|
+
mikePath: string,
|
|
35
35
|
args: string[] = [],
|
|
36
36
|
opts: SpawnBackgroundProcessOpts = {}
|
|
37
37
|
) {
|
|
38
|
-
const finalArgs = ['
|
|
39
|
-
return spawnBackgroundProcess(
|
|
38
|
+
const finalArgs = ['serve', ...args];
|
|
39
|
+
return spawnBackgroundProcess(mikePath, finalArgs, opts);
|
|
40
40
|
}
|
|
41
41
|
|
|
42
42
|
/**
|
|
43
43
|
* Runs `mike build`
|
|
44
|
-
* @param
|
|
44
|
+
* @param mikePath Path to `mike` executable
|
|
45
45
|
* @param args Extra args to `mike build`
|
|
46
46
|
* @param opts Extra options to `teen_process.exec`
|
|
47
47
|
*/
|
|
48
48
|
async function doDeploy(
|
|
49
|
-
|
|
49
|
+
mikePath: string,
|
|
50
50
|
args: string[] = [],
|
|
51
51
|
opts: TeenProcessExecOptions = {}
|
|
52
52
|
) {
|
|
53
|
-
const finalArgs = ['
|
|
54
|
-
log.debug('Executing %s via: %s %O', NAME_MIKE,
|
|
55
|
-
return await exec(
|
|
53
|
+
const finalArgs = ['deploy', ...args];
|
|
54
|
+
log.debug('Executing %s via: %s %O', NAME_MIKE, mikePath, finalArgs);
|
|
55
|
+
return await exec(mikePath, finalArgs, opts);
|
|
56
56
|
}
|
|
57
57
|
|
|
58
58
|
/**
|
|
@@ -125,6 +125,11 @@ export async function deploy({
|
|
|
125
125
|
port,
|
|
126
126
|
host,
|
|
127
127
|
};
|
|
128
|
+
|
|
129
|
+
const mikePath = await findMike();
|
|
130
|
+
if (!mikePath) {
|
|
131
|
+
throw new DocutilsError(`Could not find ${NAME_MIKE} executable; please run "${NAME_BIN} init"`);
|
|
132
|
+
}
|
|
128
133
|
if (serve) {
|
|
129
134
|
const mikeArgs = [
|
|
130
135
|
...argify(_.pickBy(mikeOpts, (value) => _.isNumber(value) || Boolean(value))),
|
|
@@ -135,7 +140,7 @@ export async function deploy({
|
|
|
135
140
|
}
|
|
136
141
|
stop(); // discard
|
|
137
142
|
// unsure about how SIGHUP is handled here
|
|
138
|
-
await doServe(
|
|
143
|
+
await doServe(mikePath, mikeArgs, serveOpts);
|
|
139
144
|
} else {
|
|
140
145
|
log.info('Deploying into branch %s', branch);
|
|
141
146
|
const mikeArgs = [
|
|
@@ -150,7 +155,7 @@ export async function deploy({
|
|
|
150
155
|
if (alias) {
|
|
151
156
|
mikeArgs.push(alias);
|
|
152
157
|
}
|
|
153
|
-
await doDeploy(
|
|
158
|
+
await doDeploy(mikePath, mikeArgs, execOpts);
|
|
154
159
|
|
|
155
160
|
log.success('Finished deployment into branch %s (%dms)', branch, stop());
|
|
156
161
|
}
|
package/lib/builder/nav.ts
CHANGED
|
@@ -100,8 +100,10 @@ export function parseNav(nav: MkDocsYmlNav): ParsedNavData[] {
|
|
|
100
100
|
}
|
|
101
101
|
|
|
102
102
|
/**
|
|
103
|
-
* Finds all items within the list of parsed nav data which correpsond to the header.
|
|
104
|
-
*
|
|
103
|
+
* Finds all items within the list of parsed nav data which correpsond to the header.
|
|
104
|
+
*
|
|
105
|
+
* This is imperfect, as it's possible for the header string to appear in multiple places in the
|
|
106
|
+
* nav, but let's just ignore that until we can't.
|
|
105
107
|
* @param navData Some parsed nav data
|
|
106
108
|
* @param header Header name
|
|
107
109
|
*/
|
|
@@ -110,6 +112,8 @@ function filterHeaderItems(navData: ParsedNavData[], header: string) {
|
|
|
110
112
|
}
|
|
111
113
|
|
|
112
114
|
/**
|
|
115
|
+
* Given a root header keypath (like a prefix), a numeric offset, and some parsed nav data, compute
|
|
116
|
+
* a keypath
|
|
113
117
|
*
|
|
114
118
|
* @param rootHeaderKeypath Root keypath as determined by {@linkcode getRootHeaderKeypath}
|
|
115
119
|
* @param offset Numeric offset within the array of items for the header
|
|
@@ -136,16 +140,16 @@ function navDataDidChange(
|
|
|
136
140
|
newNavData: Array<Omit<ParsedNavData, 'name'>>,
|
|
137
141
|
navData: ParsedNavData[]
|
|
138
142
|
): boolean {
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
);
|
|
143
|
+
// the result should be the items from newNavData which either don't appear in
|
|
144
|
+
// navdata, or the items which do appear in navData but have a different fileOrUrl
|
|
145
|
+
const matchedKeypaths = _.intersectionBy(newNavData, navData, 'keypath');
|
|
146
|
+
const diff = _.xorBy(newNavData, matchedKeypaths, 'fileOrUrl');
|
|
144
147
|
return !_.isEmpty(diff);
|
|
145
148
|
}
|
|
146
149
|
|
|
147
150
|
/**
|
|
148
151
|
* Find the "root" keypath for a particular header
|
|
152
|
+
*
|
|
149
153
|
* @param headerItems Some subset of the nav data having keypaths corresponding to `header`
|
|
150
154
|
* @param header Header string
|
|
151
155
|
* @returns The keypath up to the header string, inclusive
|
|
@@ -167,7 +171,6 @@ function getRootHeaderKeypath(headerItems: ParsedNavData[], header: string) {
|
|
|
167
171
|
* by `dir`; if `all` is true, we just use the default header, because we will be returning a whole
|
|
168
172
|
* lot of headers).
|
|
169
173
|
*
|
|
170
|
-
*
|
|
171
174
|
* @param dir Abs path to directory containing markdown files generated by TypeDoc
|
|
172
175
|
* @param mkDocsDocsDir Configured `docs_dir` or via options
|
|
173
176
|
* @param navData Nav data parsed by {@linkcode parseNav}
|
|
@@ -202,7 +205,6 @@ async function getNavItemsForDir(
|
|
|
202
205
|
const offset = navHeaderItems.findIndex((item) => item.fileOrUrl === fileOrUrl);
|
|
203
206
|
const newOffset = offset >= 0 ? offset : navHeaderItems.length;
|
|
204
207
|
const data = navHeaderItems[offset];
|
|
205
|
-
log.warn(rootHeaderKeypath, newOffset, data);
|
|
206
208
|
const keypath = getKeypathForHeaderItem(rootHeaderKeypath, newOffset, data);
|
|
207
209
|
newNavHeaderItems.push({keypath, fileOrUrl});
|
|
208
210
|
}
|
package/lib/cli/check.ts
CHANGED
|
@@ -79,7 +79,10 @@ export async function checkMissingPaths<T extends Record<string, Options>>(
|
|
|
79
79
|
|
|
80
80
|
if (missingPaths.length) {
|
|
81
81
|
return missingPaths
|
|
82
|
-
.map(
|
|
82
|
+
.map(
|
|
83
|
+
({id, path}) =>
|
|
84
|
+
`Default or specified path via --${_.kebabCase(id)} (${path}) does not exist`
|
|
85
|
+
)
|
|
83
86
|
.join('\n');
|
|
84
87
|
}
|
|
85
88
|
|
package/lib/cli/command/build.ts
CHANGED
|
@@ -124,7 +124,7 @@ const opts = {
|
|
|
124
124
|
remote: {
|
|
125
125
|
alias: 'r',
|
|
126
126
|
describe: 'Remote to push to',
|
|
127
|
-
implies:
|
|
127
|
+
implies: 'push',
|
|
128
128
|
group: BuildCommandGroup.Deploy,
|
|
129
129
|
type: 'string',
|
|
130
130
|
requiresArg: true,
|
|
@@ -133,7 +133,7 @@ const opts = {
|
|
|
133
133
|
},
|
|
134
134
|
prefix: {
|
|
135
135
|
describe: 'Subdirectory within <branch> to commit to',
|
|
136
|
-
implies:
|
|
136
|
+
implies: 'branch',
|
|
137
137
|
group: BuildCommandGroup.Deploy,
|
|
138
138
|
type: 'string',
|
|
139
139
|
nargs: 1,
|
|
@@ -168,9 +168,10 @@ const opts = {
|
|
|
168
168
|
},
|
|
169
169
|
rebase: {
|
|
170
170
|
describe: 'Rebase <branch> with remote before deploy',
|
|
171
|
-
implies:
|
|
171
|
+
implies: 'deploy',
|
|
172
172
|
group: BuildCommandGroup.Deploy,
|
|
173
173
|
type: 'boolean',
|
|
174
|
+
defaultDescription: 'true',
|
|
174
175
|
},
|
|
175
176
|
serve: {
|
|
176
177
|
describe: 'Start development server',
|