@appium/docutils 0.2.1 → 0.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +1 -1
- package/build/lib/builder/deploy.d.ts.map +1 -1
- package/build/lib/builder/deploy.js +6 -2
- package/build/lib/builder/deploy.js.map +1 -1
- package/build/lib/builder/index.d.ts +4 -0
- package/build/lib/builder/index.d.ts.map +1 -1
- package/build/lib/builder/index.js +4 -0
- package/build/lib/builder/index.js.map +1 -1
- package/build/lib/builder/nav.d.ts +1 -1
- package/build/lib/builder/nav.d.ts.map +1 -1
- package/build/lib/builder/nav.js +3 -3
- package/build/lib/builder/nav.js.map +1 -1
- package/build/lib/builder/reference.d.ts +1 -1
- package/build/lib/builder/reference.d.ts.map +1 -1
- package/build/lib/builder/reference.js +1 -19
- package/build/lib/builder/reference.js.map +1 -1
- package/build/lib/builder/site.d.ts.map +1 -1
- package/build/lib/builder/site.js +4 -3
- package/build/lib/builder/site.js.map +1 -1
- package/build/lib/cli/check.d.ts +19 -0
- package/build/lib/cli/check.d.ts.map +1 -0
- package/build/lib/cli/check.js +58 -0
- package/build/lib/cli/check.js.map +1 -0
- package/build/lib/cli/command/build.d.ts +42 -29
- package/build/lib/cli/command/build.d.ts.map +1 -1
- package/build/lib/cli/command/build.js +55 -39
- package/build/lib/cli/command/build.js.map +1 -1
- package/build/lib/cli/command/index.d.ts +4 -0
- package/build/lib/cli/command/index.d.ts.map +1 -1
- package/build/lib/cli/command/index.js +4 -0
- package/build/lib/cli/command/index.js.map +1 -1
- package/build/lib/cli/command/init.d.ts +42 -27
- package/build/lib/cli/command/init.d.ts.map +1 -1
- package/build/lib/cli/command/init.js +51 -28
- package/build/lib/cli/command/init.js.map +1 -1
- package/build/lib/cli/command/validate.d.ts +21 -15
- package/build/lib/cli/command/validate.d.ts.map +1 -1
- package/build/lib/cli/command/validate.js +30 -21
- package/build/lib/cli/command/validate.js.map +1 -1
- package/build/lib/cli/config.js +1 -1
- package/build/lib/cli/config.js.map +1 -1
- package/build/lib/cli/index.d.ts.map +1 -1
- package/build/lib/cli/index.js +29 -12
- package/build/lib/cli/index.js.map +1 -1
- package/build/lib/constants.d.ts +4 -0
- package/build/lib/constants.d.ts.map +1 -1
- package/build/lib/constants.js +5 -1
- package/build/lib/constants.js.map +1 -1
- package/build/lib/error.d.ts +5 -0
- package/build/lib/error.d.ts.map +1 -1
- package/build/lib/error.js +5 -0
- package/build/lib/error.js.map +1 -1
- package/build/lib/fs.d.ts +1 -1
- package/build/lib/fs.d.ts.map +1 -1
- package/build/lib/fs.js +2 -2
- package/build/lib/fs.js.map +1 -1
- package/build/lib/index.d.ts +4 -0
- package/build/lib/index.d.ts.map +1 -1
- package/build/lib/index.js +4 -0
- package/build/lib/index.js.map +1 -1
- package/build/lib/init.d.ts +24 -26
- package/build/lib/init.d.ts.map +1 -1
- package/build/lib/init.js +12 -7
- package/build/lib/init.js.map +1 -1
- package/build/lib/logger.js +0 -4
- package/build/lib/logger.js.map +1 -1
- package/build/lib/mike.d.ts.map +1 -1
- package/build/lib/mike.js +4 -0
- package/build/lib/mike.js.map +1 -1
- package/build/lib/model.d.ts +6 -10
- package/build/lib/model.d.ts.map +1 -1
- package/build/lib/scaffold.d.ts +5 -5
- package/build/lib/scaffold.d.ts.map +1 -1
- package/build/lib/util.d.ts +6 -3
- package/build/lib/util.d.ts.map +1 -1
- package/build/lib/util.js.map +1 -1
- package/build/lib/validate.d.ts +5 -2
- package/build/lib/validate.d.ts.map +1 -1
- package/build/lib/validate.js +9 -7
- package/build/lib/validate.js.map +1 -1
- package/lib/builder/deploy.ts +9 -3
- package/lib/builder/index.ts +5 -0
- package/lib/builder/nav.ts +2 -3
- package/lib/builder/reference.ts +2 -22
- package/lib/builder/site.ts +6 -5
- package/lib/cli/check.ts +87 -0
- package/lib/cli/command/build.ts +61 -46
- package/lib/cli/command/index.ts +5 -0
- package/lib/cli/command/init.ts +54 -32
- package/lib/cli/command/validate.ts +35 -28
- package/lib/cli/index.ts +23 -4
- package/lib/constants.ts +5 -0
- package/lib/error.ts +6 -0
- package/lib/fs.ts +6 -3
- package/lib/index.ts +5 -0
- package/lib/init.ts +23 -6
- package/lib/logger.ts +6 -11
- package/lib/mike.js +5 -0
- package/lib/model.ts +3 -9
- package/lib/util.ts +4 -1
- package/lib/validate.ts +10 -9
- package/package.json +10 -12
- package/requirements.txt +1 -1
- package/build/lib/build/mkdocs.d.ts +0 -58
- package/build/lib/build/mkdocs.d.ts.map +0 -1
- package/build/lib/build/mkdocs.js +0 -80
- package/build/lib/build/mkdocs.js.map +0 -1
- package/build/lib/build/typedoc.d.ts +0 -55
- package/build/lib/build/typedoc.d.ts.map +0 -1
- package/build/lib/build/typedoc.js +0 -120
- package/build/lib/build/typedoc.js.map +0 -1
- package/build/lib/build-api.d.ts +0 -18
- package/build/lib/build-api.d.ts.map +0 -1
- package/build/lib/build-api.js +0 -75
- package/build/lib/build-api.js.map +0 -1
- package/build/lib/build.d.ts +0 -21
- package/build/lib/build.d.ts.map +0 -1
- package/build/lib/build.js +0 -71
- package/build/lib/build.js.map +0 -1
- package/build/lib/cli/command/deploy.d.ts +0 -1
- package/build/lib/cli/command/deploy.d.ts.map +0 -1
- package/build/lib/cli/command/deploy.js +0 -2
- package/build/lib/cli/command/deploy.js.map +0 -1
- package/build/lib/cli/command-init.d.ts +0 -143
- package/build/lib/cli/command-init.d.ts.map +0 -1
- package/build/lib/cli/command-init.js +0 -164
- package/build/lib/cli/command-init.js.map +0 -1
- package/build/lib/cli/command-validate.d.ts +0 -52
- package/build/lib/cli/command-validate.d.ts.map +0 -1
- package/build/lib/cli/command-validate.js +0 -66
- package/build/lib/cli/command-validate.js.map +0 -1
- package/build/lib/cli/init.d.ts +0 -143
- package/build/lib/cli/init.d.ts.map +0 -1
- package/build/lib/cli/init.js +0 -164
- package/build/lib/cli/init.js.map +0 -1
- package/build/lib/cli/options.d.ts +0 -1
- package/build/lib/cli/options.d.ts.map +0 -1
- package/build/lib/cli/options.js +0 -2
- package/build/lib/cli/options.js.map +0 -1
- package/build/lib/cli/validate.d.ts +0 -1
- package/build/lib/cli/validate.d.ts.map +0 -1
- package/build/lib/cli/validate.js +0 -2
- package/build/lib/cli/validate.js.map +0 -1
- package/build/lib/cli.d.ts +0 -10
- package/build/lib/cli.d.ts.map +0 -1
- package/build/lib/cli.js +0 -328
- package/build/lib/cli.js.map +0 -1
- package/build/lib/init-task.d.ts +0 -49
- package/build/lib/init-task.d.ts.map +0 -1
- package/build/lib/init-task.js +0 -95
- package/build/lib/init-task.js.map +0 -1
- package/build/lib/io.d.ts +0 -1
- package/build/lib/io.d.ts.map +0 -1
- package/build/lib/io.js +0 -2
- package/build/lib/io.js.map +0 -1
- package/build/lib/mkdocs.d.ts +0 -58
- package/build/lib/mkdocs.d.ts.map +0 -1
- package/build/lib/mkdocs.js +0 -77
- package/build/lib/mkdocs.js.map +0 -1
- package/build/lib/nav.d.ts +0 -47
- package/build/lib/nav.d.ts.map +0 -1
- package/build/lib/nav.js +0 -132
- package/build/lib/nav.js.map +0 -1
- package/build/lib/test.d.ts +0 -9
- package/build/lib/test.d.ts.map +0 -1
- package/build/lib/test.js +0 -2
- package/build/lib/test.js.map +0 -1
- package/build/lib/typedoc.d.ts +0 -55
- package/build/lib/typedoc.d.ts.map +0 -1
- package/build/lib/typedoc.js +0 -122
- package/build/lib/typedoc.js.map +0 -1
- package/build/lib/types.d.ts +0 -52
- package/build/lib/types.d.ts.map +0 -1
- package/build/lib/types.js +0 -7
- package/build/lib/types.js.map +0 -1
- package/build/lib/validation/base-validator.d.ts +0 -218
- package/build/lib/validation/base-validator.d.ts.map +0 -1
- package/build/lib/validation/base-validator.js +0 -453
- package/build/lib/validation/base-validator.js.map +0 -1
- package/build/lib/validation/mkdocs-validator.d.ts +0 -5
- package/build/lib/validation/mkdocs-validator.d.ts.map +0 -1
- package/build/lib/validation/mkdocs-validator.js +0 -54
- package/build/lib/validation/mkdocs-validator.js.map +0 -1
- package/build/lib/validation/python-validator.d.ts +0 -1
- package/build/lib/validation/python-validator.d.ts.map +0 -1
- package/build/lib/validation/python-validator.js +0 -2
- package/build/lib/validation/python-validator.js.map +0 -1
- package/build/lib/validation/python.d.ts +0 -1
- package/build/lib/validation/python.d.ts.map +0 -1
- package/build/lib/validation/python.js +0 -2
- package/build/lib/validation/python.js.map +0 -1
- package/build/lib/validation/validate.d.ts +0 -221
- package/build/lib/validation/validate.d.ts.map +0 -1
- package/build/lib/validation/validate.js +0 -508
- package/build/lib/validation/validate.js.map +0 -1
- package/build/lib/validation/validator.d.ts +0 -220
- package/build/lib/validation/validator.d.ts.map +0 -1
- package/build/lib/validation/validator.js +0 -470
- package/build/lib/validation/validator.js.map +0 -1
- package/build/test/unit/mike.spec.js +0 -17
- package/build/test/unit/mike.spec.js.map +0 -1
package/LICENSE
CHANGED
|
@@ -186,7 +186,7 @@
|
|
|
186
186
|
same "printed page" as the copyright notice for easier
|
|
187
187
|
identification within third-party archives.
|
|
188
188
|
|
|
189
|
-
Copyright
|
|
189
|
+
Copyright OpenJS Foundation and other contributors, https://openjsf.org/
|
|
190
190
|
|
|
191
191
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
192
|
you may not use this file except in compliance with the License.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"deploy.d.ts","sourceRoot":"","sources":["../../../lib/builder/deploy.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAGH,OAAO,
|
|
1
|
+
{"version":3,"file":"deploy.d.ts","sourceRoot":"","sources":["../../../lib/builder/deploy.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAGH,OAAO,EAAsC,sBAAsB,EAAC,MAAM,cAAc,CAAC;AAazF,OAAO,EAAoB,8BAA8B,EAAC,MAAM,SAAS,CAAC;AAoD1E;;;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,8BAA8B,CAAC;CAC5C"}
|
|
@@ -27,8 +27,9 @@ const log = logger_1.default.withTag('builder:deploy');
|
|
|
27
27
|
async function doServe(args = [], { startDetector, detach, timeoutMs } = {}, mikePath) {
|
|
28
28
|
mikePath = mikePath ?? (await (0, fs_1.whichMike)());
|
|
29
29
|
const finalArgs = ['serve', ...args];
|
|
30
|
-
|
|
31
|
-
|
|
30
|
+
const opts = { stdio: 'inherit' };
|
|
31
|
+
log.debug('Launching %s with args: %s', mikePath, finalArgs);
|
|
32
|
+
const proc = new teen_process_1.SubProcess(mikePath, finalArgs, opts);
|
|
32
33
|
return await proc.start(startDetector, detach, timeoutMs);
|
|
33
34
|
}
|
|
34
35
|
/**
|
|
@@ -67,6 +68,8 @@ async function deploy({ mkdocsYml: mkDocsYmlPath, packageJson: packageJsonPath,
|
|
|
67
68
|
throw new error_1.DocutilsError(`Could not find ${constants_1.NAME_MKDOCS_YML} from ${cwd}; run "${constants_1.NAME_BIN} init" to create it`);
|
|
68
69
|
}
|
|
69
70
|
version = version ?? (await findDeployVersion(packageJsonPath, cwd));
|
|
71
|
+
// substitute %s in message with version
|
|
72
|
+
message = message?.replace('%s', version);
|
|
70
73
|
const mikeOpts = {
|
|
71
74
|
'config-file': mkDocsYmlPath,
|
|
72
75
|
push,
|
|
@@ -86,6 +89,7 @@ async function deploy({ mkdocsYml: mkDocsYmlPath, packageJson: packageJsonPath,
|
|
|
86
89
|
if (alias) {
|
|
87
90
|
mikeArgs.push(alias);
|
|
88
91
|
}
|
|
92
|
+
stop(); // discard
|
|
89
93
|
// unsure about how SIGHUP is handled here
|
|
90
94
|
await doServe(mikeArgs, serveOpts);
|
|
91
95
|
}
|
|
@@ -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,+CAAyF;AACzF,0DAA6B;AAC7B,4CAOsB;AACtB,oCAAuC;AACvC,8BAAgE;AAChE,uDAA+B;AAC/B,kCAA0E;AAE1E,MAAM,GAAG,GAAG,gBAAM,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC;AAE7C;;;;;GAKG;AACH,KAAK,UAAU,OAAO,CACpB,OAAiB,EAAE,EACnB,EAAC,aAAa,EAAE,MAAM,EAAE,SAAS,KAAoC,EAAE,EACvE,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,MAAM,IAAI,GAAsB,EAAC,KAAK,EAAE,SAAS,EAAC,CAAC;IACnD,GAAG,CAAC,KAAK,CAAC,4BAA4B,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC;IAC7D,MAAM,IAAI,GAAG,IAAI,yBAAU,CAAC,QAAQ,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC;IACvD,OAAO,MAAM,IAAI,CAAC,KAAK,CAAC,aAAa,EAAE,MAAM,EAAE,SAAS,CAAC,CAAC;AAC5D,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"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../lib/builder/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,cAAc,QAAQ,CAAC;AACvB,cAAc,aAAa,CAAC;AAC5B,cAAc,OAAO,CAAC"}
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../lib/builder/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,cAAc,UAAU,CAAC;AACzB,cAAc,QAAQ,CAAC;AACvB,cAAc,aAAa,CAAC;AAC5B,cAAc,OAAO,CAAC"}
|
|
@@ -1,4 +1,8 @@
|
|
|
1
1
|
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* Exports APIs used by build-related commands
|
|
4
|
+
* @module
|
|
5
|
+
*/
|
|
2
6
|
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
7
|
if (k2 === undefined) k2 = k;
|
|
4
8
|
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../lib/builder/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../lib/builder/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;;;;;;;;;;;AAEH,2CAAyB;AACzB,yCAAuB;AACvB,8CAA4B;AAC5B,wCAAsB"}
|
|
@@ -26,7 +26,7 @@ export declare function parseNav(nav: MkDocsYmlNav): ParsedNavData[];
|
|
|
26
26
|
* @param opts - Options
|
|
27
27
|
* @todo implement `dryRun` option
|
|
28
28
|
*/
|
|
29
|
-
export declare function updateNav({ cwd, mkdocsYml: mkDocsYmlPath, typedocJson: typeDocJsonPath, all,
|
|
29
|
+
export declare function updateNav({ cwd, mkdocsYml: mkDocsYmlPath, typedocJson: typeDocJsonPath, all, }?: UpdateNavOpts): Promise<void>;
|
|
30
30
|
/**
|
|
31
31
|
* Options for {@linkcode updateNav}
|
|
32
32
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"nav.d.ts","sourceRoot":"","sources":["../../../lib/builder/nav.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAuBH,OAAO,EAAY,YAAY,EAAC,MAAM,UAAU,CAAC;AA4BjD;;;;;;;;;;GAUG;AACH,wBAAgB,QAAQ,CAAC,GAAG,EAAE,YAAY,GAAG,aAAa,EAAE,CA+B3D;AAgJD;;;;;;;;GAQG;AACH,wBAAsB,SAAS,CAAC,EAC9B,GAAmB,EACnB,SAAS,EAAE,aAAa,EACxB,WAAW,EAAE,eAAe,EAC5B,GAAW,
|
|
1
|
+
{"version":3,"file":"nav.d.ts","sourceRoot":"","sources":["../../../lib/builder/nav.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAuBH,OAAO,EAAY,YAAY,EAAC,MAAM,UAAU,CAAC;AA4BjD;;;;;;;;;;GAUG;AACH,wBAAgB,QAAQ,CAAC,GAAG,EAAE,YAAY,GAAG,aAAa,EAAE,CA+B3D;AAgJD;;;;;;;;GAQG;AACH,wBAAsB,SAAS,CAAC,EAC9B,GAAmB,EACnB,SAAS,EAAE,aAAa,EACxB,WAAW,EAAE,eAAe,EAC5B,GAAW,GACZ,GAAE,aAAkB,iBAwFpB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;OAGG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,GAAG,CAAC,EAAE,OAAO,CAAC;CACf;AAED;;;GAGG;AACH,UAAU,aAAa;IACrB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;;;OAIG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf"}
|
package/build/lib/builder/nav.js
CHANGED
|
@@ -155,7 +155,7 @@ async function getNavItemsForDir(dir, mkDocsDocsDir, navData, nav, all = false)
|
|
|
155
155
|
// we append indices or names to this keypath
|
|
156
156
|
const rootHeaderKeypath = getRootHeaderKeypath(navHeaderItems, navHeader);
|
|
157
157
|
for (const fileOrUrl of referenceOutputFilepaths) {
|
|
158
|
-
|
|
158
|
+
const offset = navHeaderItems.findIndex((item) => item.fileOrUrl === fileOrUrl);
|
|
159
159
|
const newOffset = offset >= 0 ? offset : navHeaderItems.length;
|
|
160
160
|
const data = navHeaderItems[offset];
|
|
161
161
|
log.warn(rootHeaderKeypath, newOffset, data);
|
|
@@ -173,7 +173,7 @@ async function getNavItemsForDir(dir, mkDocsDocsDir, navData, nav, all = false)
|
|
|
173
173
|
}
|
|
174
174
|
else {
|
|
175
175
|
log.debug('No items found in header %s', navHeader);
|
|
176
|
-
|
|
176
|
+
const navOffset = nav.length;
|
|
177
177
|
for (const [idx, newRefFilepath] of referenceOutputFilepaths.entries()) {
|
|
178
178
|
newNavHeaderItems.push({
|
|
179
179
|
keypath: `${navOffset}.${navHeader}.${idx}`,
|
|
@@ -206,7 +206,7 @@ function applyNavData(newData, mkDocsYml) {
|
|
|
206
206
|
* @param opts - Options
|
|
207
207
|
* @todo implement `dryRun` option
|
|
208
208
|
*/
|
|
209
|
-
async function updateNav({ cwd = process.cwd(), mkdocsYml: mkDocsYmlPath, typedocJson: typeDocJsonPath, all = false,
|
|
209
|
+
async function updateNav({ cwd = process.cwd(), mkdocsYml: mkDocsYmlPath, typedocJson: typeDocJsonPath, all = false, } = {}) {
|
|
210
210
|
// we need `mkdocs.yml` to update
|
|
211
211
|
// and we need `typedoc.json` to know where to look for the command docs
|
|
212
212
|
[mkDocsYmlPath, typeDocJsonPath] = await Promise.all([
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"nav.js","sourceRoot":"","sources":["../../../lib/builder/nav.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;;;;AAEH,6CAAmC;AACnC,oDAAuB;AACvB,0DAA6B;AAC7B,4CAMsB;AACtB,oCAAuC;AACvC,8BAQe;AACf,uDAA+B;AAE/B,kCAAiC;AAEjC,MAAM,GAAG,GAAG,gBAAM,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;AAE1C;;;;;GAKG;AACH,KAAK,UAAU,yBAAyB,CACtC,SAAiB,EACjB,aAAqB;IAErB,IAAI,CAAC,mBAAI,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE;QAC/B,MAAM,IAAI,qBAAa,CAAC,gCAAgC,SAAS,GAAG,CAAC,CAAC;KACvE;IACD,IAAI,CAAC,mBAAI,CAAC,UAAU,CAAC,aAAa,CAAC,EAAE;QACnC,MAAM,IAAI,qBAAa,CAAC,gCAAgC,aAAa,GAAG,CAAC,CAAC;KAC3E;IACD,MAAM,MAAM,GAAG,mBAAI,CAAC,QAAQ,CAAC,aAAa,EAAE,SAAS,CAAC,CAAC;IACvD,MAAM,OAAO,GAAG,MAAM,YAAE,CAAC,OAAO,CAAC,SAAS,EAAE,EAAC,aAAa,EAAE,IAAI,EAAC,CAAC,CAAC;IACnE,OAAO,OAAO;SACX,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;SACzD,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,mBAAI,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC;AAC/C,CAAC;AAED;;;;;;;;;;GAUG;AACH,SAAgB,QAAQ,CAAC,GAAiB;IACxC,IAAI,SAAS,GAAoB,EAAE,CAAC;IACpC,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IAKpC,MAAM,KAAK,GAAgB,CAAC,EAAC,OAAO,EAAE,OAAO,EAAE,EAAE,EAAC,CAAC,CAAC;IAEpD,OAAO,KAAK,CAAC,MAAM,EAAE;QACnB,MAAM,EAAC,OAAO,EAAE,OAAO,EAAC,GAAG,KAAK,CAAC,KAAK,EAAG,CAAC;QAC1C,KAAK,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,OAAO,EAAE;YACjC,IAAI,gBAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE;gBACpB,MAAM,OAAO,GAAkB;oBAC7B,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,IAAI,GAAG,EAAE,CAAC,CAAC,CAAC,GAAG;oBAC5C,SAAS,EAAE,IAAI;iBAChB,CAAC;gBAEF,yDAAyD;gBACzD,4CAA4C;gBAC5C,IAAI,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE;oBAC7B,OAAO,CAAC,IAAI,GAAG,GAAG,CAAC;iBACpB;gBACD,SAAS,GAAG,CAAC,GAAG,SAAS,EAAE,OAAO,CAAC,CAAC;aACrC;iBAAM,IAAI,gBAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE;gBAC3B,MAAM,UAAU,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;gBACxC,KAAK,CAAC,IAAI,CAAC,EAAC,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,IAAI,GAAG,EAAE,CAAC,CAAC,CAAC,GAAG,EAAC,CAAC,CAAC;aACjF;SACF;KACF;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AA/BD,4BA+BC;AAED;;;;;GAKG;AACH,SAAS,iBAAiB,CAAC,OAAwB,EAAE,MAAc;IACjE,OAAO,gBAAC,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,gBAAC,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC;AAC9E,CAAC;AAED;;;;;;;GAOG;AACH,SAAS,uBAAuB,CAAC,iBAAyB,EAAE,MAAc,EAAE,IAAoB;IAC9F,OAAO,IAAI,EAAE,IAAI;QACf,CAAC,CAAC,GAAG,iBAAiB,IAAI,MAAM,IAAI,IAAI,CAAC,IAAI,EAAE;QAC/C,CAAC,CAAC,GAAG,iBAAiB,IAAI,MAAM,EAAE,CAAC;AACvC,CAAC;AAED;;;;;;;;GAQG;AACH,SAAS,gBAAgB,CACvB,UAA8C,EAC9C,OAAwB;IAExB,MAAM,IAAI,GAAG,gBAAC,CAAC,OAAO,CACpB,UAAU,EACV,OAAO,EACP,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,KAAK,CAAC,CAAC,OAAO,IAAI,CAAC,CAAC,SAAS,KAAK,CAAC,CAAC,SAAS,CACjE,CAAC;IACF,OAAO,CAAC,gBAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;AAC1B,CAAC;AAED;;;;;GAKG;AACH,SAAS,oBAAoB,CAAC,WAA4B,EAAE,MAAc;IACxE,iGAAiG;IACjG,8FAA8F;IAC9F,yBAAyB;IACzB,MAAM,sBAAsB,GAAG,gBAAC,CAAC,MAAM,CAAC,gBAAC,CAAC,KAAK,CAAC,WAAW,CAAE,CAAC,OAAO,CAAC,CAAC;IAEvE,0DAA0D;IAC1D,6CAA6C;IAC7C,OAAO,sBAAsB,CAAC,KAAK,CAAC,CAAC,EAAE,sBAAsB,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC/F,CAAC;AAED;;;;;;;;;;GAUG;AACH,KAAK,UAAU,iBAAiB,CAC9B,GAAW,EACX,aAAqB,EACrB,OAAwB,EACxB,GAAiB,EACjB,GAAG,GAAG,KAAK;IAEX,IAAI,WAAW,GAAG,KAAK,CAAC;IACxB,MAAM,iBAAiB,GAAkC,EAAE,CAAC;IAC5D,MAAM,wBAAwB,GAAG,MAAM,yBAAyB,CAAC,GAAG,EAAE,aAAa,CAAC,CAAC;IACrF,IAAI,CAAC,wBAAwB,CAAC,MAAM,EAAE;QACpC,GAAG,CAAC,IAAI,CAAC,iDAAiD,EAAE,GAAG,CAAC,CAAC;QACjE,OAAO,EAAC,IAAI,EAAE,EAAE,EAAE,OAAO,EAAE,KAAK,EAAC,CAAC;KACnC;IAED,MAAM,SAAS,GAAG,GAAG,CAAC,CAAC,CAAC,gBAAC,CAAC,SAAS,CAAC,mBAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,8BAAkB,CAAC;IAC7E,MAAM,cAAc,GAAG,iBAAiB,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;IAE7D,2DAA2D;IAC3D,gCAAgC;IAChC,IAAI,cAAc,CAAC,MAAM,EAAE;QACzB,GAAG,CAAC,KAAK,CAAC,+BAA+B,EAAE,cAAc,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;QAC7E,6CAA6C;QAC7C,MAAM,iBAAiB,GAAG,oBAAoB,CAAC,cAAc,EAAE,SAAS,CAAC,CAAC;QAE1E,KAAK,MAAM,SAAS,IAAI,wBAAwB,EAAE;YAChD,
|
|
1
|
+
{"version":3,"file":"nav.js","sourceRoot":"","sources":["../../../lib/builder/nav.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;;;;AAEH,6CAAmC;AACnC,oDAAuB;AACvB,0DAA6B;AAC7B,4CAMsB;AACtB,oCAAuC;AACvC,8BAQe;AACf,uDAA+B;AAE/B,kCAAiC;AAEjC,MAAM,GAAG,GAAG,gBAAM,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;AAE1C;;;;;GAKG;AACH,KAAK,UAAU,yBAAyB,CACtC,SAAiB,EACjB,aAAqB;IAErB,IAAI,CAAC,mBAAI,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE;QAC/B,MAAM,IAAI,qBAAa,CAAC,gCAAgC,SAAS,GAAG,CAAC,CAAC;KACvE;IACD,IAAI,CAAC,mBAAI,CAAC,UAAU,CAAC,aAAa,CAAC,EAAE;QACnC,MAAM,IAAI,qBAAa,CAAC,gCAAgC,aAAa,GAAG,CAAC,CAAC;KAC3E;IACD,MAAM,MAAM,GAAG,mBAAI,CAAC,QAAQ,CAAC,aAAa,EAAE,SAAS,CAAC,CAAC;IACvD,MAAM,OAAO,GAAG,MAAM,YAAE,CAAC,OAAO,CAAC,SAAS,EAAE,EAAC,aAAa,EAAE,IAAI,EAAC,CAAC,CAAC;IACnE,OAAO,OAAO;SACX,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;SACzD,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,mBAAI,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC;AAC/C,CAAC;AAED;;;;;;;;;;GAUG;AACH,SAAgB,QAAQ,CAAC,GAAiB;IACxC,IAAI,SAAS,GAAoB,EAAE,CAAC;IACpC,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IAKpC,MAAM,KAAK,GAAgB,CAAC,EAAC,OAAO,EAAE,OAAO,EAAE,EAAE,EAAC,CAAC,CAAC;IAEpD,OAAO,KAAK,CAAC,MAAM,EAAE;QACnB,MAAM,EAAC,OAAO,EAAE,OAAO,EAAC,GAAG,KAAK,CAAC,KAAK,EAAG,CAAC;QAC1C,KAAK,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,OAAO,EAAE;YACjC,IAAI,gBAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE;gBACpB,MAAM,OAAO,GAAkB;oBAC7B,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,IAAI,GAAG,EAAE,CAAC,CAAC,CAAC,GAAG;oBAC5C,SAAS,EAAE,IAAI;iBAChB,CAAC;gBAEF,yDAAyD;gBACzD,4CAA4C;gBAC5C,IAAI,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE;oBAC7B,OAAO,CAAC,IAAI,GAAG,GAAG,CAAC;iBACpB;gBACD,SAAS,GAAG,CAAC,GAAG,SAAS,EAAE,OAAO,CAAC,CAAC;aACrC;iBAAM,IAAI,gBAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE;gBAC3B,MAAM,UAAU,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;gBACxC,KAAK,CAAC,IAAI,CAAC,EAAC,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,IAAI,GAAG,EAAE,CAAC,CAAC,CAAC,GAAG,EAAC,CAAC,CAAC;aACjF;SACF;KACF;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AA/BD,4BA+BC;AAED;;;;;GAKG;AACH,SAAS,iBAAiB,CAAC,OAAwB,EAAE,MAAc;IACjE,OAAO,gBAAC,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,gBAAC,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC;AAC9E,CAAC;AAED;;;;;;;GAOG;AACH,SAAS,uBAAuB,CAAC,iBAAyB,EAAE,MAAc,EAAE,IAAoB;IAC9F,OAAO,IAAI,EAAE,IAAI;QACf,CAAC,CAAC,GAAG,iBAAiB,IAAI,MAAM,IAAI,IAAI,CAAC,IAAI,EAAE;QAC/C,CAAC,CAAC,GAAG,iBAAiB,IAAI,MAAM,EAAE,CAAC;AACvC,CAAC;AAED;;;;;;;;GAQG;AACH,SAAS,gBAAgB,CACvB,UAA8C,EAC9C,OAAwB;IAExB,MAAM,IAAI,GAAG,gBAAC,CAAC,OAAO,CACpB,UAAU,EACV,OAAO,EACP,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,KAAK,CAAC,CAAC,OAAO,IAAI,CAAC,CAAC,SAAS,KAAK,CAAC,CAAC,SAAS,CACjE,CAAC;IACF,OAAO,CAAC,gBAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;AAC1B,CAAC;AAED;;;;;GAKG;AACH,SAAS,oBAAoB,CAAC,WAA4B,EAAE,MAAc;IACxE,iGAAiG;IACjG,8FAA8F;IAC9F,yBAAyB;IACzB,MAAM,sBAAsB,GAAG,gBAAC,CAAC,MAAM,CAAC,gBAAC,CAAC,KAAK,CAAC,WAAW,CAAE,CAAC,OAAO,CAAC,CAAC;IAEvE,0DAA0D;IAC1D,6CAA6C;IAC7C,OAAO,sBAAsB,CAAC,KAAK,CAAC,CAAC,EAAE,sBAAsB,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC/F,CAAC;AAED;;;;;;;;;;GAUG;AACH,KAAK,UAAU,iBAAiB,CAC9B,GAAW,EACX,aAAqB,EACrB,OAAwB,EACxB,GAAiB,EACjB,GAAG,GAAG,KAAK;IAEX,IAAI,WAAW,GAAG,KAAK,CAAC;IACxB,MAAM,iBAAiB,GAAkC,EAAE,CAAC;IAC5D,MAAM,wBAAwB,GAAG,MAAM,yBAAyB,CAAC,GAAG,EAAE,aAAa,CAAC,CAAC;IACrF,IAAI,CAAC,wBAAwB,CAAC,MAAM,EAAE;QACpC,GAAG,CAAC,IAAI,CAAC,iDAAiD,EAAE,GAAG,CAAC,CAAC;QACjE,OAAO,EAAC,IAAI,EAAE,EAAE,EAAE,OAAO,EAAE,KAAK,EAAC,CAAC;KACnC;IAED,MAAM,SAAS,GAAG,GAAG,CAAC,CAAC,CAAC,gBAAC,CAAC,SAAS,CAAC,mBAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,8BAAkB,CAAC;IAC7E,MAAM,cAAc,GAAG,iBAAiB,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;IAE7D,2DAA2D;IAC3D,gCAAgC;IAChC,IAAI,cAAc,CAAC,MAAM,EAAE;QACzB,GAAG,CAAC,KAAK,CAAC,+BAA+B,EAAE,cAAc,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;QAC7E,6CAA6C;QAC7C,MAAM,iBAAiB,GAAG,oBAAoB,CAAC,cAAc,EAAE,SAAS,CAAC,CAAC;QAE1E,KAAK,MAAM,SAAS,IAAI,wBAAwB,EAAE;YAChD,MAAM,MAAM,GAAG,cAAc,CAAC,SAAS,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,KAAK,SAAS,CAAC,CAAC;YAChF,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,cAAc,CAAC,MAAM,CAAC;YAC/D,MAAM,IAAI,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC;YACpC,GAAG,CAAC,IAAI,CAAC,iBAAiB,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC;YAC7C,MAAM,OAAO,GAAG,uBAAuB,CAAC,iBAAiB,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC;YAC5E,iBAAiB,CAAC,IAAI,CAAC,EAAC,OAAO,EAAE,SAAS,EAAC,CAAC,CAAC;SAC9C;QAED,uEAAuE;QACvE,IAAI,gBAAgB,CAAC,iBAAiB,EAAE,cAAc,CAAC,EAAE;YACvD,GAAG,CAAC,KAAK,CAAC,2CAA2C,EAAE,SAAS,EAAE,iBAAiB,CAAC,CAAC;YACrF,WAAW,GAAG,IAAI,CAAC;SACpB;aAAM;YACL,GAAG,CAAC,KAAK,CAAC,0BAA0B,EAAE,SAAS,CAAC,CAAC;SAClD;KACF;SAAM;QACL,GAAG,CAAC,KAAK,CAAC,6BAA6B,EAAE,SAAS,CAAC,CAAC;QACpD,MAAM,SAAS,GAAG,GAAG,CAAC,MAAM,CAAC;QAC7B,KAAK,MAAM,CAAC,GAAG,EAAE,cAAc,CAAC,IAAI,wBAAwB,CAAC,OAAO,EAAE,EAAE;YACtE,iBAAiB,CAAC,IAAI,CAAC;gBACrB,OAAO,EAAE,GAAG,SAAS,IAAI,SAAS,IAAI,GAAG,EAAE;gBAC3C,SAAS,EAAE,cAAc;aAC1B,CAAC,CAAC;SACJ;QACD,GAAG,CAAC,KAAK,CAAC,oCAAoC,EAAE,SAAS,CAAC,CAAC;QAC3D,WAAW,GAAG,IAAI,CAAC;KACpB;IACD,OAAO,EAAC,IAAI,EAAE,iBAAiB,EAAE,OAAO,EAAE,WAAW,EAAC,CAAC;AACzD,CAAC;AAED;;;;;;GAMG;AACH,SAAS,YAAY,CAAC,OAAwB,EAAE,SAAoB;IAClE,KAAK,MAAM,EAAC,OAAO,EAAE,SAAS,EAAC,IAAI,OAAO,EAAE;QAC1C,gBAAC,CAAC,GAAG,CAAC,SAAS,EAAE,OAAO,OAAO,EAAE,EAAE,SAAS,CAAC,CAAC;KAC/C;AACH,CAAC;AAED;;;;;;;;GAQG;AACI,KAAK,UAAU,SAAS,CAAC,EAC9B,GAAG,GAAG,OAAO,CAAC,GAAG,EAAE,EACnB,SAAS,EAAE,aAAa,EACxB,WAAW,EAAE,eAAe,EAC5B,GAAG,GAAG,KAAK,MACM,EAAE;IACnB,iCAAiC;IACjC,wEAAwE;IACxE,CAAC,aAAa,EAAE,eAAe,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;QACnD,aAAa,IAAI,IAAA,kBAAa,EAAC,GAAG,CAAC;QACnC,eAAe,IAAI,IAAA,wBAAmB,EAAC,GAAG,CAAC;KAC5C,CAAC,CAAC;IACH,IAAI,CAAC,aAAa,EAAE;QAClB,MAAM,IAAI,qBAAa,CACrB,kBAAkB,2BAAe,SAAS,GAAG,WAAW,oBAAQ,qBAAqB,CACtF,CAAC;KACH;IACD,IAAI,CAAC,eAAe,EAAE;QACpB,MAAM,IAAI,qBAAa,CACrB,kBAAkB,6BAAiB,SAAS,GAAG,WAAW,oBAAQ,qBAAqB,CACxF,CAAC;KACH;IACD,MAAM,YAAY,GAAG,IAAA,eAAQ,EAAC,GAAG,CAAC,CAAC;IACnC,MAAM,gBAAgB,GAAG,YAAY,CAAC,aAAa,CAAC,CAAC;IACrD,MAAM,WAAW,GAAG,IAAA,oBAAe,EAAC,eAAe,CAAC,CAAC;IACrD,MAAM,SAAS,GAAG,CAAC,MAAM,IAAA,aAAQ,EAAC,aAAa,CAAC,CAAc,CAAC;IAE/D;;OAEG;IACH,MAAM,kBAAkB,GAAG,mBAAI,CAAC,UAAU,CAAC,eAAe,CAAC;QACzD,CAAC,CAAC,eAAe;QACjB,CAAC,CAAC,mBAAI,CAAC,OAAO,CAAC,GAAG,EAAE,eAAe,CAAC,CAAC;IAEvC;;OAEG;IACH,MAAM,aAAa,GAAG,mBAAI,CAAC,OAAO,CAChC,mBAAI,CAAC,OAAO,CAAC,kBAAkB,CAAC,EAChC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,wCAA4B,CACjE,CAAC;IAEF;;OAEG;IACH,MAAM,gBAAgB,GAAG,mBAAI,CAAC,UAAU,CAAC,aAAa,CAAC;QACrD,CAAC,CAAC,aAAa;QACf,CAAC,CAAC,mBAAI,CAAC,OAAO,CAAC,GAAG,EAAE,aAAa,CAAC,CAAC;IAErC,MAAM,EAAC,QAAQ,EAAE,OAAO,EAAE,GAAG,GAAG,EAAE,EAAC,GAAG,SAAS,CAAC;IAChD;;OAEG;IACH,MAAM,aAAa,GAAG,mBAAI,CAAC,OAAO,CAAC,mBAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,EAAE,OAAO,IAAI,MAAM,CAAC,CAAC;IAEtF;;;;;;OAMG;IACH,MAAM,IAAI,GAAG,GAAG,CAAC,CAAC,CAAC,MAAM,IAAA,eAAU,EAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,mBAAI,CAAC,IAAI,CAAC,aAAa,EAAE,UAAU,CAAC,CAAC,CAAC;IAE5F,IAAI,oBAAoB,GAAG,KAAK,CAAC;IAEjC,MAAM,OAAO,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC;IAE9B,6DAA6D;IAC7D,8DAA8D;IAC9D,mFAAmF;IACnF,MAAM,OAAO,GAAkC,EAAE,CAAC;IAElD,IAAI,KAAK,EAAE,MAAM,GAAG,IAAI,IAAI,EAAE;QAC5B,MAAM,EAAC,IAAI,EAAE,OAAO,EAAC,GAAG,MAAM,iBAAiB,CAAC,GAAG,EAAE,aAAa,EAAE,OAAO,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;QACvF,IAAI,OAAO,EAAE;YACX,oBAAoB,GAAG,IAAI,CAAC;SAC7B;QACD,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC;KACvB;IAED,IAAI,oBAAoB,EAAE;QACxB,YAAY,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;QACjC,MAAM,IAAI,GAAG,IAAA,kBAAa,EAAC,SAAS,CAAC,CAAC;QACtC,GAAG,CAAC,KAAK,CAAC,oBAAoB,EAAE,aAAa,EAAE,IAAI,CAAC,CAAC;QACrD,MAAM,IAAA,kBAAa,EAAC,aAAa,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;QAC/C,GAAG,CAAC,OAAO,CACT,wGAAwG,EACxG,gBAAgB,CACjB,CAAC;KACH;SAAM;QACL,GAAG,CAAC,IAAI,CAAC,2CAA2C,EAAE,gBAAgB,CAAC,CAAC;KACzE;AACH,CAAC;AA7FD,8BA6FC"}
|
|
@@ -47,7 +47,7 @@ export interface BuildReferenceOptions {
|
|
|
47
47
|
*
|
|
48
48
|
* Used to convert our log level to TypeDoc's
|
|
49
49
|
*/
|
|
50
|
-
|
|
50
|
+
type LogLevelName = 'debug' | 'info' | 'error' | 'warn';
|
|
51
51
|
/**
|
|
52
52
|
* Build reference documentation via TypeDoc
|
|
53
53
|
* @param opts - Options
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"reference.d.ts","sourceRoot":"","sources":["../../../lib/builder/reference.ts"],"names":[],"mappings":"AAAA;;;;GAIG;
|
|
1
|
+
{"version":3,"file":"reference.d.ts","sourceRoot":"","sources":["../../../lib/builder/reference.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAmBH;;;;;;;;GAQG;AACH,wBAAsB,UAAU,CAAC,eAAe,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,iBAmBrF;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,QAAQ,CAAC,EAAE,YAAY,CAAC;CACzB;AAED;;;;GAIG;AACH,KAAK,YAAY,GAAG,OAAO,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,CAAC;AAexD;;;GAGG;AACH,wBAAsB,kBAAkB,CAAC,EACvC,WAAW,EAAE,eAAe,EAC5B,GAAmB,EACnB,YAAY,EAAE,QAAQ,EACtB,QAA4B,EAC5B,KAAK,GACN,GAAE,qBAA0B,iBAyD5B"}
|
|
@@ -10,7 +10,6 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
|
10
10
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
11
11
|
exports.buildReferenceDocs = exports.runTypedoc = void 0;
|
|
12
12
|
const support_1 = require("@appium/support");
|
|
13
|
-
const glob_1 = __importDefault(require("glob"));
|
|
14
13
|
const lodash_1 = __importDefault(require("lodash"));
|
|
15
14
|
const node_path_1 = __importDefault(require("node:path"));
|
|
16
15
|
const typedoc_1 = require("typedoc");
|
|
@@ -20,21 +19,6 @@ const fs_1 = require("../fs");
|
|
|
20
19
|
const logger_1 = __importDefault(require("../logger"));
|
|
21
20
|
const util_1 = require("../util");
|
|
22
21
|
const log = logger_1.default.withTag('builder:reference');
|
|
23
|
-
/**
|
|
24
|
-
* Replaces TypeDoc's homebrew "glob" implementation with a real one
|
|
25
|
-
*
|
|
26
|
-
* This cannot be done via `require('typedoc')` or `import` due to the file being excluded
|
|
27
|
-
* from the export map in its `package.json`.
|
|
28
|
-
* @see https://github.com/TypeStrong/typedoc/issues/2151
|
|
29
|
-
*/
|
|
30
|
-
const monkeyPatchTypedoc = lodash_1.default.once(async () => {
|
|
31
|
-
const typedocDir = await (0, fs_1.findPkgDir)(require.resolve('typedoc'));
|
|
32
|
-
if (!typedocDir) {
|
|
33
|
-
throw new error_1.DocutilsError('Could not find TypeDoc package directory; is it installed?');
|
|
34
|
-
}
|
|
35
|
-
const tdFs = require(node_path_1.default.join(typedocDir, 'dist', 'lib', 'utils', 'fs.js'));
|
|
36
|
-
tdFs.glob = glob_1.default.sync;
|
|
37
|
-
});
|
|
38
22
|
/**
|
|
39
23
|
* Executes TypeDoc _in the current process_
|
|
40
24
|
*
|
|
@@ -45,8 +29,6 @@ const monkeyPatchTypedoc = lodash_1.default.once(async () => {
|
|
|
45
29
|
* @param opts - TypeDoc options
|
|
46
30
|
*/
|
|
47
31
|
async function runTypedoc(typeDocJsonPath, opts) {
|
|
48
|
-
await monkeyPatchTypedoc();
|
|
49
|
-
log.debug('Monkeypatched TypeDoc');
|
|
50
32
|
const args = (0, util_1.argify)(opts);
|
|
51
33
|
log.debug('TypeDoc args:', args);
|
|
52
34
|
const app = new typedoc_1.Application();
|
|
@@ -118,7 +100,7 @@ async function buildReferenceDocs({ typedocJson: typeDocJsonPath, cwd = process.
|
|
|
118
100
|
const extraTypedocOpts = lodash_1.default.pickBy({ tsconfig, name: title, out, logLevel: TypeDocLogLevelMap[logLevel] }, Boolean);
|
|
119
101
|
try {
|
|
120
102
|
await runTypedoc(typeDocJsonPath, extraTypedocOpts);
|
|
121
|
-
|
|
103
|
+
const finalOut = (typeDocJson.out ?? out);
|
|
122
104
|
log.success('Reference docs built at %s (%dms)', node_path_1.default.isAbsolute(finalOut) ? relativePath(finalOut) : finalOut, stop());
|
|
123
105
|
}
|
|
124
106
|
catch (err) {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"reference.js","sourceRoot":"","sources":["../../../lib/builder/reference.ts"],"names":[],"mappings":";AAAA;;;;GAIG;;;;;;AAEH,6CAAmC;AACnC,
|
|
1
|
+
{"version":3,"file":"reference.js","sourceRoot":"","sources":["../../../lib/builder/reference.ts"],"names":[],"mappings":";AAAA;;;;GAIG;;;;;;AAEH,6CAAmC;AACnC,oDAAuB;AACvB,0DAA6B;AAC7B,qCAAoF;AACpF,4CAKsB;AACtB,oCAAuC;AACvC,8BAA2D;AAC3D,uDAA+B;AAC/B,kCAAoD;AAEpD,MAAM,GAAG,GAAG,gBAAM,CAAC,OAAO,CAAC,mBAAmB,CAAC,CAAC;AAEhD;;;;;;;;GAQG;AACI,KAAK,UAAU,UAAU,CAAC,eAAuB,EAAE,IAA4B;IACpF,MAAM,IAAI,GAAG,IAAA,aAAM,EAAC,IAAI,CAAC,CAAC;IAC1B,GAAG,CAAC,KAAK,CAAC,eAAe,EAAE,IAAI,CAAC,CAAC;IACjC,MAAM,GAAG,GAAG,IAAI,qBAAW,EAAE,CAAC;IAC9B,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,QAAQ,EAAE;QAC7B,yBAAyB;QACzB,+CAA+C;QAC/C,+BAA+B;KAChC,CAAC,CAAC;IACH,GAAG,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,uBAAa,EAAE,CAAC,CAAC;IAC3C,GAAG,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,yBAAe,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,CAAC;IACtD,GAAG,CAAC,SAAS,CAAC,EAAC,OAAO,EAAE,mBAAI,CAAC,OAAO,CAAC,eAAe,CAAC,EAAC,CAAC,CAAC;IACxD,MAAM,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IACxC,MAAM,OAAO,GAAG,GAAG,CAAC,OAAO,EAAE,CAAC;IAC9B,IAAI,OAAO,EAAE;QACX,OAAO,MAAM,GAAG,CAAC,YAAY,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;KAC7C;IAED,MAAM,IAAI,qBAAa,CAAC,2DAA2D,CAAC,CAAC;AACvF,CAAC;AAnBD,gCAmBC;AAuCD;;;;;GAKG;AACH,MAAM,kBAAkB,GAAiC;IACvD,KAAK,EAAE,SAAS;IAChB,IAAI,EAAE,MAAM;IACZ,IAAI,EAAE,MAAM;IACZ,KAAK,EAAE,OAAO;CACf,CAAC;AAEF;;;GAGG;AACI,KAAK,UAAU,kBAAkB,CAAC,EACvC,WAAW,EAAE,eAAe,EAC5B,GAAG,GAAG,OAAO,CAAC,GAAG,EAAE,EACnB,YAAY,EAAE,QAAQ,EACtB,QAAQ,GAAG,6BAAiB,EAC5B,KAAK,MACoB,EAAE;IAC3B,MAAM,IAAI,GAAG,IAAA,gBAAS,EAAC,oBAAoB,CAAC,CAAC;IAC7C,eAAe,GAAG,eAAe;QAC/B,CAAC,CAAC,mBAAI,CAAC,OAAO,CAAC,GAAG,EAAE,eAAe,CAAC;QACpC,CAAC,CAAC,MAAM,IAAA,wBAAmB,EAAC,GAAG,CAAC,CAAC;IACnC,IAAI,CAAC,eAAe,EAAE;QACpB,MAAM,IAAI,qBAAa,CACrB,kBAAkB,6BAAiB,SAAS,GAAG,UAAU,oBAAQ,gBAAgB,CAClF,CAAC;KACH;IACD,MAAM,OAAO,GAAG,YAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;IACjC,MAAM,YAAY,GAAG,IAAA,eAAQ,EAAC,GAAG,CAAC,CAAC;IACnC,MAAM,uBAAuB,GAAG,YAAY,CAAC,eAAe,CAAC,CAAC;IAC9D,GAAG,CAAC,KAAK,CAAC,SAAS,uBAAuB,kBAAkB,CAAC,CAAC;IAE9D,IAAI,WAA8C,CAAC;IACnD,sEAAsE;IACtE,IAAI;QACF,WAAW,GAAG,IAAA,oBAAe,EAAC,eAAe,CAAC,CAAC;QAC/C,GAAG,CAAC,KAAK,CAAC,oBAAoB,EAAE,uBAAuB,EAAE,WAAW,CAAC,CAAC;KACvE;IAAC,OAAO,GAAG,EAAE;QACZ,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACf,MAAM,IAAI,qBAAa,CACrB,kBAAkB,uBAAuB,UAAU,oBAAQ,qBAAqB,CACjF,CAAC;KACH;IAED,oFAAoF;IACpF,kGAAkG;IAClG,gGAAgG;IAChG,IAAI,GAAuB,CAAC;IAC5B,IAAI,WAAW,CAAC,GAAG,EAAE;QACnB,GAAG,CAAC,KAAK,CAAC,yBAAyB,6BAAiB,KAAK,WAAW,CAAC,GAAG,EAAE,CAAC,CAAC;KAC7E;SAAM;QACL,GAAG,GAAG,mBAAI,CAAC,QAAQ,CACjB,mBAAI,CAAC,OAAO,CAAC,eAAe,CAAC,EAC7B,mBAAI,CAAC,IAAI,CAAC,OAAO,EAAE,wCAA4B,CAAC,CACjD,CAAC;QACF,GAAG,CAAC,KAAK,CAAC,4BAA4B,EAAE,GAAG,CAAC,CAAC;KAC9C;IAED,MAAM,gBAAgB,GAAG,gBAAC,CAAC,MAAM,CAC/B,EAAC,QAAQ,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,EAAE,QAAQ,EAAE,kBAAkB,CAAC,QAAQ,CAAC,EAAC,EACpE,OAAO,CACkB,CAAC;IAE5B,IAAI;QACF,MAAM,UAAU,CAAC,eAAe,EAAE,gBAAgB,CAAC,CAAC;QACpD,MAAM,QAAQ,GAAG,CAAC,WAAW,CAAC,GAAG,IAAI,GAAG,CAAW,CAAC;QACpD,GAAG,CAAC,OAAO,CACT,mCAAmC,EACnC,mBAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,EAC7D,IAAI,EAAE,CACP,CAAC;KACH;IAAC,OAAO,GAAG,EAAE;QACZ,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;KAChB;AACH,CAAC;AA/DD,gDA+DC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"site.d.ts","sourceRoot":"","sources":["../../../lib/builder/site.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,OAAO,
|
|
1
|
+
{"version":3,"file":"site.d.ts","sourceRoot":"","sources":["../../../lib/builder/site.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,OAAO,EAAsC,sBAAsB,EAAC,MAAM,cAAc,CAAC;AAKzF,OAAO,EAAsB,8BAA8B,EAAC,MAAM,SAAS,CAAC;AAwC5E;;;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,8BAA8B,CAAC;CAC5C"}
|
|
@@ -27,8 +27,9 @@ const log = logger_1.default.withTag('mkdocs');
|
|
|
27
27
|
async function doServe(args = [], { startDetector, detach, timeoutMs } = {}, mkDocsPath) {
|
|
28
28
|
mkDocsPath = mkDocsPath ?? (await (0, fs_1.whichMkDocs)());
|
|
29
29
|
const finalArgs = ['serve', ...args];
|
|
30
|
-
|
|
31
|
-
|
|
30
|
+
const opts = { stdio: 'inherit' };
|
|
31
|
+
log.debug('Launching %s with args: %s', mkDocsPath, finalArgs);
|
|
32
|
+
const proc = new teen_process_1.SubProcess(mkDocsPath, finalArgs, opts);
|
|
32
33
|
return await proc.start(startDetector, detach, timeoutMs);
|
|
33
34
|
}
|
|
34
35
|
/**
|
|
@@ -47,7 +48,7 @@ async function doBuild(args = [], opts = {}, mkDocsPath) {
|
|
|
47
48
|
* Runs `mkdocs build` or `mkdocs serve`
|
|
48
49
|
* @param opts
|
|
49
50
|
*/
|
|
50
|
-
async function buildSite({ mkdocsYml: mkDocsYmlPath, siteDir, theme = constants_1.
|
|
51
|
+
async function buildSite({ mkdocsYml: mkDocsYmlPath, siteDir, theme = constants_1.NAME_THEME, cwd = process.cwd(), serve = false, serveOpts, execOpts, } = {}) {
|
|
51
52
|
const stop = (0, util_1.stopwatch)('build-mkdocs');
|
|
52
53
|
mkDocsYmlPath = mkDocsYmlPath
|
|
53
54
|
? node_path_1.default.resolve(process.cwd(), mkDocsYmlPath)
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"site.js","sourceRoot":"","sources":["../../../lib/builder/site.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;;;;AAEH,0DAA6B;AAC7B,+
|
|
1
|
+
{"version":3,"file":"site.js","sourceRoot":"","sources":["../../../lib/builder/site.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;;;;AAEH,0DAA6B;AAC7B,+CAAyF;AACzF,4CAAmE;AACnE,oCAAuC;AACvC,8BAAgE;AAChE,uDAA+B;AAC/B,kCAA4E;AAE5E,MAAM,GAAG,GAAG,gBAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;AAErC;;;;;GAKG;AACH,KAAK,UAAU,OAAO,CACpB,OAAiB,EAAE,EACnB,EAAC,aAAa,EAAE,MAAM,EAAE,SAAS,KAAoC,EAAE,EACvE,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,MAAM,IAAI,GAAsB,EAAC,KAAK,EAAE,SAAS,EAAC,CAAC;IACnD,GAAG,CAAC,KAAK,CAAC,4BAA4B,EAAE,UAAU,EAAE,SAAS,CAAC,CAAC;IAC/D,MAAM,IAAI,GAAG,IAAI,yBAAU,CAAC,UAAU,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC;IACzD,OAAO,MAAM,IAAI,CAAC,KAAK,CAAC,aAAa,EAAE,MAAM,EAAE,SAAS,CAAC,CAAC;AAC5D,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"}
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Provides functions to validate user-provided options as part of Yargs' post-parsing "check" phase
|
|
3
|
+
* @module
|
|
4
|
+
*/
|
|
5
|
+
import type { Options } from 'yargs';
|
|
6
|
+
/**
|
|
7
|
+
* Takes user-provided paths and checks for existence.
|
|
8
|
+
*
|
|
9
|
+
* Filters options to consider based on group name only.
|
|
10
|
+
*
|
|
11
|
+
* Meant to be used as a "fail-fast" strategy on the CLI, so we don't go all the way through some
|
|
12
|
+
* expensive behavior before realizing we're missing a path.
|
|
13
|
+
* @param opts Options object for a yargs command
|
|
14
|
+
* @param group Group name to filter on
|
|
15
|
+
* @param argv User-provided args
|
|
16
|
+
* @returns `true` if all paths exist or otherwise an error message
|
|
17
|
+
*/
|
|
18
|
+
export declare function checkMissingPaths<T extends Record<string, Options>>(opts: T, group: string, argv: Record<string, unknown>): Promise<true | string>;
|
|
19
|
+
//# sourceMappingURL=check.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"check.d.ts","sourceRoot":"","sources":["../../../lib/cli/check.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,KAAK,EAAC,OAAO,EAAC,MAAM,OAAO,CAAC;AAgCnC;;;;;;;;;;;GAWG;AACH,wBAAsB,iBAAiB,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACvE,IAAI,EAAE,CAAC,EACP,KAAK,EAAE,MAAM,EACb,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC5B,OAAO,CAAC,IAAI,GAAG,MAAM,CAAC,CA+BxB"}
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* Provides functions to validate user-provided options as part of Yargs' post-parsing "check" phase
|
|
4
|
+
* @module
|
|
5
|
+
*/
|
|
6
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
7
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
8
|
+
};
|
|
9
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
10
|
+
exports.checkMissingPaths = void 0;
|
|
11
|
+
const support_1 = require("@appium/support");
|
|
12
|
+
const lodash_1 = __importDefault(require("lodash"));
|
|
13
|
+
const logger_1 = __importDefault(require("../logger"));
|
|
14
|
+
const log = logger_1.default.withTag('check');
|
|
15
|
+
/**
|
|
16
|
+
* Given a list of objects with `id` and `path` props, filters out the ones that do not exist
|
|
17
|
+
* @param paths Filepaths
|
|
18
|
+
* @returns Missing files
|
|
19
|
+
*/
|
|
20
|
+
async function filterMissing(paths) {
|
|
21
|
+
const exists = await Promise.all(paths.map(async ({ id, path }) => ({ id, path, exists: await support_1.fs.exists(path) })));
|
|
22
|
+
const results = lodash_1.default.reject(exists, 'exists');
|
|
23
|
+
return lodash_1.default.map(results, (result) => lodash_1.default.omit(result, 'exists'));
|
|
24
|
+
}
|
|
25
|
+
/**
|
|
26
|
+
* Takes user-provided paths and checks for existence.
|
|
27
|
+
*
|
|
28
|
+
* Filters options to consider based on group name only.
|
|
29
|
+
*
|
|
30
|
+
* Meant to be used as a "fail-fast" strategy on the CLI, so we don't go all the way through some
|
|
31
|
+
* expensive behavior before realizing we're missing a path.
|
|
32
|
+
* @param opts Options object for a yargs command
|
|
33
|
+
* @param group Group name to filter on
|
|
34
|
+
* @param argv User-provided args
|
|
35
|
+
* @returns `true` if all paths exist or otherwise an error message
|
|
36
|
+
*/
|
|
37
|
+
async function checkMissingPaths(opts, group, argv) {
|
|
38
|
+
const argsToCheck = lodash_1.default.keys(lodash_1.default.pickBy(opts, (opt, id) => opt?.group === group && id in argv));
|
|
39
|
+
// yargs is pretty loose about allowing CLI args multiple times, and the value could potentially
|
|
40
|
+
// be a `string[]` instead of `string`; we don't want to allow more than one path per arg.
|
|
41
|
+
if (!argsToCheck.every((id) => lodash_1.default.isString(argv[id]))) {
|
|
42
|
+
return 'Paths may only be provided once each';
|
|
43
|
+
}
|
|
44
|
+
const pathsToCheck = lodash_1.default.map(argsToCheck, (id) => ({
|
|
45
|
+
id,
|
|
46
|
+
path: String(argv[id]), // this must be a string per the above check
|
|
47
|
+
}));
|
|
48
|
+
log.debug('Checking for existence of %s: %s', support_1.util.pluralize('path', pathsToCheck.length), lodash_1.default.map(pathsToCheck, 'path'));
|
|
49
|
+
const missingPaths = await filterMissing(pathsToCheck);
|
|
50
|
+
if (missingPaths.length) {
|
|
51
|
+
return missingPaths
|
|
52
|
+
.map(({ id, path }) => `Path specified using --${lodash_1.default.kebabCase(id)} (${path}) does not exist`)
|
|
53
|
+
.join('\n');
|
|
54
|
+
}
|
|
55
|
+
return true;
|
|
56
|
+
}
|
|
57
|
+
exports.checkMissingPaths = checkMissingPaths;
|
|
58
|
+
//# sourceMappingURL=check.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"check.js","sourceRoot":"","sources":["../../../lib/cli/check.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;AAEH,6CAAyC;AACzC,oDAAuB;AAEvB,uDAA+B;AAE/B,MAAM,GAAG,GAAG,gBAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;AAEpC;;;;GAIG;AACH,KAAK,UAAU,aAAa,CAAC,KAAwB;IACnD,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,GAAG,CAC9B,KAAK,CAAC,GAAG,CAAC,KAAK,EAAE,EAAC,EAAE,EAAE,IAAI,EAAC,EAAE,EAAE,CAAC,CAAC,EAAC,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,YAAE,CAAC,MAAM,CAAC,IAAI,CAAC,EAAC,CAAC,CAAC,CAC7E,CAAC;IACF,MAAM,OAAO,GAAG,gBAAC,CAAC,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IAC3C,OAAO,gBAAC,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,gBAAC,CAAC,IAAI,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC;AAC9D,CAAC;AAgBD;;;;;;;;;;;GAWG;AACI,KAAK,UAAU,iBAAiB,CACrC,IAAO,EACP,KAAa,EACb,IAA6B;IAE7B,MAAM,WAAW,GAAG,gBAAC,CAAC,IAAI,CACxB,gBAAC,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,GAAY,EAAE,EAAU,EAAE,EAAE,CAAC,GAAG,EAAE,KAAK,KAAK,KAAK,IAAI,EAAE,IAAI,IAAI,CAAe,CAC/F,CAAC;IAEF,gGAAgG;IAChG,0FAA0F;IAC1F,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,gBAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE;QACpD,OAAO,sCAAsC,CAAC;KAC/C;IAED,MAAM,YAAY,GAAsB,gBAAC,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;QAClE,EAAE;QACF,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,EAAE,4CAA4C;KACrE,CAAC,CAAC,CAAC;IAEJ,GAAG,CAAC,KAAK,CACP,kCAAkC,EAClC,cAAI,CAAC,SAAS,CAAC,MAAM,EAAE,YAAY,CAAC,MAAM,CAAC,EAC3C,gBAAC,CAAC,GAAG,CAAC,YAAY,EAAE,MAAM,CAAC,CAC5B,CAAC;IAEF,MAAM,YAAY,GAAG,MAAM,aAAa,CAAC,YAAY,CAAC,CAAC;IAEvD,IAAI,YAAY,CAAC,MAAM,EAAE;QACvB,OAAO,YAAY;aAChB,GAAG,CAAC,CAAC,EAAC,EAAE,EAAE,IAAI,EAAC,EAAE,EAAE,CAAC,0BAA0B,gBAAC,CAAC,SAAS,CAAC,EAAE,CAAC,KAAK,IAAI,kBAAkB,CAAC;aACzF,IAAI,CAAC,IAAI,CAAC,CAAC;KACf;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AAnCD,8CAmCC"}
|
|
@@ -1,41 +1,53 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
1
|
+
/**
|
|
2
|
+
* Yargs command module for the `build` command.
|
|
3
|
+
* @module
|
|
4
|
+
*/
|
|
5
|
+
import type { CommandModule, InferredOptionTypes } from 'yargs';
|
|
6
|
+
declare enum BuildCommandGroup {
|
|
7
|
+
Build = "Build Config:",
|
|
8
|
+
Deploy = "Deployment Config:",
|
|
9
|
+
Serve = "Dev Server Config:",
|
|
10
|
+
BuildPaths = "Custom Paths:"
|
|
11
|
+
}
|
|
12
|
+
declare const _default: CommandModule<object, InferredOptionTypes<{
|
|
3
13
|
readonly reference: {
|
|
4
14
|
readonly describe: "Run TypeDoc command API reference build (Markdown)";
|
|
5
|
-
readonly group:
|
|
15
|
+
readonly group: BuildCommandGroup.Build;
|
|
6
16
|
readonly type: "boolean";
|
|
7
17
|
readonly default: true;
|
|
8
18
|
};
|
|
9
19
|
readonly site: {
|
|
10
20
|
readonly describe: "Run MkDocs build (HTML)";
|
|
11
|
-
readonly group:
|
|
21
|
+
readonly group: BuildCommandGroup.Build;
|
|
12
22
|
readonly type: "boolean";
|
|
13
23
|
readonly default: true;
|
|
14
24
|
};
|
|
15
25
|
readonly 'site-dir': {
|
|
16
26
|
readonly alias: "d";
|
|
17
27
|
readonly describe: "HTML output directory";
|
|
18
|
-
readonly group:
|
|
28
|
+
readonly group: BuildCommandGroup.Build;
|
|
19
29
|
readonly nargs: 1;
|
|
20
30
|
readonly requiresArg: true;
|
|
21
31
|
readonly type: "string";
|
|
22
32
|
readonly normalize: true;
|
|
33
|
+
readonly coerce: (...paths: string[]) => string;
|
|
23
34
|
readonly implies: "site";
|
|
24
35
|
readonly defaultDescription: "(from mkdocs.yml)";
|
|
25
36
|
};
|
|
26
37
|
readonly 'package-json': {
|
|
27
38
|
readonly defaultDescription: "./package.json";
|
|
28
39
|
readonly describe: "Path to package.json";
|
|
29
|
-
readonly group:
|
|
40
|
+
readonly group: BuildCommandGroup.BuildPaths;
|
|
30
41
|
readonly nargs: 1;
|
|
31
42
|
readonly normalize: true;
|
|
43
|
+
readonly coerce: (...paths: string[]) => string;
|
|
32
44
|
readonly requiresArg: true;
|
|
33
45
|
readonly type: "string";
|
|
34
46
|
};
|
|
35
47
|
readonly title: {
|
|
36
48
|
readonly defaultDescription: "(extension package name)";
|
|
37
49
|
readonly describe: "Title of the API reference";
|
|
38
|
-
readonly group:
|
|
50
|
+
readonly group: BuildCommandGroup.Build;
|
|
39
51
|
readonly nargs: 1;
|
|
40
52
|
readonly requiresArg: true;
|
|
41
53
|
readonly type: "string";
|
|
@@ -43,45 +55,48 @@ declare const opts: {
|
|
|
43
55
|
readonly 'tsconfig-json': {
|
|
44
56
|
readonly defaultDescription: "./tsconfig.json";
|
|
45
57
|
readonly describe: "Path to tsconfig.json";
|
|
46
|
-
readonly group:
|
|
58
|
+
readonly group: BuildCommandGroup.BuildPaths;
|
|
47
59
|
readonly nargs: 1;
|
|
48
60
|
readonly normalize: true;
|
|
49
61
|
readonly requiresArg: true;
|
|
62
|
+
readonly coerce: (...paths: string[]) => string;
|
|
50
63
|
readonly type: "string";
|
|
51
64
|
};
|
|
52
65
|
readonly 'mkdocs-yml': {
|
|
53
66
|
readonly defaultDescription: "./mkdocs.yml";
|
|
54
67
|
readonly description: "Path to mkdocs.yml";
|
|
55
|
-
readonly group:
|
|
68
|
+
readonly group: BuildCommandGroup.BuildPaths;
|
|
56
69
|
readonly nargs: 1;
|
|
57
70
|
readonly normalize: true;
|
|
58
71
|
readonly requiresArg: true;
|
|
72
|
+
readonly coerce: (...paths: string[]) => string;
|
|
59
73
|
readonly type: "string";
|
|
60
74
|
};
|
|
61
75
|
readonly 'typedoc-json': {
|
|
62
76
|
readonly defaultDescription: "./typedoc.json";
|
|
63
77
|
readonly describe: "Path to typedoc.json";
|
|
64
|
-
readonly group:
|
|
78
|
+
readonly group: BuildCommandGroup.BuildPaths;
|
|
65
79
|
readonly nargs: 1;
|
|
66
80
|
readonly normalize: true;
|
|
67
81
|
readonly requiresArg: true;
|
|
82
|
+
readonly coerce: (...paths: string[]) => string;
|
|
68
83
|
readonly type: "string";
|
|
69
84
|
};
|
|
70
85
|
readonly all: {
|
|
71
86
|
readonly describe: "Output all reference docs (not just Appium comands)";
|
|
72
|
-
readonly group:
|
|
87
|
+
readonly group: BuildCommandGroup.Build;
|
|
73
88
|
readonly implies: "site";
|
|
74
89
|
readonly type: "boolean";
|
|
75
90
|
};
|
|
76
91
|
readonly deploy: {
|
|
77
|
-
readonly describe: "Commit HTML output";
|
|
78
|
-
readonly group:
|
|
92
|
+
readonly describe: "Commit HTML output to a branch using mike";
|
|
93
|
+
readonly group: BuildCommandGroup.Deploy;
|
|
79
94
|
readonly type: "boolean";
|
|
80
95
|
readonly implies: "site";
|
|
81
96
|
};
|
|
82
97
|
readonly push: {
|
|
83
98
|
readonly describe: "Push after deploy";
|
|
84
|
-
readonly group:
|
|
99
|
+
readonly group: BuildCommandGroup.Deploy;
|
|
85
100
|
readonly type: "boolean";
|
|
86
101
|
readonly implies: "deploy";
|
|
87
102
|
};
|
|
@@ -89,7 +104,7 @@ declare const opts: {
|
|
|
89
104
|
readonly alias: "b";
|
|
90
105
|
readonly describe: "Branch to commit to";
|
|
91
106
|
readonly implies: "deploy";
|
|
92
|
-
readonly group:
|
|
107
|
+
readonly group: BuildCommandGroup.Deploy;
|
|
93
108
|
readonly type: "string";
|
|
94
109
|
readonly requiresArg: true;
|
|
95
110
|
readonly nargs: 1;
|
|
@@ -99,7 +114,7 @@ declare const opts: {
|
|
|
99
114
|
readonly alias: "r";
|
|
100
115
|
readonly describe: "Remote to push to";
|
|
101
116
|
readonly implies: readonly ["deploy", "push"];
|
|
102
|
-
readonly group:
|
|
117
|
+
readonly group: BuildCommandGroup.Deploy;
|
|
103
118
|
readonly type: "string";
|
|
104
119
|
readonly requiresArg: true;
|
|
105
120
|
readonly nargs: 1;
|
|
@@ -108,16 +123,16 @@ declare const opts: {
|
|
|
108
123
|
readonly prefix: {
|
|
109
124
|
readonly describe: "Subdirectory within <branch> to commit to";
|
|
110
125
|
readonly implies: readonly ["deploy", "branch"];
|
|
111
|
-
readonly group:
|
|
126
|
+
readonly group: BuildCommandGroup.Deploy;
|
|
112
127
|
readonly type: "string";
|
|
113
128
|
readonly nargs: 1;
|
|
114
129
|
readonly requiresArg: true;
|
|
115
130
|
};
|
|
116
131
|
readonly message: {
|
|
117
132
|
readonly alias: "m";
|
|
118
|
-
readonly describe: "Commit message";
|
|
133
|
+
readonly describe: "Commit message. Use \"%s\" for version placeholder";
|
|
119
134
|
readonly implies: "deploy";
|
|
120
|
-
readonly group:
|
|
135
|
+
readonly group: BuildCommandGroup.Deploy;
|
|
121
136
|
readonly type: "string";
|
|
122
137
|
readonly nargs: 1;
|
|
123
138
|
readonly requiresArg: true;
|
|
@@ -125,7 +140,7 @@ declare const opts: {
|
|
|
125
140
|
readonly 'deploy-version': {
|
|
126
141
|
readonly describe: "Version (directory) to deploy build to";
|
|
127
142
|
readonly implies: "deploy";
|
|
128
|
-
readonly group:
|
|
143
|
+
readonly group: BuildCommandGroup.Deploy;
|
|
129
144
|
readonly type: "string";
|
|
130
145
|
readonly nargs: 1;
|
|
131
146
|
readonly requiresArg: true;
|
|
@@ -134,7 +149,7 @@ declare const opts: {
|
|
|
134
149
|
readonly alias: {
|
|
135
150
|
readonly describe: "Alias for the build (e.g., \"latest\"); triggers alias update";
|
|
136
151
|
readonly implies: "deploy";
|
|
137
|
-
readonly group:
|
|
152
|
+
readonly group: BuildCommandGroup.Deploy;
|
|
138
153
|
readonly type: "string";
|
|
139
154
|
readonly nargs: 1;
|
|
140
155
|
readonly requiresArg: true;
|
|
@@ -143,18 +158,18 @@ declare const opts: {
|
|
|
143
158
|
readonly rebase: {
|
|
144
159
|
readonly describe: "Rebase <branch> with remote before deploy";
|
|
145
160
|
readonly implies: readonly ["deploy", "branch", "remote"];
|
|
146
|
-
readonly group:
|
|
161
|
+
readonly group: BuildCommandGroup.Deploy;
|
|
147
162
|
readonly type: "boolean";
|
|
148
163
|
};
|
|
149
164
|
readonly serve: {
|
|
150
165
|
readonly describe: "Start development server";
|
|
151
|
-
readonly group:
|
|
166
|
+
readonly group: BuildCommandGroup.Serve;
|
|
152
167
|
readonly type: "boolean";
|
|
153
168
|
};
|
|
154
169
|
readonly port: {
|
|
155
170
|
readonly alias: "p";
|
|
156
171
|
readonly describe: "Development server port";
|
|
157
|
-
readonly group:
|
|
172
|
+
readonly group: BuildCommandGroup.Serve;
|
|
158
173
|
readonly type: "number";
|
|
159
174
|
readonly defaultDescription: "8000";
|
|
160
175
|
readonly implies: "serve";
|
|
@@ -164,15 +179,13 @@ declare const opts: {
|
|
|
164
179
|
readonly host: {
|
|
165
180
|
readonly alias: "h";
|
|
166
181
|
readonly describe: "Development server host";
|
|
167
|
-
readonly group:
|
|
182
|
+
readonly group: BuildCommandGroup.Serve;
|
|
168
183
|
readonly type: "string";
|
|
169
184
|
readonly nargs: 1;
|
|
170
185
|
readonly requiresArg: true;
|
|
171
186
|
readonly implies: "serve";
|
|
172
187
|
readonly defaultDescription: "localhost";
|
|
173
188
|
};
|
|
174
|
-
}
|
|
175
|
-
|
|
176
|
-
declare const buildCommand: CommandModule<{}, BuildOptions>;
|
|
177
|
-
export default buildCommand;
|
|
189
|
+
}>>;
|
|
190
|
+
export default _default;
|
|
178
191
|
//# sourceMappingURL=build.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"build.d.ts","sourceRoot":"","sources":["../../../../lib/cli/command/build.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,aAAa,EAAE,mBAAmB,EAAU,MAAM,OAAO,CAAC;
|
|
1
|
+
{"version":3,"file":"build.d.ts","sourceRoot":"","sources":["../../../../lib/cli/command/build.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,KAAK,EAAC,aAAa,EAAE,mBAAmB,EAAU,MAAM,OAAO,CAAC;AASvE,aAAK,iBAAiB;IACpB,KAAK,kBAAkB;IACvB,MAAM,uBAAuB;IAC7B,KAAK,uBAAuB;IAC5B,UAAU,kBAAkB;CAC7B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAuLD,wBAwCyC"}
|