@appium/docutils 0.3.0 → 0.3.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/build/lib/builder/deploy.d.ts +3 -3
- package/build/lib/builder/deploy.d.ts.map +1 -1
- package/build/lib/builder/deploy.js +3 -6
- package/build/lib/builder/deploy.js.map +1 -1
- package/build/lib/builder/site.d.ts +3 -3
- package/build/lib/builder/site.d.ts.map +1 -1
- package/build/lib/builder/site.js +2 -4
- package/build/lib/builder/site.js.map +1 -1
- package/build/lib/init.d.ts +1 -0
- package/build/lib/init.d.ts.map +1 -1
- package/build/lib/logger.js.map +1 -1
- package/build/lib/util.d.ts +12 -3
- package/build/lib/util.d.ts.map +1 -1
- package/build/lib/util.js +26 -1
- package/build/lib/util.js.map +1 -1
- package/lib/builder/deploy.ts +6 -9
- package/lib/builder/site.ts +9 -9
- package/lib/logger.ts +1 -1
- package/lib/util.ts +24 -4
- package/package.json +6 -6
- package/requirements.txt +1 -1
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* @module
|
|
5
5
|
*/
|
|
6
6
|
import { TeenProcessExecOptions } from 'teen_process';
|
|
7
|
-
import {
|
|
7
|
+
import { SpawnBackgroundProcessOpts } from '../util';
|
|
8
8
|
/**
|
|
9
9
|
* Runs `mike build` or `mike serve`
|
|
10
10
|
* @param opts Options
|
|
@@ -82,8 +82,8 @@ export interface DeployOpts {
|
|
|
82
82
|
*/
|
|
83
83
|
execOpts?: TeenProcessExecOptions;
|
|
84
84
|
/**
|
|
85
|
-
* Extra options for {@linkcode
|
|
85
|
+
* Extra options for {@linkcode spawnBackgroundProcess}
|
|
86
86
|
*/
|
|
87
|
-
serveOpts?:
|
|
87
|
+
serveOpts?: SpawnBackgroundProcessOpts;
|
|
88
88
|
}
|
|
89
89
|
//# sourceMappingURL=deploy.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"deploy.d.ts","sourceRoot":"","sources":["../../../lib/builder/deploy.ts"],"names":[],"mappings":"AAAA;;;;GAIG;
|
|
1
|
+
{"version":3,"file":"deploy.d.ts","sourceRoot":"","sources":["../../../lib/builder/deploy.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAIH,OAAO,EAAO,sBAAsB,EAAC,MAAM,cAAc,CAAC;AAY1D,OAAO,EAAiC,0BAA0B,EAAY,MAAM,SAAS,CAAC;AAiD9F;;;GAGG;AACH,wBAAsB,MAAM,CAAC,EAC3B,SAAS,EAAE,aAAa,EACxB,WAAW,EAAE,eAAe,EAC5B,aAAa,EAAE,OAAO,EACtB,GAAmB,EACnB,KAAa,EACb,IAAY,EACZ,MAA8B,EAC9B,MAA8B,EAC9B,MAAM,EACN,OAAO,EACP,KAAK,EACL,MAAa,EACb,IAAyB,EACzB,IAAyB,EACzB,SAAS,EACT,QAAQ,GACT,GAAE,UAAe,iBAoDjB;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;IACf;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,QAAQ,CAAC,EAAE,sBAAsB,CAAC;IAElC;;OAEG;IACH,SAAS,CAAC,EAAE,0BAA0B,CAAC;CACxC"}
|
|
@@ -10,8 +10,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
|
10
10
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
11
11
|
exports.deploy = void 0;
|
|
12
12
|
const lodash_1 = __importDefault(require("lodash"));
|
|
13
|
-
const teen_process_1 = require("teen_process");
|
|
14
13
|
const node_path_1 = __importDefault(require("node:path"));
|
|
14
|
+
const teen_process_1 = require("teen_process");
|
|
15
15
|
const constants_1 = require("../constants");
|
|
16
16
|
const error_1 = require("../error");
|
|
17
17
|
const fs_1 = require("../fs");
|
|
@@ -24,13 +24,10 @@ const log = logger_1.default.withTag('builder:deploy');
|
|
|
24
24
|
* @param opts Extra options for `teen_process.Subprocess.start`
|
|
25
25
|
* @param mikePath Path to `mike` executable
|
|
26
26
|
*/
|
|
27
|
-
async function doServe(args = [],
|
|
27
|
+
async function doServe(args = [], opts = {}, mikePath) {
|
|
28
28
|
mikePath = mikePath ?? (await (0, fs_1.whichMike)());
|
|
29
29
|
const finalArgs = ['serve', ...args];
|
|
30
|
-
|
|
31
|
-
log.debug('Launching %s with args: %s', mikePath, finalArgs);
|
|
32
|
-
const proc = new teen_process_1.SubProcess(mikePath, finalArgs, opts);
|
|
33
|
-
return await proc.start(startDetector, detach, timeoutMs);
|
|
30
|
+
return (0, util_1.spawnBackgroundProcess)(mikePath, finalArgs, opts);
|
|
34
31
|
}
|
|
35
32
|
/**
|
|
36
33
|
* Runs `mike build`
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"deploy.js","sourceRoot":"","sources":["../../../lib/builder/deploy.ts"],"names":[],"mappings":";AAAA;;;;GAIG;;;;;;AAEH,oDAAuB;AACvB
|
|
1
|
+
{"version":3,"file":"deploy.js","sourceRoot":"","sources":["../../../lib/builder/deploy.ts"],"names":[],"mappings":";AAAA;;;;GAIG;;;;;;AAEH,oDAAuB;AACvB,0DAA6B;AAC7B,+CAA0D;AAC1D,4CAOsB;AACtB,oCAAuC;AACvC,8BAAgE;AAChE,uDAA+B;AAC/B,kCAA8F;AAE9F,MAAM,GAAG,GAAG,gBAAM,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC;AAE7C;;;;;GAKG;AACH,KAAK,UAAU,OAAO,CACpB,OAAiB,EAAE,EACnB,OAAmC,EAAE,EACrC,QAAiB;IAEjB,QAAQ,GAAG,QAAQ,IAAI,CAAC,MAAM,IAAA,cAAS,GAAE,CAAC,CAAC;IAC3C,MAAM,SAAS,GAAG,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,CAAC;IACrC,OAAO,IAAA,6BAAsB,EAAC,QAAQ,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC;AAC3D,CAAC;AAED;;;;;GAKG;AACH,KAAK,UAAU,QAAQ,CAAC,OAAiB,EAAE,EAAE,OAA+B,EAAE,EAAE,QAAiB;IAC/F,QAAQ,GAAG,QAAQ,IAAI,CAAC,MAAM,IAAA,cAAS,GAAE,CAAC,CAAC;IAC3C,MAAM,SAAS,GAAG,CAAC,QAAQ,EAAE,GAAG,IAAI,CAAC,CAAC;IACtC,GAAG,CAAC,KAAK,CAAC,4BAA4B,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC;IAC7D,OAAO,MAAM,IAAA,mBAAI,EAAC,QAAQ,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC;AAC/C,CAAC;AAED;;;;GAIG;AACH,KAAK,UAAU,iBAAiB,CAAC,eAAwB,EAAE,GAAG,GAAG,OAAO,CAAC,GAAG,EAAE;IAC5E,MAAM,EAAC,GAAG,EAAC,GAAG,MAAM,IAAA,oBAAe,EAAC,eAAe,CAAC,CAAC,CAAC,mBAAI,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;IACjG,MAAM,OAAO,GAAG,GAAG,CAAC,OAAO,CAAC;IAC5B,IAAI,CAAC,OAAO,EAAE;QACZ,MAAM,IAAI,qBAAa,CACrB,yFAAyF,CAC1F,CAAC;KACH;IACD,OAAO,OAAO,CAAC;AACjB,CAAC;AAED;;;GAGG;AACI,KAAK,UAAU,MAAM,CAAC,EAC3B,SAAS,EAAE,aAAa,EACxB,WAAW,EAAE,eAAe,EAC5B,aAAa,EAAE,OAAO,EACtB,GAAG,GAAG,OAAO,CAAC,GAAG,EAAE,EACnB,KAAK,GAAG,KAAK,EACb,IAAI,GAAG,KAAK,EACZ,MAAM,GAAG,iCAAqB,EAC9B,MAAM,GAAG,iCAAqB,EAC9B,MAAM,EACN,OAAO,EACP,KAAK,EACL,MAAM,GAAG,IAAI,EACb,IAAI,GAAG,8BAAkB,EACzB,IAAI,GAAG,8BAAkB,EACzB,SAAS,EACT,QAAQ,MACM,EAAE;IAChB,MAAM,IAAI,GAAG,IAAA,gBAAS,EAAC,QAAQ,CAAC,CAAC;IACjC,aAAa,GAAG,aAAa,IAAI,CAAC,MAAM,IAAA,kBAAa,EAAC,GAAG,CAAC,CAAC,CAAC;IAC5D,IAAI,CAAC,aAAa,EAAE;QAClB,MAAM,IAAI,qBAAa,CACrB,kBAAkB,2BAAe,SAAS,GAAG,UAAU,oBAAQ,qBAAqB,CACrF,CAAC;KACH;IACD,OAAO,GAAG,OAAO,IAAI,CAAC,MAAM,iBAAiB,CAAC,eAAe,EAAE,GAAG,CAAC,CAAC,CAAC;IAErE,wCAAwC;IACxC,OAAO,GAAG,OAAO,EAAE,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAE1C,MAAM,QAAQ,GAAG;QACf,aAAa,EAAE,aAAa;QAC5B,IAAI;QACJ,MAAM;QACN,MAAM;QACN,MAAM;QACN,OAAO;QACP,MAAM;QACN,IAAI;QACJ,IAAI;KACL,CAAC;IACF,IAAI,KAAK,EAAE;QACT,MAAM,QAAQ,GAAG;YACf,GAAG,IAAA,aAAM,EAAC,gBAAC,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,gBAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC;YAC7E,OAAO;SACR,CAAC;QACF,IAAI,KAAK,EAAE;YACT,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;SACtB;QACD,IAAI,EAAE,CAAC,CAAC,UAAU;QAClB,0CAA0C;QAC1C,MAAM,OAAO,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;KACpC;SAAM;QACL,MAAM,QAAQ,GAAG;YACf,GAAG,IAAA,aAAM,EACP,gBAAC,CAAC,MAAM,CACN,QAAQ,EACR,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE,CAAC,gBAAC,CAAC,QAAQ,CAAC,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC,gBAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CACpF,CACF;YACD,OAAO;SACR,CAAC;QACF,IAAI,KAAK,EAAE;YACT,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;SACtB;QACD,MAAM,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;QAEnC,GAAG,CAAC,OAAO,CAAC,gDAAgD,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;KAC/E;AACH,CAAC;AArED,wBAqEC"}
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* @module
|
|
6
6
|
*/
|
|
7
7
|
import { TeenProcessExecOptions } from 'teen_process';
|
|
8
|
-
import {
|
|
8
|
+
import { SpawnBackgroundProcessOpts } from '../util';
|
|
9
9
|
/**
|
|
10
10
|
* Runs `mkdocs build` or `mkdocs serve`
|
|
11
11
|
* @param opts
|
|
@@ -48,8 +48,8 @@ export interface BuildMkDocsOpts {
|
|
|
48
48
|
*/
|
|
49
49
|
execOpts?: TeenProcessExecOptions;
|
|
50
50
|
/**
|
|
51
|
-
* Extra options for {@linkcode
|
|
51
|
+
* Extra options for {@linkcode spawnBackgroundProcess}
|
|
52
52
|
*/
|
|
53
|
-
serveOpts?:
|
|
53
|
+
serveOpts?: SpawnBackgroundProcessOpts;
|
|
54
54
|
}
|
|
55
55
|
//# sourceMappingURL=site.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"site.d.ts","sourceRoot":"","sources":["../../../lib/builder/site.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;
|
|
1
|
+
{"version":3,"file":"site.d.ts","sourceRoot":"","sources":["../../../lib/builder/site.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAIH,OAAO,EAAO,sBAAsB,EAAC,MAAM,cAAc,CAAC;AAK1D,OAAO,EAAmC,0BAA0B,EAAY,MAAM,SAAS,CAAC;AAuChG;;;GAGG;AACH,wBAAsB,SAAS,CAAC,EAC9B,SAAS,EAAE,aAAa,EACxB,OAAO,EACP,KAAkB,EAClB,GAAmB,EACnB,KAAa,EACb,SAAS,EACT,QAAQ,GACT,GAAE,eAAoB,iBA6BtB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,QAAQ,CAAC,EAAE,sBAAsB,CAAC;IAElC;;OAEG;IACH,SAAS,CAAC,EAAE,0BAA0B,CAAC;CACxC"}
|
|
@@ -24,13 +24,11 @@ const log = logger_1.default.withTag('mkdocs');
|
|
|
24
24
|
* @param opts Extra options for `teen_process.Subprocess.start`
|
|
25
25
|
* @param mkDocsPath Path to `mkdocs` executable
|
|
26
26
|
*/
|
|
27
|
-
async function doServe(args = [],
|
|
27
|
+
async function doServe(args = [], opts = {}, mkDocsPath) {
|
|
28
28
|
mkDocsPath = mkDocsPath ?? (await (0, fs_1.whichMkDocs)());
|
|
29
29
|
const finalArgs = ['serve', ...args];
|
|
30
|
-
const opts = { stdio: 'inherit' };
|
|
31
30
|
log.debug('Launching %s with args: %s', mkDocsPath, finalArgs);
|
|
32
|
-
|
|
33
|
-
return await proc.start(startDetector, detach, timeoutMs);
|
|
31
|
+
return (0, util_1.spawnBackgroundProcess)(mkDocsPath, finalArgs, opts);
|
|
34
32
|
}
|
|
35
33
|
/**
|
|
36
34
|
* Runs `mkdocs build`
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"site.js","sourceRoot":"","sources":["../../../lib/builder/site.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;;;;
|
|
1
|
+
{"version":3,"file":"site.js","sourceRoot":"","sources":["../../../lib/builder/site.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;;;;AAGH,0DAA6B;AAC7B,+CAA0D;AAC1D,4CAAgF;AAChF,oCAAuC;AACvC,8BAAgE;AAChE,uDAA+B;AAC/B,kCAAgG;AAEhG,MAAM,GAAG,GAAG,gBAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;AAErC;;;;;GAKG;AACH,KAAK,UAAU,OAAO,CACpB,OAAiB,EAAE,EACnB,OAAmC,EAAE,EACrC,UAAmB;IAEnB,UAAU,GAAG,UAAU,IAAI,CAAC,MAAM,IAAA,gBAAW,GAAE,CAAC,CAAC;IACjD,MAAM,SAAS,GAAG,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,CAAC;IAErC,GAAG,CAAC,KAAK,CAAC,4BAA4B,EAAE,UAAU,EAAE,SAAS,CAAC,CAAC;IAC/D,OAAO,IAAA,6BAAsB,EAAC,UAAU,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC;AAC7D,CAAC;AAED;;;;;GAKG;AACH,KAAK,UAAU,OAAO,CACpB,OAAiB,EAAE,EACnB,OAA+B,EAAE,EACjC,UAAmB;IAEnB,UAAU,GAAG,UAAU,IAAI,CAAC,MAAM,IAAA,gBAAW,GAAE,CAAC,CAAC;IACjD,MAAM,SAAS,GAAG,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,CAAC;IACrC,GAAG,CAAC,KAAK,CAAC,4BAA4B,EAAE,UAAU,EAAE,SAAS,CAAC,CAAC;IAC/D,OAAO,MAAM,IAAA,mBAAI,EAAC,UAAU,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC;AACjD,CAAC;AAED;;;GAGG;AACI,KAAK,UAAU,SAAS,CAAC,EAC9B,SAAS,EAAE,aAAa,EACxB,OAAO,EACP,KAAK,GAAG,sBAAU,EAClB,GAAG,GAAG,OAAO,CAAC,GAAG,EAAE,EACnB,KAAK,GAAG,KAAK,EACb,SAAS,EACT,QAAQ,MACW,EAAE;IACrB,MAAM,IAAI,GAAG,IAAA,gBAAS,EAAC,cAAc,CAAC,CAAC;IACvC,aAAa,GAAG,aAAa;QAC3B,CAAC,CAAC,mBAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,aAAa,CAAC;QAC5C,CAAC,CAAC,MAAM,IAAA,kBAAa,EAAC,GAAG,CAAC,CAAC;IAC7B,IAAI,CAAC,aAAa,EAAE;QAClB,MAAM,IAAI,qBAAa,CACrB,kBAAkB,2BAAe,SAAS,GAAG,UAAU,oBAAQ,qBAAqB,CACrF,CAAC;KACH;IACD,MAAM,UAAU,GAAG,CAAC,IAAI,EAAE,aAAa,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;IACtD,IAAI,OAAO,EAAE;QACX,UAAU,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;KAChC;IACD,IAAI,KAAK,EAAE;QACT,0CAA0C;QAC1C,MAAM,OAAO,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC;KACtC;SAAM;QACL,MAAM,OAAO,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;QACpC,IAAI,UAAU,CAAC;QACf,IAAI,OAAO,EAAE;YACX,UAAU,GAAG,IAAA,eAAQ,EAAC,GAAG,EAAE,OAAO,CAAC,CAAC;SACrC;aAAM;YACL,CAAC,EAAC,QAAQ,EAAE,OAAO,EAAC,GAAG,MAAM,IAAA,kBAAa,EAAC,aAAa,CAAC,CAAC,CAAC;YAC3D,GAAG,CAAC,KAAK,CAAC,mBAAmB,EAAE,OAAO,CAAC,CAAC;YACxC,UAAU,GAAG,IAAA,eAAQ,EAAC,mBAAI,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE,OAAQ,CAAC,CAAC;SAC9D;QACD,GAAG,CAAC,OAAO,CAAC,yCAAyC,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC,CAAC;KAC5E;AACH,CAAC;AArCD,8BAqCC"}
|
package/build/lib/init.d.ts
CHANGED
|
@@ -84,6 +84,7 @@ export declare const initTypeDocJson: import("./scaffold").ScaffoldTask<Scaffold
|
|
|
84
84
|
plugin?: string[] | undefined;
|
|
85
85
|
logLevel?: import("typedoc").LogLevel | "Verbose" | "Info" | "Warn" | "Error" | undefined;
|
|
86
86
|
treatWarningsAsErrors?: boolean | undefined;
|
|
87
|
+
treatValidationWarningsAsErrors?: boolean | undefined;
|
|
87
88
|
intentionallyNotExported?: string[] | undefined;
|
|
88
89
|
validation?: boolean | Partial<import("typedoc").ValidationOptions> | undefined;
|
|
89
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;
|
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;AAYH,OAAO,EAAC,QAAQ,EAAC,MAAM,WAAW,CAAC;AAEnC,OAAO,EAAqB,mBAAmB,EAAC,MAAM,YAAY,CAAC;AAEnE,OAAO,EAAY,YAAY,EAAc,MAAM,SAAS,CAAC;AAwC7D;;GAEG;AACH,eAAO,MAAM,gBAAgB,sEAyB5B,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,eAAe
|
|
1
|
+
{"version":3,"file":"init.d.ts","sourceRoot":"","sources":["../../lib/init.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAYH,OAAO,EAAC,QAAQ,EAAC,MAAM,WAAW,CAAC;AAEnC,OAAO,EAAqB,mBAAmB,EAAC,MAAM,YAAY,CAAC;AAEnE,OAAO,EAAY,YAAY,EAAc,MAAM,SAAS,CAAC;AAwC7D;;GAEG;AACH,eAAO,MAAM,gBAAgB,sEAyB5B,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAI3B,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,UAAU;;;;;;;;;;;;;;;;;;;;;;GAmDtB,CAAC;AAEF;;;GAGG;AACH,wBAAsB,UAAU,CAAC,EAC/B,UAAwB,EACxB,MAAc,EACd,OAAe,GAChB,GAAE,iBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC,CAuBxC;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,GAC7B,GAAE,WAAgB,GAAG,OAAO,CAAC,IAAI,CAAC,CA6ClC;AAED,MAAM,MAAM,kBAAkB,GAAG,mBAAmB,CAAC;AACrD,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;CACnB,CACF,CAAC"}
|
package/build/lib/logger.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"logger.js","sourceRoot":"","sources":["../../lib/logger.ts"],"names":[],"mappings":";AAAA;;;;;;GAMG;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,sDAA8B;AAC9B,8DAAqC;AACrC,kDAA8D;AAC9D,mDAQiB;AACjB,2CAA2D;AAC3D,oDAAuB;AAEvB;;;;;;GAMG;AACH,MAAM,gBAAiB,SAAQ,uBAAa;IAsC1C;;;OAGG;IACH,MAAM,CAAC,YAAY,CAAC,IAAa;QAC/B,OAAO,IAAI,IAAI,gBAAgB,CAAC,cAAc,CAAC;IACjD,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,aAAa,CAAC,KAAe;QAClC,OAAO,KAAK,IAAI,gBAAgB,CAAC,YAAY,CAAC;IAChD,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,WAAW,CAAC,IAAa;QAC9B,OAAO,IAAI,IAAI,gBAAgB,CAAC,UAAU,CAAC;IAC7C,CAAC;IAED;;;;;OAKG;IACgB,UAAU,CAAC,MAAgC,EAAE,OAAiB;QAC/E,MAAM,EACJ,cAAc,EACd,YAAY,EACZ,UAAU,EACV,YAAY,EACZ,aAAa,EACb,WAAW,EACX,aAAa,GACd,GAAG,gBAAgB,CAAC;QAErB,IAAI,SAAiC,CAAC;QACtC,IAAI,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE;YAC7B,SAAS,GAAG,cAAc,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;SACzC;aAAM,IAAI,aAAa,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE;YACtC,SAAS,GAAG,YAAY,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;SACxC;aAAM;YACL,SAAS,GAA2B,CAClC,CAAE,IAAI,CAAC,OAAgC,CAAC,cAAc,IAAI,aAAa,CAAC,CACzE,CAAC;SACH;QAED,IAAI,OAAO,EAAE;YACX,OAAO,eAAK,CAAC,CAAC,IAAI,GAAG,gBAAC,CAAC,UAAU,CAAC,SAAS,CAAC,CAA2B,CAAC,CAAC,KAAK,CAC5E,IAAI,gBAAC,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAC7B,CAAC;SACH;QAED,MAAM,IAAI,GAAG,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC;QAC9E,OAAO,IAAI,CAAC,CAAC,CAAC,eAAK,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IAC5C,CAAC;;AAjGD;;GAEG;AACa,+BAAc,GAAG;IAC/B,IAAI,EAAE,MAAM;IACZ,OAAO,EAAE,OAAO;IAChB,KAAK,EAAE,KAAK;IACZ,IAAI,EAAE,QAAQ;CACqC,CAAC;AAEtD;;GAEG;AACa,6BAAY,GAAG;IAC7B,CAAC,EAAE,KAAK;IACR,CAAC,EAAE,QAAQ;IACX,CAAC,EAAE,OAAO;IACV,CAAC,EAAE,OAAO;CAC0C,CAAC;AAEvD;;GAEG;AACa,2BAAU,GAAG;IAC3B,IAAI,EAAE,qBAAU,CAAC,IAAI;IACrB,OAAO,EAAE,qBAAU,CAAC,OAAO;IAC3B,KAAK,EAAE,qBAAU,CAAC,KAAK;IACvB,IAAI,EAAE,qBAAU,CAAC,OAAO;IACxB,KAAK,EAAE,IAAA,iBAAO,EAAC,GAAG,CAAC;IACnB,KAAK,EAAE,IAAA,iBAAO,EAAC,GAAG,CAAC;CACgB,CAAC;AAEtC;;GAEG;AACa,8BAAa,GAAG,MAAM,CAAC;AAiEzC;;;;GAIG;AACH,IAAI,WAAW,
|
|
1
|
+
{"version":3,"file":"logger.js","sourceRoot":"","sources":["../../lib/logger.ts"],"names":[],"mappings":";AAAA;;;;;;GAMG;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,sDAA8B;AAC9B,8DAAqC;AACrC,kDAA8D;AAC9D,mDAQiB;AACjB,2CAA2D;AAC3D,oDAAuB;AAEvB;;;;;;GAMG;AACH,MAAM,gBAAiB,SAAQ,uBAAa;IAsC1C;;;OAGG;IACH,MAAM,CAAC,YAAY,CAAC,IAAa;QAC/B,OAAO,IAAI,IAAI,gBAAgB,CAAC,cAAc,CAAC;IACjD,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,aAAa,CAAC,KAAe;QAClC,OAAO,KAAK,IAAI,gBAAgB,CAAC,YAAY,CAAC;IAChD,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,WAAW,CAAC,IAAa;QAC9B,OAAO,IAAI,IAAI,gBAAgB,CAAC,UAAU,CAAC;IAC7C,CAAC;IAED;;;;;OAKG;IACgB,UAAU,CAAC,MAAgC,EAAE,OAAiB;QAC/E,MAAM,EACJ,cAAc,EACd,YAAY,EACZ,UAAU,EACV,YAAY,EACZ,aAAa,EACb,WAAW,EACX,aAAa,GACd,GAAG,gBAAgB,CAAC;QAErB,IAAI,SAAiC,CAAC;QACtC,IAAI,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE;YAC7B,SAAS,GAAG,cAAc,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;SACzC;aAAM,IAAI,aAAa,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE;YACtC,SAAS,GAAG,YAAY,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;SACxC;aAAM;YACL,SAAS,GAA2B,CAClC,CAAE,IAAI,CAAC,OAAgC,CAAC,cAAc,IAAI,aAAa,CAAC,CACzE,CAAC;SACH;QAED,IAAI,OAAO,EAAE;YACX,OAAO,eAAK,CAAC,CAAC,IAAI,GAAG,gBAAC,CAAC,UAAU,CAAC,SAAS,CAAC,CAA2B,CAAC,CAAC,KAAK,CAC5E,IAAI,gBAAC,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAC7B,CAAC;SACH;QAED,MAAM,IAAI,GAAG,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC;QAC9E,OAAO,IAAI,CAAC,CAAC,CAAC,eAAK,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IAC5C,CAAC;;AAjGD;;GAEG;AACa,+BAAc,GAAG;IAC/B,IAAI,EAAE,MAAM;IACZ,OAAO,EAAE,OAAO;IAChB,KAAK,EAAE,KAAK;IACZ,IAAI,EAAE,QAAQ;CACqC,CAAC;AAEtD;;GAEG;AACa,6BAAY,GAAG;IAC7B,CAAC,EAAE,KAAK;IACR,CAAC,EAAE,QAAQ;IACX,CAAC,EAAE,OAAO;IACV,CAAC,EAAE,OAAO;CAC0C,CAAC;AAEvD;;GAEG;AACa,2BAAU,GAAG;IAC3B,IAAI,EAAE,qBAAU,CAAC,IAAI;IACrB,OAAO,EAAE,qBAAU,CAAC,OAAO;IAC3B,KAAK,EAAE,qBAAU,CAAC,KAAK;IACvB,IAAI,EAAE,qBAAU,CAAC,OAAO;IACxB,KAAK,EAAE,IAAA,iBAAO,EAAC,GAAG,CAAC;IACnB,KAAK,EAAE,IAAA,iBAAO,EAAC,GAAG,CAAC;CACgB,CAAC;AAEtC;;GAEG;AACa,8BAAa,GAAG,MAAM,CAAC;AAiEzC;;;;GAIG;AACH,IAAI,WAAW,GAAa,uBAAW,CAAC,6BAAiB,CAAC,CAAC;AAE3D;;GAEG;AACH,MAAM,UAAU,GAAG,cAAc,CAC/B,iBAAO,CAAC,MAAM,CAAC,EAAC,QAAQ,EAAE,EAAC,GAAG,EAAE,UAAU,EAAC,EAAE,SAAS,EAAE,CAAC,IAAI,gBAAgB,EAAE,CAAC,EAAC,CAAC,CACnF,CAAC;AAEF;;;;;;;;;;;;;;;;GAgBG;AACH,SAAS,cAAc,CAAC,MAAe;IACrC,OAAO,IAAI,KAAK,CAAC,MAAM,EAAE;QACvB,GAAG,CAAC,MAAM,EAAE,IAAI,EAAE,QAAQ;YACxB,IAAI,IAAI,KAAK,OAAO,EAAE;gBACpB,OAAO,WAAW,CAAC;aACpB;YACD,IAAI,IAAI,KAAK,QAAQ,EAAE;gBACrB,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,EAAE,QAAQ,CAAsB,CAAC;gBACxE,OAAO,CAAC,IAAoB,EAAE,EAAE,CAAC,cAAc,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC,CAAC;aAC9E;YACD,IAAI,IAAI,KAAK,WAAW,EAAE;gBACxB,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC;gBACrD,OAAO,EAAC,GAAG,QAAQ,EAAE,KAAK,EAAE,WAAW,EAAC,CAAC;aAC1C;YACD,OAAO,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC;QAC7C,CAAC;QACD,GAAG,CAAC,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ;YAC/B,IAAI,IAAI,KAAK,OAAO,EAAE;gBACpB,WAAW,GAAG,KAAiB,CAAC;gBAChC,OAAO,IAAI,CAAC;aACb;YACD,OAAO,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC;QACpD,CAAC;KACF,CAAC,CAAC;AACL,CAAC;AAED;;;GAGG;AACH,kBAAe,UAAU,CAAC"}
|
package/build/lib/util.d.ts
CHANGED
|
@@ -2,8 +2,9 @@
|
|
|
2
2
|
* Utilities
|
|
3
3
|
* @module
|
|
4
4
|
*/
|
|
5
|
+
/// <reference types="node" />
|
|
5
6
|
import _ from 'lodash';
|
|
6
|
-
import
|
|
7
|
+
import { SpawnOptions } from 'node:child_process';
|
|
7
8
|
/**
|
|
8
9
|
* Computes a relative path, prepending `./`
|
|
9
10
|
*/
|
|
@@ -39,7 +40,15 @@ export declare const isStringArray: (value: any) => value is string[];
|
|
|
39
40
|
*/
|
|
40
41
|
export declare const argify: (obj: Record<string, string | number | boolean | undefined>) => string[];
|
|
41
42
|
/**
|
|
42
|
-
*
|
|
43
|
+
* Spawns a long-running "background" child process. This is expected to only return control to the
|
|
44
|
+
* parent process in the case of a nonzero exit code from the child process.
|
|
45
|
+
* @param command Command to run
|
|
46
|
+
* @param args Args to pass to command
|
|
47
|
+
* @param opts Spawn options. `{stdio: 'inherit'}` will always be true
|
|
48
|
+
* @privateRemarks `teen_process` is good for running a one-shot command, but not so great for
|
|
49
|
+
* background tasks; we use node's `child_process` directly here to pass `stdio` through, since
|
|
50
|
+
* `teen_process` basically does not respect `{stdio: 'inherit'}`.
|
|
43
51
|
*/
|
|
44
|
-
export
|
|
52
|
+
export declare function spawnBackgroundProcess(command: string, args: string[], opts: SpawnOptions): Promise<void>;
|
|
53
|
+
export type SpawnBackgroundProcessOpts = Omit<SpawnOptions, 'stdio'>;
|
|
45
54
|
//# sourceMappingURL=util.d.ts.map
|
package/build/lib/util.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"util.d.ts","sourceRoot":"","sources":["../../lib/util.ts"],"names":[],"mappings":"AAAA;;;GAGG
|
|
1
|
+
{"version":3,"file":"util.d.ts","sourceRoot":"","sources":["../../lib/util.ts"],"names":[],"mappings":"AAAA;;;GAGG;;AAEH,OAAO,CAAC,MAAM,QAAQ,CAAC;AACvB,OAAO,EAAC,YAAY,EAAQ,MAAM,oBAAoB,CAAC;AAIvD;;GAEG;AACH,eAAO,MAAM,QAAQ,4CAEpB,CAAC;AAEF;;;;;;GAMG;AACH,wBAAgB,SAAS,CAAC,EAAE,EAAE,MAAM,gBAQnC;yBARe,SAAS;;;AAWzB;;GAEG;AACH,MAAM,MAAM,aAAa,CACvB,CAAC,SAAS,SAAS,GAAG,EAAE,EACxB,CAAC,SAAS,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,EAAE,CAAC,EAAE,WAAW,CAAC,IAC1D;KAAE,CAAC,IAAI,OAAO,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CAAC,CAAC;AAEzD;;;;GAIG;AACH,eAAO,MAAM,aAAa,UACjB,GAAG,sBACU,CAAC;AAEvB;;;;;GAKG;AACH,eAAO,MAAM,MAAM,EAAE,CAAC,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,SAAS,CAAC,KAAK,MAAM,EAcxF,CAAC;AAEJ;;;;;;;;;GASG;AACH,wBAAsB,sBAAsB,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,YAAY,iBAY/F;AAED,MAAM,MAAM,0BAA0B,GAAG,IAAI,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC"}
|
package/build/lib/util.js
CHANGED
|
@@ -7,8 +7,9 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
|
7
7
|
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
8
8
|
};
|
|
9
9
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
10
|
-
exports.argify = exports.isStringArray = exports.stopwatch = exports.relative = void 0;
|
|
10
|
+
exports.spawnBackgroundProcess = exports.argify = exports.isStringArray = exports.stopwatch = exports.relative = void 0;
|
|
11
11
|
const lodash_1 = __importDefault(require("lodash"));
|
|
12
|
+
const node_child_process_1 = require("node:child_process");
|
|
12
13
|
const node_path_1 = __importDefault(require("node:path"));
|
|
13
14
|
/**
|
|
14
15
|
* Computes a relative path, prepending `./`
|
|
@@ -53,4 +54,28 @@ exports.argify = lodash_1.default.flow(lodash_1.default.entries, lodash_1.defaul
|
|
|
53
54
|
}
|
|
54
55
|
return idx % 2 === 0 ? `--${value}` : value;
|
|
55
56
|
}), lodash_1.default.compact);
|
|
57
|
+
/**
|
|
58
|
+
* Spawns a long-running "background" child process. This is expected to only return control to the
|
|
59
|
+
* parent process in the case of a nonzero exit code from the child process.
|
|
60
|
+
* @param command Command to run
|
|
61
|
+
* @param args Args to pass to command
|
|
62
|
+
* @param opts Spawn options. `{stdio: 'inherit'}` will always be true
|
|
63
|
+
* @privateRemarks `teen_process` is good for running a one-shot command, but not so great for
|
|
64
|
+
* background tasks; we use node's `child_process` directly here to pass `stdio` through, since
|
|
65
|
+
* `teen_process` basically does not respect `{stdio: 'inherit'}`.
|
|
66
|
+
*/
|
|
67
|
+
async function spawnBackgroundProcess(command, args, opts) {
|
|
68
|
+
return new Promise((resolve, reject) => {
|
|
69
|
+
(0, node_child_process_1.spawn)(command, args, { ...opts, stdio: 'inherit' })
|
|
70
|
+
.on('error', reject)
|
|
71
|
+
.on('close', (code) => {
|
|
72
|
+
// can be null or number
|
|
73
|
+
if (code) {
|
|
74
|
+
return reject(new Error(`${command} exited with code ${code}`));
|
|
75
|
+
}
|
|
76
|
+
resolve();
|
|
77
|
+
});
|
|
78
|
+
});
|
|
79
|
+
}
|
|
80
|
+
exports.spawnBackgroundProcess = spawnBackgroundProcess;
|
|
56
81
|
//# sourceMappingURL=util.js.map
|
package/build/lib/util.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"util.js","sourceRoot":"","sources":["../../lib/util.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;AAEH,oDAAuB;AACvB,0DAA6B;AAG7B;;GAEG;AACU,QAAA,QAAQ,GAAG,gBAAC,CAAC,KAAK,CAC7B,CAAC,IAAY,EAAE,EAAU,EAAU,EAAE,CAAC,IAAI,mBAAI,CAAC,GAAG,GAAG,mBAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,EAAE,CAAC,EAAE,CAC/E,CAAC;AAEF;;;;;;GAMG;AACH,SAAgB,SAAS,CAAC,EAAU;IAClC,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;IACzB,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;IAC/B,OAAO,GAAG,EAAE;QACV,MAAM,MAAM,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAE,CAAC;QACrD,SAAS,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;QAC3B,OAAO,MAAM,CAAC;IAChB,CAAC,CAAC;AACJ,CAAC;AARD,8BAQC;AACD,SAAS,CAAC,KAAK,GAAG,IAAI,GAAG,EAAkB,CAAC;AAU5C;;;;GAIG;AACU,QAAA,aAAa,GAAG,gBAAC,CAAC,SAAS,CAAC,gBAAC,CAAC,OAAO,EAAE,gBAAC,CAAC,OAAO,CAAC,gBAAC,CAAC,KAAK,EAAE,gBAAC,EAAE,gBAAC,CAAC,QAAQ,CAAC,CAE/D,CAAC;AAEvB;;;;;GAKG;AACU,QAAA,MAAM,GACjB,gBAAC,CAAC,IAAI,CACJ,gBAAC,CAAC,OAAO,EACT,gBAAC,CAAC,OAAO,EACT,CAAC,IAAI,EAAE,EAAE,CACP,IAAI,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;IACtB,IAAI,KAAK,KAAK,IAAI,EAAE;QAClB,OAAO,KAAK,KAAK,EAAE,CAAC;KACrB;SAAM,IAAI,KAAK,KAAK,KAAK,IAAI,KAAK,KAAK,SAAS,EAAE;QACjD,OAAO;KACR;IACD,OAAO,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,KAAK,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC;AAC9C,CAAC,CAAC,EACJ,gBAAC,CAAC,OAAO,CACV,CAAC"}
|
|
1
|
+
{"version":3,"file":"util.js","sourceRoot":"","sources":["../../lib/util.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;AAEH,oDAAuB;AACvB,2DAAuD;AACvD,0DAA6B;AAG7B;;GAEG;AACU,QAAA,QAAQ,GAAG,gBAAC,CAAC,KAAK,CAC7B,CAAC,IAAY,EAAE,EAAU,EAAU,EAAE,CAAC,IAAI,mBAAI,CAAC,GAAG,GAAG,mBAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,EAAE,CAAC,EAAE,CAC/E,CAAC;AAEF;;;;;;GAMG;AACH,SAAgB,SAAS,CAAC,EAAU;IAClC,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;IACzB,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;IAC/B,OAAO,GAAG,EAAE;QACV,MAAM,MAAM,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAE,CAAC;QACrD,SAAS,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;QAC3B,OAAO,MAAM,CAAC;IAChB,CAAC,CAAC;AACJ,CAAC;AARD,8BAQC;AACD,SAAS,CAAC,KAAK,GAAG,IAAI,GAAG,EAAkB,CAAC;AAU5C;;;;GAIG;AACU,QAAA,aAAa,GAAG,gBAAC,CAAC,SAAS,CAAC,gBAAC,CAAC,OAAO,EAAE,gBAAC,CAAC,OAAO,CAAC,gBAAC,CAAC,KAAK,EAAE,gBAAC,EAAE,gBAAC,CAAC,QAAQ,CAAC,CAE/D,CAAC;AAEvB;;;;;GAKG;AACU,QAAA,MAAM,GACjB,gBAAC,CAAC,IAAI,CACJ,gBAAC,CAAC,OAAO,EACT,gBAAC,CAAC,OAAO,EACT,CAAC,IAAI,EAAE,EAAE,CACP,IAAI,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;IACtB,IAAI,KAAK,KAAK,IAAI,EAAE;QAClB,OAAO,KAAK,KAAK,EAAE,CAAC;KACrB;SAAM,IAAI,KAAK,KAAK,KAAK,IAAI,KAAK,KAAK,SAAS,EAAE;QACjD,OAAO;KACR;IACD,OAAO,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,KAAK,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC;AAC9C,CAAC,CAAC,EACJ,gBAAC,CAAC,OAAO,CACV,CAAC;AAEJ;;;;;;;;;GASG;AACI,KAAK,UAAU,sBAAsB,CAAC,OAAe,EAAE,IAAc,EAAE,IAAkB;IAC9F,OAAO,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QAC3C,IAAA,0BAAK,EAAC,OAAO,EAAE,IAAI,EAAE,EAAC,GAAG,IAAI,EAAE,KAAK,EAAE,SAAS,EAAC,CAAC;aAC9C,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC;aACnB,EAAE,CAAC,OAAO,EAAE,CAAC,IAAI,EAAE,EAAE;YACpB,wBAAwB;YACxB,IAAI,IAAI,EAAE;gBACR,OAAO,MAAM,CAAC,IAAI,KAAK,CAAC,GAAG,OAAO,qBAAqB,IAAI,EAAE,CAAC,CAAC,CAAC;aACjE;YACD,OAAO,EAAE,CAAC;QACZ,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACL,CAAC;AAZD,wDAYC"}
|
package/lib/builder/deploy.ts
CHANGED
|
@@ -5,8 +5,8 @@
|
|
|
5
5
|
*/
|
|
6
6
|
|
|
7
7
|
import _ from 'lodash';
|
|
8
|
-
import {exec, SubProcess, SubProcessOptions, TeenProcessExecOptions} from 'teen_process';
|
|
9
8
|
import path from 'node:path';
|
|
9
|
+
import {exec, TeenProcessExecOptions} from 'teen_process';
|
|
10
10
|
import {
|
|
11
11
|
DEFAULT_DEPLOY_BRANCH,
|
|
12
12
|
DEFAULT_DEPLOY_REMOTE,
|
|
@@ -18,7 +18,7 @@ import {
|
|
|
18
18
|
import {DocutilsError} from '../error';
|
|
19
19
|
import {findMkDocsYml, readPackageJson, whichMike} from '../fs';
|
|
20
20
|
import logger from '../logger';
|
|
21
|
-
import {argify,
|
|
21
|
+
import {argify, spawnBackgroundProcess, SpawnBackgroundProcessOpts, stopwatch} from '../util';
|
|
22
22
|
|
|
23
23
|
const log = logger.withTag('builder:deploy');
|
|
24
24
|
|
|
@@ -30,15 +30,12 @@ const log = logger.withTag('builder:deploy');
|
|
|
30
30
|
*/
|
|
31
31
|
async function doServe(
|
|
32
32
|
args: string[] = [],
|
|
33
|
-
|
|
33
|
+
opts: SpawnBackgroundProcessOpts = {},
|
|
34
34
|
mikePath?: string
|
|
35
35
|
) {
|
|
36
36
|
mikePath = mikePath ?? (await whichMike());
|
|
37
37
|
const finalArgs = ['serve', ...args];
|
|
38
|
-
|
|
39
|
-
log.debug('Launching %s with args: %s', mikePath, finalArgs);
|
|
40
|
-
const proc = new SubProcess(mikePath, finalArgs, opts);
|
|
41
|
-
return await proc.start(startDetector, detach, timeoutMs);
|
|
38
|
+
return spawnBackgroundProcess(mikePath, finalArgs, opts);
|
|
42
39
|
}
|
|
43
40
|
|
|
44
41
|
/**
|
|
@@ -223,7 +220,7 @@ export interface DeployOpts {
|
|
|
223
220
|
execOpts?: TeenProcessExecOptions;
|
|
224
221
|
|
|
225
222
|
/**
|
|
226
|
-
* Extra options for {@linkcode
|
|
223
|
+
* Extra options for {@linkcode spawnBackgroundProcess}
|
|
227
224
|
*/
|
|
228
|
-
serveOpts?:
|
|
225
|
+
serveOpts?: SpawnBackgroundProcessOpts;
|
|
229
226
|
}
|
package/lib/builder/site.ts
CHANGED
|
@@ -5,13 +5,14 @@
|
|
|
5
5
|
* @module
|
|
6
6
|
*/
|
|
7
7
|
|
|
8
|
+
import {spawn, SpawnOptions} from 'node:child_process';
|
|
8
9
|
import path from 'node:path';
|
|
9
|
-
import {exec,
|
|
10
|
-
import {NAME_BIN,
|
|
10
|
+
import {exec, TeenProcessExecOptions} from 'teen_process';
|
|
11
|
+
import {NAME_BIN, NAME_MKDOCS, NAME_MKDOCS_YML, NAME_THEME} from '../constants';
|
|
11
12
|
import {DocutilsError} from '../error';
|
|
12
13
|
import {findMkDocsYml, readMkDocsYml, whichMkDocs} from '../fs';
|
|
13
14
|
import logger from '../logger';
|
|
14
|
-
import {relative,
|
|
15
|
+
import {relative, spawnBackgroundProcess, SpawnBackgroundProcessOpts, stopwatch} from '../util';
|
|
15
16
|
|
|
16
17
|
const log = logger.withTag('mkdocs');
|
|
17
18
|
|
|
@@ -23,15 +24,14 @@ const log = logger.withTag('mkdocs');
|
|
|
23
24
|
*/
|
|
24
25
|
async function doServe(
|
|
25
26
|
args: string[] = [],
|
|
26
|
-
|
|
27
|
+
opts: SpawnBackgroundProcessOpts = {},
|
|
27
28
|
mkDocsPath?: string
|
|
28
29
|
) {
|
|
29
30
|
mkDocsPath = mkDocsPath ?? (await whichMkDocs());
|
|
30
31
|
const finalArgs = ['serve', ...args];
|
|
31
|
-
|
|
32
|
+
|
|
32
33
|
log.debug('Launching %s with args: %s', mkDocsPath, finalArgs);
|
|
33
|
-
|
|
34
|
-
return await proc.start(startDetector, detach, timeoutMs);
|
|
34
|
+
return spawnBackgroundProcess(mkDocsPath, finalArgs, opts);
|
|
35
35
|
}
|
|
36
36
|
|
|
37
37
|
/**
|
|
@@ -138,7 +138,7 @@ export interface BuildMkDocsOpts {
|
|
|
138
138
|
execOpts?: TeenProcessExecOptions;
|
|
139
139
|
|
|
140
140
|
/**
|
|
141
|
-
* Extra options for {@linkcode
|
|
141
|
+
* Extra options for {@linkcode spawnBackgroundProcess}
|
|
142
142
|
*/
|
|
143
|
-
serveOpts?:
|
|
143
|
+
serveOpts?: SpawnBackgroundProcessOpts;
|
|
144
144
|
}
|
package/lib/logger.ts
CHANGED
|
@@ -134,7 +134,7 @@ class DocutilsReporter extends FancyReporter {
|
|
|
134
134
|
*
|
|
135
135
|
* "Global" inasmuch as any logger created from the root logger will use this level.
|
|
136
136
|
*/
|
|
137
|
-
let globalLevel = LogLevelMap[DEFAULT_LOG_LEVEL];
|
|
137
|
+
let globalLevel: LogLevel = LogLevelMap[DEFAULT_LOG_LEVEL];
|
|
138
138
|
|
|
139
139
|
/**
|
|
140
140
|
* The logger from which all loggers are created. This one uses a unique tag and our custom reporter.
|
package/lib/util.ts
CHANGED
|
@@ -4,6 +4,7 @@
|
|
|
4
4
|
*/
|
|
5
5
|
|
|
6
6
|
import _ from 'lodash';
|
|
7
|
+
import {SpawnOptions, spawn} from 'node:child_process';
|
|
7
8
|
import path from 'node:path';
|
|
8
9
|
import type {SubProcess} from 'teen_process';
|
|
9
10
|
|
|
@@ -72,8 +73,27 @@ export const argify: (obj: Record<string, string | number | boolean | undefined>
|
|
|
72
73
|
);
|
|
73
74
|
|
|
74
75
|
/**
|
|
75
|
-
*
|
|
76
|
+
* Spawns a long-running "background" child process. This is expected to only return control to the
|
|
77
|
+
* parent process in the case of a nonzero exit code from the child process.
|
|
78
|
+
* @param command Command to run
|
|
79
|
+
* @param args Args to pass to command
|
|
80
|
+
* @param opts Spawn options. `{stdio: 'inherit'}` will always be true
|
|
81
|
+
* @privateRemarks `teen_process` is good for running a one-shot command, but not so great for
|
|
82
|
+
* background tasks; we use node's `child_process` directly here to pass `stdio` through, since
|
|
83
|
+
* `teen_process` basically does not respect `{stdio: 'inherit'}`.
|
|
76
84
|
*/
|
|
77
|
-
export
|
|
78
|
-
|
|
79
|
-
|
|
85
|
+
export async function spawnBackgroundProcess(command: string, args: string[], opts: SpawnOptions) {
|
|
86
|
+
return new Promise<void>((resolve, reject) => {
|
|
87
|
+
spawn(command, args, {...opts, stdio: 'inherit'})
|
|
88
|
+
.on('error', reject)
|
|
89
|
+
.on('close', (code) => {
|
|
90
|
+
// can be null or number
|
|
91
|
+
if (code) {
|
|
92
|
+
return reject(new Error(`${command} exited with code ${code}`));
|
|
93
|
+
}
|
|
94
|
+
resolve();
|
|
95
|
+
});
|
|
96
|
+
});
|
|
97
|
+
}
|
|
98
|
+
|
|
99
|
+
export type SpawnBackgroundProcessOpts = Omit<SpawnOptions, 'stdio'>;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@appium/docutils",
|
|
3
|
-
"version": "0.3.
|
|
3
|
+
"version": "0.3.1",
|
|
4
4
|
"description": "Documentation generation utilities for Appium and related projects",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"automation",
|
|
@@ -49,9 +49,9 @@
|
|
|
49
49
|
"start": "node ./build/lib/cli/index.js"
|
|
50
50
|
},
|
|
51
51
|
"dependencies": {
|
|
52
|
-
"@appium/support": "^3.1.
|
|
52
|
+
"@appium/support": "^3.1.8",
|
|
53
53
|
"@appium/tsconfig": "^0.2.4",
|
|
54
|
-
"@appium/typedoc-plugin-appium": "^0.5.
|
|
54
|
+
"@appium/typedoc-plugin-appium": "^0.5.2",
|
|
55
55
|
"@sliphua/lilconfig-ts-loader": "3.2.2",
|
|
56
56
|
"chalk": "4.1.2",
|
|
57
57
|
"consola": "2.15.3",
|
|
@@ -67,8 +67,8 @@
|
|
|
67
67
|
"semver": "7.3.8",
|
|
68
68
|
"source-map-support": "0.5.21",
|
|
69
69
|
"teen_process": "2.0.2",
|
|
70
|
-
"type-fest": "3.
|
|
71
|
-
"typedoc": "0.23.
|
|
70
|
+
"type-fest": "3.7.1",
|
|
71
|
+
"typedoc": "0.23.28",
|
|
72
72
|
"typedoc-plugin-markdown": "3.14.0",
|
|
73
73
|
"typedoc-plugin-resolve-crossmodule-references": "0.3.3",
|
|
74
74
|
"typescript": "4.9.5",
|
|
@@ -83,5 +83,5 @@
|
|
|
83
83
|
"publishConfig": {
|
|
84
84
|
"access": "public"
|
|
85
85
|
},
|
|
86
|
-
"gitHead": "
|
|
86
|
+
"gitHead": "d514ebdd7ebd27bb236509d0a3d580f0f18a34e5"
|
|
87
87
|
}
|
package/requirements.txt
CHANGED