@appium/docutils 0.2.1 → 0.3.0

package/build/lib/cli/command/build.js

@@ -1,54 +1,65 @@
 "use strict";
+/**
+ * Yargs command module for the `build` command.
+ * @module
+ */
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+const node_path_1 = __importDefault(require("node:path"));
 const builder_1 = require("../../builder");
 const constants_1 = require("../../constants");
 const logger_1 = __importDefault(require("../../logger"));
 const util_1 = require("../../util");
+const check_1 = require("../check");
 const log = logger_1.default.withTag('build');
-const NAME_GROUP_BUILD = 'Build Options:';
-const NAME_GROUP_DEPLOY = 'Deployment Options:';
-const NAME_GROUP_SERVE = 'Serve Options:';
-const NAME_GROUP_BUILD_PATHS = 'Paths:';
+var BuildCommandGroup;
+(function (BuildCommandGroup) {
+    BuildCommandGroup["Build"] = "Build Config:";
+    BuildCommandGroup["Deploy"] = "Deployment Config:";
+    BuildCommandGroup["Serve"] = "Dev Server Config:";
+    BuildCommandGroup["BuildPaths"] = "Custom Paths:";
+})(BuildCommandGroup || (BuildCommandGroup = {}));
 const opts = {
     reference: {
         describe: 'Run TypeDoc command API reference build (Markdown)',
-        group: NAME_GROUP_BUILD,
+        group: BuildCommandGroup.Build,
         type: 'boolean',
         default: true,
     },
     site: {
         describe: 'Run MkDocs build (HTML)',
-        group: NAME_GROUP_BUILD,
+        group: BuildCommandGroup.Build,
         type: 'boolean',
         default: true,
     },
     'site-dir': {
         alias: 'd',
         describe: 'HTML output directory',
-        group: NAME_GROUP_BUILD_PATHS,
+        group: BuildCommandGroup.Build,
         nargs: 1,
         requiresArg: true,
         type: 'string',
         normalize: true,
+        coerce: node_path_1.default.resolve,
         implies: 'site',
         defaultDescription: '(from mkdocs.yml)',
     },
     'package-json': {
         defaultDescription: './package.json',
         describe: 'Path to package.json',
-        group: NAME_GROUP_BUILD_PATHS,
+        group: BuildCommandGroup.BuildPaths,
         nargs: 1,
         normalize: true,
+        coerce: node_path_1.default.resolve,
         requiresArg: true,
         type: 'string',
     },
     title: {
         defaultDescription: '(extension package name)',
         describe: 'Title of the API reference',
-        group: NAME_GROUP_BUILD,
+        group: BuildCommandGroup.Build,
         nargs: 1,
         requiresArg: true,
         type: 'string',
@@ -56,45 +67,48 @@ const opts = {
     'tsconfig-json': {
         defaultDescription: './tsconfig.json',
         describe: 'Path to tsconfig.json',
-        group: NAME_GROUP_BUILD_PATHS,
+        group: BuildCommandGroup.BuildPaths,
         nargs: 1,
         normalize: true,
         requiresArg: true,
+        coerce: node_path_1.default.resolve,
         type: 'string',
     },
     'mkdocs-yml': {
         defaultDescription: './mkdocs.yml',
         description: 'Path to mkdocs.yml',
-        group: NAME_GROUP_BUILD_PATHS,
+        group: BuildCommandGroup.BuildPaths,
         nargs: 1,
         normalize: true,
         requiresArg: true,
+        coerce: node_path_1.default.resolve,
         type: 'string',
     },
     'typedoc-json': {
         defaultDescription: './typedoc.json',
         describe: 'Path to typedoc.json',
-        group: NAME_GROUP_BUILD_PATHS,
+        group: BuildCommandGroup.BuildPaths,
         nargs: 1,
         normalize: true,
         requiresArg: true,
+        coerce: node_path_1.default.resolve,
         type: 'string',
     },
     all: {
         describe: 'Output all reference docs (not just Appium comands)',
-        group: NAME_GROUP_BUILD,
+        group: BuildCommandGroup.Build,
         implies: 'site',
         type: 'boolean',
     },
     deploy: {
-        describe: 'Commit HTML output',
-        group: NAME_GROUP_DEPLOY,
+        describe: 'Commit HTML output to a branch using mike',
+        group: BuildCommandGroup.Deploy,
         type: 'boolean',
         implies: 'site',
     },
     push: {
         describe: 'Push after deploy',
-        group: NAME_GROUP_DEPLOY,
+        group: BuildCommandGroup.Deploy,
         type: 'boolean',
         implies: 'deploy',
     },
@@ -102,7 +116,7 @@ const opts = {
         alias: 'b',
         describe: 'Branch to commit to',
         implies: 'deploy',
-        group: NAME_GROUP_DEPLOY,
+        group: BuildCommandGroup.Deploy,
         type: 'string',
         requiresArg: true,
         nargs: 1,
@@ -112,7 +126,7 @@ const opts = {
         alias: 'r',
         describe: 'Remote to push to',
         implies: ['deploy', 'push'],
-        group: NAME_GROUP_DEPLOY,
+        group: BuildCommandGroup.Deploy,
         type: 'string',
         requiresArg: true,
         nargs: 1,
@@ -121,16 +135,16 @@ const opts = {
     prefix: {
         describe: 'Subdirectory within <branch> to commit to',
         implies: ['deploy', 'branch'],
-        group: NAME_GROUP_DEPLOY,
+        group: BuildCommandGroup.Deploy,
         type: 'string',
         nargs: 1,
         requiresArg: true,
     },
     message: {
         alias: 'm',
-        describe: 'Commit message',
+        describe: 'Commit message. Use "%s" for version placeholder',
         implies: 'deploy',
-        group: NAME_GROUP_DEPLOY,
+        group: BuildCommandGroup.Deploy,
         type: 'string',
         nargs: 1,
         requiresArg: true,
@@ -138,7 +152,7 @@ const opts = {
     'deploy-version': {
         describe: 'Version (directory) to deploy build to',
         implies: 'deploy',
-        group: NAME_GROUP_DEPLOY,
+        group: BuildCommandGroup.Deploy,
         type: 'string',
         nargs: 1,
         requiresArg: true,
@@ -147,7 +161,7 @@ const opts = {
     alias: {
         describe: 'Alias for the build (e.g., "latest"); triggers alias update',
         implies: 'deploy',
-        group: NAME_GROUP_DEPLOY,
+        group: BuildCommandGroup.Deploy,
         type: 'string',
         nargs: 1,
         requiresArg: true,
@@ -156,18 +170,18 @@ const opts = {
     rebase: {
         describe: 'Rebase <branch> with remote before deploy',
         implies: ['deploy', 'branch', 'remote'],
-        group: NAME_GROUP_DEPLOY,
+        group: BuildCommandGroup.Deploy,
         type: 'boolean',
     },
     serve: {
         describe: 'Start development server',
-        group: NAME_GROUP_SERVE,
+        group: BuildCommandGroup.Serve,
         type: 'boolean',
     },
     port: {
         alias: 'p',
         describe: 'Development server port',
-        group: NAME_GROUP_SERVE,
+        group: BuildCommandGroup.Serve,
         type: 'number',
         defaultDescription: '8000',
         implies: 'serve',
@@ -177,7 +191,7 @@ const opts = {
     host: {
         alias: 'h',
         describe: 'Development server host',
-        group: NAME_GROUP_SERVE,
+        group: BuildCommandGroup.Serve,
         type: 'string',
         nargs: 1,
         requiresArg: true,
@@ -185,18 +199,21 @@ const opts = {
         defaultDescription: 'localhost',
     },
 };
-opts;
-const buildCommand = {
+exports.default = {
     command: 'build',
-    describe: 'Build Appium extension documentation',
-    builder: (yargs) => yargs.options(opts).check((argv) => {
-        // either this method doesn't provide camel-cased props, or the types are wrong.
-        if (argv.deploy === true && argv['site-dir']) {
-            log.error(`--site-dir is unsupported when running "${constants_1.NAME_BIN} deploy"; use --prefix if needd, but remember that the default behavior is to deploy to the root of the branch (${argv.branch}) instead of a subdirectory`);
-            return false;
-        }
-        return true;
-    }),
+    describe: 'Build Appium extension documentation using TypeDoc & MkDocs',
+    builder(yargs) {
+        return yargs
+            .options(opts)
+            .check(async (argv) => {
+            // either this method doesn't provide camel-cased props, or the types are wrong.
+            if (argv.deploy === true && argv['site-dir']) {
+                return `--site-dir is unsupported when running "${constants_1.NAME_BIN} deploy"; use --prefix if needed, but remember that the default behavior is to deploy to the root of the branch (${argv.branch}) instead of a subdirectory`;
+            }
+            return await (0, check_1.checkMissingPaths)(opts, BuildCommandGroup.BuildPaths, argv);
+        })
+            .epilog('For help with further configuration, see:\n  - MkDocs: https://www.mkdocs.org\n  - TypeDoc: https://typedoc.org\n  - Mike: https://github.com/jimporter/mike');
+    },
     async handler(args) {
         const stop = (0, util_1.stopwatch)('build');
         log.debug('Build command called with args: %O', args);
@@ -219,5 +236,4 @@ const buildCommand = {
         log.success('Done! (total: %dms)', stop());
     },
 };
-exports.default = buildCommand;
 //# sourceMappingURL=build.js.map

package/build/lib/cli/command/build.js.map

@@ -1 +1 @@
-{"version":3,"file":"build.js","sourceRoot":"","sources":["../../../../lib/cli/command/build.ts"],"names":[],"mappings":";;;;;AACA,2CAA+E;AAC/E,+CAAyC;AACzC,0DAAkC;AAClC,qCAAqC;AAErC,MAAM,GAAG,GAAG,gBAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;AAEpC,MAAM,gBAAgB,GAAG,gBAAgB,CAAC;AAC1C,MAAM,iBAAiB,GAAG,qBAAqB,CAAC;AAChD,MAAM,gBAAgB,GAAG,gBAAgB,CAAC;AAC1C,MAAM,sBAAsB,GAAG,QAAQ,CAAC;AAExC,MAAM,IAAI,GAAG;IACX,SAAS,EAAE;QACT,QAAQ,EAAE,oDAAoD;QAC9D,KAAK,EAAE,gBAAgB;QACvB,IAAI,EAAE,SAAS;QACf,OAAO,EAAE,IAAI;KACd;IACD,IAAI,EAAE;QACJ,QAAQ,EAAE,yBAAyB;QACnC,KAAK,EAAE,gBAAgB;QACvB,IAAI,EAAE,SAAS;QACf,OAAO,EAAE,IAAI;KACd;IACD,UAAU,EAAE;QACV,KAAK,EAAE,GAAG;QACV,QAAQ,EAAE,uBAAuB;QACjC,KAAK,EAAE,sBAAsB;QAC7B,KAAK,EAAE,CAAC;QACR,WAAW,EAAE,IAAI;QACjB,IAAI,EAAE,QAAQ;QACd,SAAS,EAAE,IAAI;QACf,OAAO,EAAE,MAAM;QACf,kBAAkB,EAAE,mBAAmB;KACxC;IACD,cAAc,EAAE;QACd,kBAAkB,EAAE,gBAAgB;QACpC,QAAQ,EAAE,sBAAsB;QAChC,KAAK,EAAE,sBAAsB;QAC7B,KAAK,EAAE,CAAC;QACR,SAAS,EAAE,IAAI;QACf,WAAW,EAAE,IAAI;QACjB,IAAI,EAAE,QAAQ;KACf;IACD,KAAK,EAAE;QACL,kBAAkB,EAAE,0BAA0B;QAC9C,QAAQ,EAAE,4BAA4B;QACtC,KAAK,EAAE,gBAAgB;QACvB,KAAK,EAAE,CAAC;QACR,WAAW,EAAE,IAAI;QACjB,IAAI,EAAE,QAAQ;KACf;IACD,eAAe,EAAE;QACf,kBAAkB,EAAE,iBAAiB;QACrC,QAAQ,EAAE,uBAAuB;QACjC,KAAK,EAAE,sBAAsB;QAC7B,KAAK,EAAE,CAAC;QACR,SAAS,EAAE,IAAI;QACf,WAAW,EAAE,IAAI;QACjB,IAAI,EAAE,QAAQ;KACf;IACD,YAAY,EAAE;QACZ,kBAAkB,EAAE,cAAc;QAClC,WAAW,EAAE,oBAAoB;QACjC,KAAK,EAAE,sBAAsB;QAC7B,KAAK,EAAE,CAAC;QACR,SAAS,EAAE,IAAI;QACf,WAAW,EAAE,IAAI;QACjB,IAAI,EAAE,QAAQ;KACf;IACD,cAAc,EAAE;QACd,kBAAkB,EAAE,gBAAgB;QACpC,QAAQ,EAAE,sBAAsB;QAChC,KAAK,EAAE,sBAAsB;QAC7B,KAAK,EAAE,CAAC;QACR,SAAS,EAAE,IAAI;QACf,WAAW,EAAE,IAAI;QACjB,IAAI,EAAE,QAAQ;KACf;IACD,GAAG,EAAE;QACH,QAAQ,EAAE,qDAAqD;QAC/D,KAAK,EAAE,gBAAgB;QACvB,OAAO,EAAE,MAAM;QACf,IAAI,EAAE,SAAS;KAChB;IACD,MAAM,EAAE;QACN,QAAQ,EAAE,oBAAoB;QAC9B,KAAK,EAAE,iBAAiB;QACxB,IAAI,EAAE,SAAS;QACf,OAAO,EAAE,MAAM;KAChB;IACD,IAAI,EAAE;QACJ,QAAQ,EAAE,mBAAmB;QAC7B,KAAK,EAAE,iBAAiB;QACxB,IAAI,EAAE,SAAS;QACf,OAAO,EAAE,QAAQ;KAClB;IACD,MAAM,EAAE;QACN,KAAK,EAAE,GAAG;QACV,QAAQ,EAAE,qBAAqB;QAC/B,OAAO,EAAE,QAAQ;QACjB,KAAK,EAAE,iBAAiB;QACxB,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE,IAAI;QACjB,KAAK,EAAE,CAAC;QACR,kBAAkB,EAAE,UAAU;KAC/B;IACD,MAAM,EAAE;QACN,KAAK,EAAE,GAAG;QACV,QAAQ,EAAE,mBAAmB;QAC7B,OAAO,EAAE,CAAC,QAAQ,EAAE,MAAM,CAAC;QAC3B,KAAK,EAAE,iBAAiB;QACxB,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE,IAAI;QACjB,KAAK,EAAE,CAAC;QACR,kBAAkB,EAAE,QAAQ;KAC7B;IACD,MAAM,EAAE;QACN,QAAQ,EAAE,2CAA2C;QACrD,OAAO,EAAE,CAAC,QAAQ,EAAE,QAAQ,CAAC;QAC7B,KAAK,EAAE,iBAAiB;QACxB,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,CAAC;QACR,WAAW,EAAE,IAAI;KAClB;IACD,OAAO,EAAE;QACP,KAAK,EAAE,GAAG;QACV,QAAQ,EAAE,gBAAgB;QAC1B,OAAO,EAAE,QAAQ;QACjB,KAAK,EAAE,iBAAiB;QACxB,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,CAAC;QACR,WAAW,EAAE,IAAI;KAClB;IACD,gBAAgB,EAAE;QAChB,QAAQ,EAAE,wCAAwC;QAClD,OAAO,EAAE,QAAQ;QACjB,KAAK,EAAE,iBAAiB;QACxB,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,CAAC;QACR,WAAW,EAAE,IAAI;QACjB,kBAAkB,EAAE,6BAA6B;KAClD;IACD,KAAK,EAAE;QACL,QAAQ,EAAE,6DAA6D;QACvE,OAAO,EAAE,QAAQ;QACjB,KAAK,EAAE,iBAAiB;QACxB,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,CAAC;QACR,WAAW,EAAE,IAAI;QACjB,kBAAkB,EAAE,QAAQ;KAC7B;IACD,MAAM,EAAE;QACN,QAAQ,EAAE,2CAA2C;QACrD,OAAO,EAAE,CAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,CAAC;QACvC,KAAK,EAAE,iBAAiB;QACxB,IAAI,EAAE,SAAS;KAChB;IACD,KAAK,EAAE;QACL,QAAQ,EAAE,0BAA0B;QACpC,KAAK,EAAE,gBAAgB;QACvB,IAAI,EAAE,SAAS;KAChB;IACD,IAAI,EAAE;QACJ,KAAK,EAAE,GAAG;QACV,QAAQ,EAAE,yBAAyB;QACnC,KAAK,EAAE,gBAAgB;QACvB,IAAI,EAAE,QAAQ;QACd,kBAAkB,EAAE,MAAM;QAC1B,OAAO,EAAE,OAAO;QAChB,KAAK,EAAE,CAAC;QACR,WAAW,EAAE,IAAI;KAClB;IACD,IAAI,EAAE;QACJ,KAAK,EAAE,GAAG;QACV,QAAQ,EAAE,yBAAyB;QACnC,KAAK,EAAE,gBAAgB;QACvB,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,CAAC;QACR,WAAW,EAAE,IAAI;QACjB,OAAO,EAAE,OAAO;QAChB,kBAAkB,EAAE,WAAW;KAChC;CACO,CAAC;AAEX,IAA+B,CAAC;AAGhC,MAAM,YAAY,GAAoC;IACpD,OAAO,EAAE,OAAO;IAChB,QAAQ,EAAE,sCAAsC;IAChD,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE,CACjB,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,EAAE;QACjC,gFAAgF;QAChF,IAAI,IAAI,CAAC,MAAM,KAAK,IAAI,IAAI,IAAI,CAAC,UAAU,CAAC,EAAE;YAC5C,GAAG,CAAC,KAAK,CACP,2CAA2C,oBAAQ,mHAAmH,IAAI,CAAC,MAAM,6BAA6B,CAC/M,CAAC;YACF,OAAO,KAAK,CAAC;SACd;QACD,OAAO,IAAI,CAAC;IACd,CAAC,CAAC;IACJ,KAAK,CAAC,OAAO,CAAC,IAAI;QAChB,MAAM,IAAI,GAAG,IAAA,gBAAS,EAAC,OAAO,CAAC,CAAC;QAChC,GAAG,CAAC,KAAK,CAAC,oCAAoC,EAAE,IAAI,CAAC,CAAC;QACtD,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;YACjC,oCAAoC;YACpC,MAAM,IAAI,KAAK,CACb,iFAAiF,CAClF,CAAC;SACH;QACD,IAAI,IAAI,CAAC,SAAS,EAAE;YAClB,MAAM,IAAA,4BAAkB,EAAC,IAAI,CAAC,CAAC;SAChC;QACD,IAAI,IAAI,CAAC,IAAI,EAAE;YACb,MAAM,IAAA,mBAAS,EAAC,IAAI,CAAC,CAAC;YACtB,IAAI,IAAI,CAAC,MAAM,EAAE;gBACf,MAAM,IAAA,gBAAM,EAAC,IAAI,CAAC,CAAC;aACpB;iBAAM;gBACL,MAAM,IAAA,mBAAS,EAAC,IAAI,CAAC,CAAC;aACvB;SACF;QACD,GAAG,CAAC,OAAO,CAAC,qBAAqB,EAAE,IAAI,EAAE,CAAC,CAAC;IAC7C,CAAC;CACF,CAAC;AAEF,kBAAe,YAAY,CAAC"}
+{"version":3,"file":"build.js","sourceRoot":"","sources":["../../../../lib/cli/command/build.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;AAEH,0DAA6B;AAE7B,2CAA+E;AAC/E,+CAAyC;AACzC,0DAAkC;AAClC,qCAAqC;AACrC,oCAA2C;AAE3C,MAAM,GAAG,GAAG,gBAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;AAEpC,IAAK,iBAKJ;AALD,WAAK,iBAAiB;IACpB,4CAAuB,CAAA;IACvB,kDAA6B,CAAA;IAC7B,iDAA4B,CAAA;IAC5B,iDAA4B,CAAA;AAC9B,CAAC,EALI,iBAAiB,KAAjB,iBAAiB,QAKrB;AAED,MAAM,IAAI,GAAG;IACX,SAAS,EAAE;QACT,QAAQ,EAAE,oDAAoD;QAC9D,KAAK,EAAE,iBAAiB,CAAC,KAAK;QAC9B,IAAI,EAAE,SAAS;QACf,OAAO,EAAE,IAAI;KACd;IACD,IAAI,EAAE;QACJ,QAAQ,EAAE,yBAAyB;QACnC,KAAK,EAAE,iBAAiB,CAAC,KAAK;QAC9B,IAAI,EAAE,SAAS;QACf,OAAO,EAAE,IAAI;KACd;IACD,UAAU,EAAE;QACV,KAAK,EAAE,GAAG;QACV,QAAQ,EAAE,uBAAuB;QACjC,KAAK,EAAE,iBAAiB,CAAC,KAAK;QAC9B,KAAK,EAAE,CAAC;QACR,WAAW,EAAE,IAAI;QACjB,IAAI,EAAE,QAAQ;QACd,SAAS,EAAE,IAAI;QACf,MAAM,EAAE,mBAAI,CAAC,OAAO;QACpB,OAAO,EAAE,MAAM;QACf,kBAAkB,EAAE,mBAAmB;KACxC;IACD,cAAc,EAAE;QACd,kBAAkB,EAAE,gBAAgB;QACpC,QAAQ,EAAE,sBAAsB;QAChC,KAAK,EAAE,iBAAiB,CAAC,UAAU;QACnC,KAAK,EAAE,CAAC;QACR,SAAS,EAAE,IAAI;QACf,MAAM,EAAE,mBAAI,CAAC,OAAO;QACpB,WAAW,EAAE,IAAI;QACjB,IAAI,EAAE,QAAQ;KACf;IACD,KAAK,EAAE;QACL,kBAAkB,EAAE,0BAA0B;QAC9C,QAAQ,EAAE,4BAA4B;QACtC,KAAK,EAAE,iBAAiB,CAAC,KAAK;QAC9B,KAAK,EAAE,CAAC;QACR,WAAW,EAAE,IAAI;QACjB,IAAI,EAAE,QAAQ;KACf;IACD,eAAe,EAAE;QACf,kBAAkB,EAAE,iBAAiB;QACrC,QAAQ,EAAE,uBAAuB;QACjC,KAAK,EAAE,iBAAiB,CAAC,UAAU;QACnC,KAAK,EAAE,CAAC;QACR,SAAS,EAAE,IAAI;QACf,WAAW,EAAE,IAAI;QACjB,MAAM,EAAE,mBAAI,CAAC,OAAO;QACpB,IAAI,EAAE,QAAQ;KACf;IACD,YAAY,EAAE;QACZ,kBAAkB,EAAE,cAAc;QAClC,WAAW,EAAE,oBAAoB;QACjC,KAAK,EAAE,iBAAiB,CAAC,UAAU;QACnC,KAAK,EAAE,CAAC;QACR,SAAS,EAAE,IAAI;QACf,WAAW,EAAE,IAAI;QACjB,MAAM,EAAE,mBAAI,CAAC,OAAO;QACpB,IAAI,EAAE,QAAQ;KACf;IACD,cAAc,EAAE;QACd,kBAAkB,EAAE,gBAAgB;QACpC,QAAQ,EAAE,sBAAsB;QAChC,KAAK,EAAE,iBAAiB,CAAC,UAAU;QACnC,KAAK,EAAE,CAAC;QACR,SAAS,EAAE,IAAI;QACf,WAAW,EAAE,IAAI;QACjB,MAAM,EAAE,mBAAI,CAAC,OAAO;QACpB,IAAI,EAAE,QAAQ;KACf;IACD,GAAG,EAAE;QACH,QAAQ,EAAE,qDAAqD;QAC/D,KAAK,EAAE,iBAAiB,CAAC,KAAK;QAC9B,OAAO,EAAE,MAAM;QACf,IAAI,EAAE,SAAS;KAChB;IACD,MAAM,EAAE;QACN,QAAQ,EAAE,2CAA2C;QACrD,KAAK,EAAE,iBAAiB,CAAC,MAAM;QAC/B,IAAI,EAAE,SAAS;QACf,OAAO,EAAE,MAAM;KAChB;IACD,IAAI,EAAE;QACJ,QAAQ,EAAE,mBAAmB;QAC7B,KAAK,EAAE,iBAAiB,CAAC,MAAM;QAC/B,IAAI,EAAE,SAAS;QACf,OAAO,EAAE,QAAQ;KAClB;IACD,MAAM,EAAE;QACN,KAAK,EAAE,GAAG;QACV,QAAQ,EAAE,qBAAqB;QAC/B,OAAO,EAAE,QAAQ;QACjB,KAAK,EAAE,iBAAiB,CAAC,MAAM;QAC/B,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE,IAAI;QACjB,KAAK,EAAE,CAAC;QACR,kBAAkB,EAAE,UAAU;KAC/B;IACD,MAAM,EAAE;QACN,KAAK,EAAE,GAAG;QACV,QAAQ,EAAE,mBAAmB;QAC7B,OAAO,EAAE,CAAC,QAAQ,EAAE,MAAM,CAAC;QAC3B,KAAK,EAAE,iBAAiB,CAAC,MAAM;QAC/B,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE,IAAI;QACjB,KAAK,EAAE,CAAC;QACR,kBAAkB,EAAE,QAAQ;KAC7B;IACD,MAAM,EAAE;QACN,QAAQ,EAAE,2CAA2C;QACrD,OAAO,EAAE,CAAC,QAAQ,EAAE,QAAQ,CAAC;QAC7B,KAAK,EAAE,iBAAiB,CAAC,MAAM;QAC/B,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,CAAC;QACR,WAAW,EAAE,IAAI;KAClB;IACD,OAAO,EAAE;QACP,KAAK,EAAE,GAAG;QACV,QAAQ,EAAE,kDAAkD;QAC5D,OAAO,EAAE,QAAQ;QACjB,KAAK,EAAE,iBAAiB,CAAC,MAAM;QAC/B,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,CAAC;QACR,WAAW,EAAE,IAAI;KAClB;IACD,gBAAgB,EAAE;QAChB,QAAQ,EAAE,wCAAwC;QAClD,OAAO,EAAE,QAAQ;QACjB,KAAK,EAAE,iBAAiB,CAAC,MAAM;QAC/B,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,CAAC;QACR,WAAW,EAAE,IAAI;QACjB,kBAAkB,EAAE,6BAA6B;KAClD;IACD,KAAK,EAAE;QACL,QAAQ,EAAE,6DAA6D;QACvE,OAAO,EAAE,QAAQ;QACjB,KAAK,EAAE,iBAAiB,CAAC,MAAM;QAC/B,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,CAAC;QACR,WAAW,EAAE,IAAI;QACjB,kBAAkB,EAAE,QAAQ;KAC7B;IACD,MAAM,EAAE;QACN,QAAQ,EAAE,2CAA2C;QACrD,OAAO,EAAE,CAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,CAAC;QACvC,KAAK,EAAE,iBAAiB,CAAC,MAAM;QAC/B,IAAI,EAAE,SAAS;KAChB;IACD,KAAK,EAAE;QACL,QAAQ,EAAE,0BAA0B;QACpC,KAAK,EAAE,iBAAiB,CAAC,KAAK;QAC9B,IAAI,EAAE,SAAS;KAChB;IACD,IAAI,EAAE;QACJ,KAAK,EAAE,GAAG;QACV,QAAQ,EAAE,yBAAyB;QACnC,KAAK,EAAE,iBAAiB,CAAC,KAAK;QAC9B,IAAI,EAAE,QAAQ;QACd,kBAAkB,EAAE,MAAM;QAC1B,OAAO,EAAE,OAAO;QAChB,KAAK,EAAE,CAAC;QACR,WAAW,EAAE,IAAI;KAClB;IACD,IAAI,EAAE;QACJ,KAAK,EAAE,GAAG;QACV,QAAQ,EAAE,yBAAyB;QACnC,KAAK,EAAE,iBAAiB,CAAC,KAAK;QAC9B,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,CAAC;QACR,WAAW,EAAE,IAAI;QACjB,OAAO,EAAE,OAAO;QAChB,kBAAkB,EAAE,WAAW;KAChC;CACyC,CAAC;AAI7C,kBAAe;IACb,OAAO,EAAE,OAAO;IAChB,QAAQ,EAAE,6DAA6D;IACvE,OAAO,CAAC,KAAK;QACX,OAAO,KAAK;aACT,OAAO,CAAC,IAAI,CAAC;aACb,KAAK,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE;YACpB,gFAAgF;YAChF,IAAI,IAAI,CAAC,MAAM,KAAK,IAAI,IAAI,IAAI,CAAC,UAAU,CAAC,EAAE;gBAC5C,OAAO,2CAA2C,oBAAQ,oHAAoH,IAAI,CAAC,MAAM,6BAA6B,CAAC;aACxN;YAED,OAAO,MAAM,IAAA,yBAAiB,EAAC,IAAI,EAAE,iBAAiB,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;QAC3E,CAAC,CAAC;aACD,MAAM,CACL,8JAA8J,CAC/J,CAAC;IACN,CAAC;IACD,KAAK,CAAC,OAAO,CAAC,IAAI;QAChB,MAAM,IAAI,GAAG,IAAA,gBAAS,EAAC,OAAO,CAAC,CAAC;QAChC,GAAG,CAAC,KAAK,CAAC,oCAAoC,EAAE,IAAI,CAAC,CAAC;QACtD,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;YACjC,oCAAoC;YACpC,MAAM,IAAI,KAAK,CACb,iFAAiF,CAClF,CAAC;SACH;QACD,IAAI,IAAI,CAAC,SAAS,EAAE;YAClB,MAAM,IAAA,4BAAkB,EAAC,IAAI,CAAC,CAAC;SAChC;QACD,IAAI,IAAI,CAAC,IAAI,EAAE;YACb,MAAM,IAAA,mBAAS,EAAC,IAAI,CAAC,CAAC;YACtB,IAAI,IAAI,CAAC,MAAM,EAAE;gBACf,MAAM,IAAA,gBAAM,EAAC,IAAI,CAAC,CAAC;aACpB;iBAAM;gBACL,MAAM,IAAA,mBAAS,EAAC,IAAI,CAAC,CAAC;aACvB;SACF;QACD,GAAG,CAAC,OAAO,CAAC,qBAAqB,EAAE,IAAI,EAAE,CAAC,CAAC;IAC7C,CAAC;CACqC,CAAC"}

package/build/lib/cli/command/index.d.ts

@@ -1,3 +1,7 @@
+/**
+ * Exports all command modules
+ * @module
+ */
 export { default as init } from './init';
 export { default as validate } from './validate';
 export { default as build } from './build';

package/build/lib/cli/command/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../lib/cli/command/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,OAAO,IAAI,IAAI,EAAC,MAAM,QAAQ,CAAC;AACvC,OAAO,EAAC,OAAO,IAAI,QAAQ,EAAC,MAAM,YAAY,CAAC;AAC/C,OAAO,EAAC,OAAO,IAAI,KAAK,EAAC,MAAM,SAAS,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../lib/cli/command/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAC,OAAO,IAAI,IAAI,EAAC,MAAM,QAAQ,CAAC;AACvC,OAAO,EAAC,OAAO,IAAI,QAAQ,EAAC,MAAM,YAAY,CAAC;AAC/C,OAAO,EAAC,OAAO,IAAI,KAAK,EAAC,MAAM,SAAS,CAAC"}

package/build/lib/cli/command/index.js

@@ -1,4 +1,8 @@
 "use strict";
+/**
+ * Exports all command modules
+ * @module
+ */
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };

package/build/lib/cli/command/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../lib/cli/command/index.ts"],"names":[],"mappings":";;;;;;AAAA,+BAAuC;AAA/B,6GAAA,OAAO,OAAQ;AACvB,uCAA+C;AAAvC,qHAAA,OAAO,OAAY;AAC3B,iCAAyC;AAAjC,+GAAA,OAAO,OAAS"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../lib/cli/command/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;AAEH,+BAAuC;AAA/B,6GAAA,OAAO,OAAQ;AACvB,uCAA+C;AAAvC,qHAAA,OAAO,OAAY;AAC3B,iCAAyC;AAAjC,+GAAA,OAAO,OAAS"}

package/build/lib/cli/command/init.d.ts

@@ -1,8 +1,17 @@
-import { CommandModule, InferredOptionTypes } from 'yargs';
-declare const opts: {
+/**
+ * Yargs command module for the `init` command.
+ * @module
+ */
+import type { CommandModule, InferredOptionTypes } from 'yargs';
+declare enum InitCommandGroup {
+    MkDocs = "MkDocs Config:",
+    Paths = "Custom Paths:",
+    Behavior = "Initialization Behavior:"
+}
+declare const _default: CommandModule<object, InferredOptionTypes<{
     readonly copyright: {
         readonly description: "Copyright notice";
-        readonly group: "MkDocs Config:";
+        readonly group: InitCommandGroup.MkDocs;
         readonly nargs: 1;
         readonly requiresArg: true;
         readonly type: "string";
@@ -11,19 +20,19 @@ declare const opts: {
         readonly default: ".";
         readonly defaultDescription: "(current directory)";
         readonly description: "Directory of package";
-        readonly group: "Paths:";
+        readonly group: InitCommandGroup.Paths;
         readonly normalize: true;
         readonly type: "string";
     };
     readonly 'dry-run': {
         readonly describe: "Do not write any files; show what would be done";
-        readonly group: "Initialization Behavior:";
+        readonly group: InitCommandGroup.Behavior;
         readonly type: "boolean";
     };
     readonly force: {
         readonly alias: "f";
         readonly describe: "Overwrite existing configurations";
-        readonly group: "Initialization Behavior:";
+        readonly group: InitCommandGroup.Behavior;
         readonly type: "boolean";
     };
     readonly include: {
@@ -32,19 +41,20 @@ declare const opts: {
         readonly coerce: (value: string | string[]) => string[];
         readonly description: "Files to include in compilation (globs OK)";
         readonly nargs: 1;
+        readonly group: InitCommandGroup.MkDocs;
         readonly requiresArg: true;
         readonly type: "string";
     };
     readonly mkdocs: {
         readonly default: true;
         readonly description: "Create mkdocs.yml if needed";
-        readonly group: "Initialization Behavior:";
+        readonly group: InitCommandGroup.Behavior;
         readonly type: "boolean";
     };
     readonly 'mkdocs-yml': {
         readonly defaultDescription: "./mkdocs.yml";
-        readonly description: "Path to mkdocs.yml";
-        readonly group: "Paths:";
+        readonly description: "Path to new or existing mkdocs.yml";
+        readonly group: InitCommandGroup.MkDocs;
         readonly nargs: 1;
         readonly normalize: true;
         readonly requiresArg: true;
@@ -52,8 +62,8 @@ declare const opts: {
     };
     readonly 'package-json': {
         readonly defaultDescription: "./package.json";
-        readonly describe: "Path to package.json";
-        readonly group: "Paths:";
+        readonly describe: "Path to existing package.json";
+        readonly group: InitCommandGroup.Paths;
         readonly nargs: 1;
         readonly normalize: true;
         readonly requiresArg: true;
@@ -62,13 +72,13 @@ declare const opts: {
     readonly python: {
         readonly default: true;
         readonly description: "Install Python dependencies if needed";
-        readonly group: "Initialization Behavior:";
+        readonly group: InitCommandGroup.Behavior;
         readonly type: "boolean";
     };
     readonly 'python-path': {
         readonly defaultDescription: "(derived from shell)";
         readonly description: "Path to python 3 executable";
-        readonly group: "Paths:";
+        readonly group: InitCommandGroup.Paths;
         readonly nargs: 1;
         readonly normalize: true;
         readonly requiresArg: true;
@@ -77,7 +87,7 @@ declare const opts: {
     readonly 'repo-name': {
         readonly defaultDescription: "(derived from --repo-url)";
         readonly description: "Name of extension repository";
-        readonly group: "MkDocs Config:";
+        readonly group: InitCommandGroup.MkDocs;
         readonly nargs: 1;
         readonly requiresArg: true;
         readonly type: "string";
@@ -85,7 +95,7 @@ declare const opts: {
     readonly 'repo-url': {
         readonly defaultDescription: "(from package.json)";
         readonly description: "URL of extension repository";
-        readonly group: "MkDocs Config:";
+        readonly group: InitCommandGroup.MkDocs;
         readonly nargs: 1;
         readonly requiresArg: true;
         readonly type: "string";
@@ -93,7 +103,7 @@ declare const opts: {
     readonly 'site-description': {
         readonly defaultDescription: "(from package.json)";
         readonly description: "Site description";
-        readonly group: "MkDocs Config:";
+        readonly group: InitCommandGroup.MkDocs;
         readonly nargs: 1;
         readonly requiresArg: true;
         readonly type: "string";
@@ -101,15 +111,15 @@ declare const opts: {
     readonly 'site-name': {
         readonly defaultDescription: "(extension package name)";
         readonly description: "Name of site";
-        readonly group: "MkDocs Config:";
+        readonly group: InitCommandGroup.MkDocs;
         readonly nargs: 1;
         readonly requiresArg: true;
         readonly type: "string";
     };
     readonly 'tsconfig-json': {
         readonly defaultDescription: "./tsconfig.json";
-        readonly describe: "Path to tsconfig.json";
-        readonly group: "Paths:";
+        readonly describe: "Path to new or existing tsconfig.json";
+        readonly group: InitCommandGroup.Behavior;
         readonly nargs: 1;
         readonly normalize: true;
         readonly requiresArg: true;
@@ -118,13 +128,13 @@ declare const opts: {
     readonly typedoc: {
         readonly default: true;
         readonly description: "Create typedoc.json if needed";
-        readonly group: "Initialization Behavior:";
+        readonly group: InitCommandGroup.Behavior;
         readonly type: "boolean";
     };
     readonly 'typedoc-json': {
         readonly defaultDescription: "./typedoc.json";
-        readonly describe: "Path to typedoc.json";
-        readonly group: "Paths:";
+        readonly describe: "Path to new or existing typedoc.json";
+        readonly group: InitCommandGroup.Behavior;
         readonly nargs: 1;
         readonly normalize: true;
         readonly requiresArg: true;
@@ -133,11 +143,16 @@ declare const opts: {
     readonly typescript: {
         readonly default: true;
         readonly description: "Create tsconfig.json if needed";
-        readonly group: "Initialization Behavior:";
+        readonly group: InitCommandGroup.Behavior;
         readonly type: "boolean";
     };
-};
-declare type InitOptions = InferredOptionTypes<typeof opts>;
-declare const initCommand: CommandModule<{}, InitOptions>;
-export default initCommand;
+    readonly upgrade: {
+        readonly alias: "up";
+        readonly describe: "Only upgrade Python dependencies if out-of-date";
+        readonly group: InitCommandGroup.Behavior;
+        readonly type: "boolean";
+        readonly conflicts: "force";
+    };
+}>>;
+export default _default;
 //# sourceMappingURL=init.d.ts.map

package/build/lib/cli/command/init.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"init.d.ts","sourceRoot":"","sources":["../../../../lib/cli/command/init.ts"],"names":[],"mappings":"AACA,OAAO,EAAC,aAAa,EAAE,mBAAmB,EAAU,MAAM,OAAO,CAAC;AAWlE,QAAA,MAAM,IAAI;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iCA8BU,MAAM,GAAG,MAAM,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA2G3B,CAAC;AAGX,aAAK,WAAW,GAAG,mBAAmB,CAAC,OAAO,IAAI,CAAC,CAAC;AAEpD,QAAA,MAAM,WAAW,EAAE,aAAa,CAAC,EAAE,EAAE,WAAW,CAS/C,CAAC;AAEF,eAAe,WAAW,CAAC"}
+{"version":3,"file":"init.d.ts","sourceRoot":"","sources":["../../../../lib/cli/command/init.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,KAAK,EAAC,aAAa,EAAE,mBAAmB,EAAU,MAAM,OAAO,CAAC;AAQvE,aAAK,gBAAgB;IACnB,MAAM,mBAAmB;IACzB,KAAK,kBAAkB;IACvB,QAAQ,6BAA6B;CACtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA4JD,wBAawC"}