@appium/docutils 0.1.6 → 0.2.0

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

@@ -0,0 +1,223 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const builder_1 = require("../../builder");
+const constants_1 = require("../../constants");
+const logger_1 = __importDefault(require("../../logger"));
+const util_1 = require("../../util");
+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:';
+const opts = {
+    reference: {
+        describe: 'Run TypeDoc command API reference build (Markdown)',
+        group: NAME_GROUP_BUILD,
+        type: 'boolean',
+        default: true,
+    },
+    site: {
+        describe: 'Run MkDocs build (HTML)',
+        group: NAME_GROUP_BUILD,
+        type: 'boolean',
+        default: true,
+    },
+    'site-dir': {
+        alias: 'd',
+        describe: 'HTML output directory',
+        group: NAME_GROUP_BUILD_PATHS,
+        nargs: 1,
+        requiresArg: true,
+        type: 'string',
+        normalize: true,
+        implies: 'site',
+        defaultDescription: '(from mkdocs.yml)',
+    },
+    'package-json': {
+        defaultDescription: './package.json',
+        describe: 'Path to package.json',
+        group: NAME_GROUP_BUILD_PATHS,
+        nargs: 1,
+        normalize: true,
+        requiresArg: true,
+        type: 'string',
+    },
+    title: {
+        defaultDescription: '(extension package name)',
+        describe: 'Title of the API reference',
+        group: NAME_GROUP_BUILD,
+        nargs: 1,
+        requiresArg: true,
+        type: 'string',
+    },
+    'tsconfig-json': {
+        defaultDescription: './tsconfig.json',
+        describe: 'Path to tsconfig.json',
+        group: NAME_GROUP_BUILD_PATHS,
+        nargs: 1,
+        normalize: true,
+        requiresArg: true,
+        type: 'string',
+    },
+    'mkdocs-yml': {
+        defaultDescription: './mkdocs.yml',
+        description: 'Path to mkdocs.yml',
+        group: NAME_GROUP_BUILD_PATHS,
+        nargs: 1,
+        normalize: true,
+        requiresArg: true,
+        type: 'string',
+    },
+    'typedoc-json': {
+        defaultDescription: './typedoc.json',
+        describe: 'Path to typedoc.json',
+        group: NAME_GROUP_BUILD_PATHS,
+        nargs: 1,
+        normalize: true,
+        requiresArg: true,
+        type: 'string',
+    },
+    all: {
+        describe: 'Output all reference docs (not just Appium comands)',
+        group: NAME_GROUP_BUILD,
+        implies: 'site',
+        type: 'boolean',
+    },
+    deploy: {
+        describe: 'Commit HTML output',
+        group: NAME_GROUP_DEPLOY,
+        type: 'boolean',
+        implies: 'site',
+    },
+    push: {
+        describe: 'Push after deploy',
+        group: NAME_GROUP_DEPLOY,
+        type: 'boolean',
+        implies: 'deploy',
+    },
+    branch: {
+        alias: 'b',
+        describe: 'Branch to commit to',
+        implies: 'deploy',
+        group: NAME_GROUP_DEPLOY,
+        type: 'string',
+        requiresArg: true,
+        nargs: 1,
+        defaultDescription: 'gh-pages',
+    },
+    remote: {
+        alias: 'r',
+        describe: 'Remote to push to',
+        implies: ['deploy', 'push'],
+        group: NAME_GROUP_DEPLOY,
+        type: 'string',
+        requiresArg: true,
+        nargs: 1,
+        defaultDescription: 'origin',
+    },
+    prefix: {
+        describe: 'Subdirectory within <branch> to commit to',
+        implies: ['deploy', 'branch'],
+        group: NAME_GROUP_DEPLOY,
+        type: 'string',
+        nargs: 1,
+        requiresArg: true,
+    },
+    message: {
+        alias: 'm',
+        describe: 'Commit message',
+        implies: 'deploy',
+        group: NAME_GROUP_DEPLOY,
+        type: 'string',
+        nargs: 1,
+        requiresArg: true,
+    },
+    'deploy-version': {
+        describe: 'Version (directory) to deploy build to',
+        implies: 'deploy',
+        group: NAME_GROUP_DEPLOY,
+        type: 'string',
+        nargs: 1,
+        requiresArg: true,
+        defaultDescription: '(derived from package.json)',
+    },
+    alias: {
+        describe: 'Alias for the build (e.g., "latest"); triggers alias update',
+        implies: 'deploy',
+        group: NAME_GROUP_DEPLOY,
+        type: 'string',
+        nargs: 1,
+        requiresArg: true,
+        defaultDescription: 'latest',
+    },
+    rebase: {
+        describe: 'Rebase <branch> with remote before deploy',
+        implies: ['deploy', 'branch', 'remote'],
+        group: NAME_GROUP_DEPLOY,
+        type: 'boolean',
+    },
+    serve: {
+        describe: 'Start development server',
+        group: NAME_GROUP_SERVE,
+        type: 'boolean',
+    },
+    port: {
+        alias: 'p',
+        describe: 'Development server port',
+        group: NAME_GROUP_SERVE,
+        type: 'number',
+        defaultDescription: '8000',
+        implies: 'serve',
+        nargs: 1,
+        requiresArg: true,
+    },
+    host: {
+        alias: 'h',
+        describe: 'Development server host',
+        group: NAME_GROUP_SERVE,
+        type: 'string',
+        nargs: 1,
+        requiresArg: true,
+        implies: 'serve',
+        defaultDescription: 'localhost',
+    },
+};
+opts;
+const buildCommand = {
+    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;
+    }),
+    async handler(args) {
+        const stop = (0, util_1.stopwatch)('build');
+        log.debug('Build command called with args: %O', args);
+        if (!args.site && !args.reference) {
+            // specifically not a DocUtils error
+            throw new Error('Cannot use both --no-site (--site=false) and --no-reference (--reference=false)');
+        }
+        if (args.reference) {
+            await (0, builder_1.buildReferenceDocs)(args);
+        }
+        if (args.site) {
+            await (0, builder_1.updateNav)(args);
+            if (args.deploy) {
+                await (0, builder_1.deploy)(args);
+            }
+            else {
+                await (0, builder_1.buildSite)(args);
+            }
+        }
+        log.success('Done! (total: %dms)', stop());
+    },
+};
+exports.default = buildCommand;
+//# sourceMappingURL=build.js.map

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

@@ -0,0 +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"}

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

@@ -0,0 +1 @@
+//# sourceMappingURL=deploy.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"deploy.d.ts","sourceRoot":"","sources":["../../../../lib/cli/command/deploy.ts"],"names":[],"mappings":""}

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

@@ -0,0 +1,2 @@
+"use strict";
+//# sourceMappingURL=deploy.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"deploy.js","sourceRoot":"","sources":["../../../../lib/cli/command/deploy.ts"],"names":[],"mappings":""}

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

@@ -0,0 +1,4 @@
+export { default as init } from './init';
+export { default as validate } from './validate';
+export { default as build } from './build';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +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"}

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

@@ -0,0 +1,13 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.build = exports.validate = exports.init = void 0;
+var init_1 = require("./init");
+Object.defineProperty(exports, "init", { enumerable: true, get: function () { return __importDefault(init_1).default; } });
+var validate_1 = require("./validate");
+Object.defineProperty(exports, "validate", { enumerable: true, get: function () { return __importDefault(validate_1).default; } });
+var build_1 = require("./build");
+Object.defineProperty(exports, "build", { enumerable: true, get: function () { return __importDefault(build_1).default; } });
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +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"}

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

@@ -0,0 +1,143 @@
+import { CommandModule, InferredOptionTypes } from 'yargs';
+declare const opts: {
+    readonly copyright: {
+        readonly description: "Copyright notice";
+        readonly group: "MkDocs Config:";
+        readonly nargs: 1;
+        readonly requiresArg: true;
+        readonly type: "string";
+    };
+    readonly dir: {
+        readonly default: ".";
+        readonly defaultDescription: "(current directory)";
+        readonly description: "Directory of package";
+        readonly group: "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 type: "boolean";
+    };
+    readonly force: {
+        readonly alias: "f";
+        readonly describe: "Overwrite existing configurations";
+        readonly group: "Initialization Behavior:";
+        readonly type: "boolean";
+    };
+    readonly include: {
+        readonly alias: "i";
+        readonly array: true;
+        readonly coerce: (value: string | string[]) => string[];
+        readonly description: "Files to include in compilation (globs OK)";
+        readonly nargs: 1;
+        readonly requiresArg: true;
+        readonly type: "string";
+    };
+    readonly mkdocs: {
+        readonly default: true;
+        readonly description: "Create mkdocs.yml if needed";
+        readonly group: "Initialization Behavior:";
+        readonly type: "boolean";
+    };
+    readonly 'mkdocs-yml': {
+        readonly defaultDescription: "./mkdocs.yml";
+        readonly description: "Path to mkdocs.yml";
+        readonly group: "Paths:";
+        readonly nargs: 1;
+        readonly normalize: true;
+        readonly requiresArg: true;
+        readonly type: "string";
+    };
+    readonly 'package-json': {
+        readonly defaultDescription: "./package.json";
+        readonly describe: "Path to package.json";
+        readonly group: "Paths:";
+        readonly nargs: 1;
+        readonly normalize: true;
+        readonly requiresArg: true;
+        readonly type: "string";
+    };
+    readonly python: {
+        readonly default: true;
+        readonly description: "Install Python dependencies if needed";
+        readonly group: "Initialization Behavior:";
+        readonly type: "boolean";
+    };
+    readonly 'python-path': {
+        readonly defaultDescription: "(derived from shell)";
+        readonly description: "Path to python 3 executable";
+        readonly group: "Paths:";
+        readonly nargs: 1;
+        readonly normalize: true;
+        readonly requiresArg: true;
+        readonly type: "string";
+    };
+    readonly 'repo-name': {
+        readonly defaultDescription: "(derived from --repo-url)";
+        readonly description: "Name of extension repository";
+        readonly group: "MkDocs Config:";
+        readonly nargs: 1;
+        readonly requiresArg: true;
+        readonly type: "string";
+    };
+    readonly 'repo-url': {
+        readonly defaultDescription: "(from package.json)";
+        readonly description: "URL of extension repository";
+        readonly group: "MkDocs Config:";
+        readonly nargs: 1;
+        readonly requiresArg: true;
+        readonly type: "string";
+    };
+    readonly 'site-description': {
+        readonly defaultDescription: "(from package.json)";
+        readonly description: "Site description";
+        readonly group: "MkDocs Config:";
+        readonly nargs: 1;
+        readonly requiresArg: true;
+        readonly type: "string";
+    };
+    readonly 'site-name': {
+        readonly defaultDescription: "(extension package name)";
+        readonly description: "Name of site";
+        readonly group: "MkDocs Config:";
+        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 nargs: 1;
+        readonly normalize: true;
+        readonly requiresArg: true;
+        readonly type: "string";
+    };
+    readonly typedoc: {
+        readonly default: true;
+        readonly description: "Create typedoc.json if needed";
+        readonly group: "Initialization Behavior:";
+        readonly type: "boolean";
+    };
+    readonly 'typedoc-json': {
+        readonly defaultDescription: "./typedoc.json";
+        readonly describe: "Path to typedoc.json";
+        readonly group: "Paths:";
+        readonly nargs: 1;
+        readonly normalize: true;
+        readonly requiresArg: true;
+        readonly type: "string";
+    };
+    readonly typescript: {
+        readonly default: true;
+        readonly description: "Create tsconfig.json if needed";
+        readonly group: "Initialization Behavior:";
+        readonly type: "boolean";
+    };
+};
+declare type InitOptions = InferredOptionTypes<typeof opts>;
+declare const initCommand: CommandModule<{}, InitOptions>;
+export default initCommand;
+//# sourceMappingURL=init.d.ts.map

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

@@ -0,0 +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"}

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

@@ -0,0 +1,164 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const lodash_1 = __importDefault(require("lodash"));
+const init_1 = require("../../init");
+const logger_1 = __importDefault(require("../../logger"));
+const util_1 = require("../../util");
+const log = logger_1.default.withTag('init');
+const NAME_GROUP_INIT_MKDOCS = 'MkDocs Config:';
+const NAME_GROUP_INIT_PATHS = 'Paths:';
+const NAME_GROUP_INIT_BEHAVIOR = 'Initialization Behavior:';
+const opts = {
+    copyright: {
+        description: 'Copyright notice',
+        group: NAME_GROUP_INIT_MKDOCS,
+        nargs: 1,
+        requiresArg: true,
+        type: 'string',
+    },
+    dir: {
+        default: '.',
+        defaultDescription: '(current directory)',
+        description: 'Directory of package',
+        group: NAME_GROUP_INIT_PATHS,
+        normalize: true,
+        type: 'string',
+    },
+    'dry-run': {
+        describe: 'Do not write any files; show what would be done',
+        group: NAME_GROUP_INIT_BEHAVIOR,
+        type: 'boolean',
+    },
+    force: {
+        alias: 'f',
+        describe: 'Overwrite existing configurations',
+        group: NAME_GROUP_INIT_BEHAVIOR,
+        type: 'boolean',
+    },
+    include: {
+        alias: 'i',
+        array: true,
+        coerce: (value) => lodash_1.default.castArray(value),
+        description: 'Files to include in compilation (globs OK)',
+        nargs: 1,
+        requiresArg: true,
+        type: 'string',
+    },
+    mkdocs: {
+        default: true,
+        description: 'Create mkdocs.yml if needed',
+        group: NAME_GROUP_INIT_BEHAVIOR,
+        type: 'boolean',
+    },
+    'mkdocs-yml': {
+        defaultDescription: './mkdocs.yml',
+        description: 'Path to mkdocs.yml',
+        group: NAME_GROUP_INIT_PATHS,
+        nargs: 1,
+        normalize: true,
+        requiresArg: true,
+        type: 'string',
+    },
+    'package-json': {
+        defaultDescription: './package.json',
+        describe: 'Path to package.json',
+        group: NAME_GROUP_INIT_PATHS,
+        nargs: 1,
+        normalize: true,
+        requiresArg: true,
+        type: 'string',
+    },
+    python: {
+        default: true,
+        description: 'Install Python dependencies if needed',
+        group: NAME_GROUP_INIT_BEHAVIOR,
+        type: 'boolean',
+    },
+    'python-path': {
+        defaultDescription: '(derived from shell)',
+        description: 'Path to python 3 executable',
+        group: NAME_GROUP_INIT_PATHS,
+        nargs: 1,
+        normalize: true,
+        requiresArg: true,
+        type: 'string',
+    },
+    'repo-name': {
+        defaultDescription: '(derived from --repo-url)',
+        description: 'Name of extension repository',
+        group: NAME_GROUP_INIT_MKDOCS,
+        nargs: 1,
+        requiresArg: true,
+        type: 'string',
+    },
+    'repo-url': {
+        defaultDescription: '(from package.json)',
+        description: 'URL of extension repository',
+        group: NAME_GROUP_INIT_MKDOCS,
+        nargs: 1,
+        requiresArg: true,
+        type: 'string',
+    },
+    'site-description': {
+        defaultDescription: '(from package.json)',
+        description: 'Site description',
+        group: NAME_GROUP_INIT_MKDOCS,
+        nargs: 1,
+        requiresArg: true,
+        type: 'string',
+    },
+    'site-name': {
+        defaultDescription: '(extension package name)',
+        description: 'Name of site',
+        group: NAME_GROUP_INIT_MKDOCS,
+        nargs: 1,
+        requiresArg: true,
+        type: 'string',
+    },
+    'tsconfig-json': {
+        defaultDescription: './tsconfig.json',
+        describe: 'Path to tsconfig.json',
+        group: NAME_GROUP_INIT_PATHS,
+        nargs: 1,
+        normalize: true,
+        requiresArg: true,
+        type: 'string',
+    },
+    typedoc: {
+        default: true,
+        description: 'Create typedoc.json if needed',
+        group: NAME_GROUP_INIT_BEHAVIOR,
+        type: 'boolean',
+    },
+    'typedoc-json': {
+        defaultDescription: './typedoc.json',
+        describe: 'Path to typedoc.json',
+        group: NAME_GROUP_INIT_PATHS,
+        nargs: 1,
+        normalize: true,
+        requiresArg: true,
+        type: 'string',
+    },
+    typescript: {
+        default: true,
+        description: 'Create tsconfig.json if needed',
+        group: NAME_GROUP_INIT_BEHAVIOR,
+        type: 'boolean',
+    },
+};
+opts; // type check
+const initCommand = {
+    command: 'init',
+    describe: 'Initialize package for doc generation',
+    builder: opts,
+    async handler(args) {
+        const done = (0, util_1.stopwatch)('init');
+        await (0, init_1.init)({ ...args, overwrite: args.force, cwd: args.dir });
+        log.success('Done (%dms)', done());
+    },
+};
+exports.default = initCommand;
+//# sourceMappingURL=init.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"init.js","sourceRoot":"","sources":["../../../../lib/cli/command/init.ts"],"names":[],"mappings":";;;;;AAAA,oDAAuB;AAEvB,qCAAgC;AAChC,0DAAkC;AAClC,qCAAqC;AAErC,MAAM,GAAG,GAAG,gBAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;AAEnC,MAAM,sBAAsB,GAAG,gBAAgB,CAAC;AAChD,MAAM,qBAAqB,GAAG,QAAQ,CAAC;AACvC,MAAM,wBAAwB,GAAG,0BAA0B,CAAC;AAE5D,MAAM,IAAI,GAAG;IACX,SAAS,EAAE;QACT,WAAW,EAAE,kBAAkB;QAC/B,KAAK,EAAE,sBAAsB;QAC7B,KAAK,EAAE,CAAC;QACR,WAAW,EAAE,IAAI;QACjB,IAAI,EAAE,QAAQ;KACf;IACD,GAAG,EAAE;QACH,OAAO,EAAE,GAAG;QACZ,kBAAkB,EAAE,qBAAqB;QACzC,WAAW,EAAE,sBAAsB;QACnC,KAAK,EAAE,qBAAqB;QAC5B,SAAS,EAAE,IAAI;QACf,IAAI,EAAE,QAAQ;KACf;IACD,SAAS,EAAE;QACT,QAAQ,EAAE,iDAAiD;QAC3D,KAAK,EAAE,wBAAwB;QAC/B,IAAI,EAAE,SAAS;KAChB;IACD,KAAK,EAAE;QACL,KAAK,EAAE,GAAG;QACV,QAAQ,EAAE,mCAAmC;QAC7C,KAAK,EAAE,wBAAwB;QAC/B,IAAI,EAAE,SAAS;KAChB;IACD,OAAO,EAAE;QACP,KAAK,EAAE,GAAG;QACV,KAAK,EAAE,IAAI;QACX,MAAM,EAAE,CAAC,KAAwB,EAAE,EAAE,CAAC,gBAAC,CAAC,SAAS,CAAC,KAAK,CAAC;QACxD,WAAW,EAAE,4CAA4C;QACzD,KAAK,EAAE,CAAC;QACR,WAAW,EAAE,IAAI;QACjB,IAAI,EAAE,QAAQ;KACf;IACD,MAAM,EAAE;QACN,OAAO,EAAE,IAAI;QACb,WAAW,EAAE,6BAA6B;QAC1C,KAAK,EAAE,wBAAwB;QAC/B,IAAI,EAAE,SAAS;KAChB;IACD,YAAY,EAAE;QACZ,kBAAkB,EAAE,cAAc;QAClC,WAAW,EAAE,oBAAoB;QACjC,KAAK,EAAE,qBAAqB;QAC5B,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,qBAAqB;QAC5B,KAAK,EAAE,CAAC;QACR,SAAS,EAAE,IAAI;QACf,WAAW,EAAE,IAAI;QACjB,IAAI,EAAE,QAAQ;KACf;IACD,MAAM,EAAE;QACN,OAAO,EAAE,IAAI;QACb,WAAW,EAAE,uCAAuC;QACpD,KAAK,EAAE,wBAAwB;QAC/B,IAAI,EAAE,SAAS;KAChB;IACD,aAAa,EAAE;QACb,kBAAkB,EAAE,sBAAsB;QAC1C,WAAW,EAAE,6BAA6B;QAC1C,KAAK,EAAE,qBAAqB;QAC5B,KAAK,EAAE,CAAC;QACR,SAAS,EAAE,IAAI;QACf,WAAW,EAAE,IAAI;QACjB,IAAI,EAAE,QAAQ;KACf;IACD,WAAW,EAAE;QACX,kBAAkB,EAAE,2BAA2B;QAC/C,WAAW,EAAE,8BAA8B;QAC3C,KAAK,EAAE,sBAAsB;QAC7B,KAAK,EAAE,CAAC;QACR,WAAW,EAAE,IAAI;QACjB,IAAI,EAAE,QAAQ;KACf;IACD,UAAU,EAAE;QACV,kBAAkB,EAAE,qBAAqB;QACzC,WAAW,EAAE,6BAA6B;QAC1C,KAAK,EAAE,sBAAsB;QAC7B,KAAK,EAAE,CAAC;QACR,WAAW,EAAE,IAAI;QACjB,IAAI,EAAE,QAAQ;KACf;IACD,kBAAkB,EAAE;QAClB,kBAAkB,EAAE,qBAAqB;QACzC,WAAW,EAAE,kBAAkB;QAC/B,KAAK,EAAE,sBAAsB;QAC7B,KAAK,EAAE,CAAC;QACR,WAAW,EAAE,IAAI;QACjB,IAAI,EAAE,QAAQ;KACf;IACD,WAAW,EAAE;QACX,kBAAkB,EAAE,0BAA0B;QAC9C,WAAW,EAAE,cAAc;QAC3B,KAAK,EAAE,sBAAsB;QAC7B,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,qBAAqB;QAC5B,KAAK,EAAE,CAAC;QACR,SAAS,EAAE,IAAI;QACf,WAAW,EAAE,IAAI;QACjB,IAAI,EAAE,QAAQ;KACf;IACD,OAAO,EAAE;QACP,OAAO,EAAE,IAAI;QACb,WAAW,EAAE,+BAA+B;QAC5C,KAAK,EAAE,wBAAwB;QAC/B,IAAI,EAAE,SAAS;KAChB;IACD,cAAc,EAAE;QACd,kBAAkB,EAAE,gBAAgB;QACpC,QAAQ,EAAE,sBAAsB;QAChC,KAAK,EAAE,qBAAqB;QAC5B,KAAK,EAAE,CAAC;QACR,SAAS,EAAE,IAAI;QACf,WAAW,EAAE,IAAI;QACjB,IAAI,EAAE,QAAQ;KACf;IACD,UAAU,EAAE;QACV,OAAO,EAAE,IAAI;QACb,WAAW,EAAE,gCAAgC;QAC7C,KAAK,EAAE,wBAAwB;QAC/B,IAAI,EAAE,SAAS;KAChB;CACO,CAAC;AACX,IAA+B,CAAC,CAAC,aAAa;AAI9C,MAAM,WAAW,GAAmC;IAClD,OAAO,EAAE,MAAM;IACf,QAAQ,EAAE,uCAAuC;IACjD,OAAO,EAAE,IAAI;IACb,KAAK,CAAC,OAAO,CAAC,IAAI;QAChB,MAAM,IAAI,GAAG,IAAA,gBAAS,EAAC,MAAM,CAAC,CAAC;QAC/B,MAAM,IAAA,WAAI,EAAC,EAAC,GAAG,IAAI,EAAE,SAAS,EAAE,IAAI,CAAC,KAAK,EAAE,GAAG,EAAE,IAAI,CAAC,GAAG,EAAC,CAAC,CAAC;QAC5D,GAAG,CAAC,OAAO,CAAC,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC;IACrC,CAAC;CACF,CAAC;AAEF,kBAAe,WAAW,CAAC"}

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

@@ -0,0 +1,76 @@
+import { CommandModule, InferredOptionTypes } from 'yargs';
+declare const opts: {
+    readonly mkdocs: {
+        readonly default: true;
+        readonly description: "Validate MkDocs environment";
+        readonly group: "Validation Behavior:";
+        readonly type: "boolean";
+    };
+    readonly 'mkdocs-yml': {
+        readonly defaultDescription: "./mkdocs.yml";
+        readonly description: "Path to mkdocs.yml";
+        readonly group: "Paths:";
+        readonly nargs: 1;
+        readonly normalize: true;
+        readonly requiresArg: true;
+        readonly type: "string";
+    };
+    readonly 'npm-path': {
+        readonly defaultDescription: "(derived from shell)";
+        readonly description: "Path to npm executable";
+        readonly group: "Paths:";
+        readonly nargs: 1;
+        readonly normalize: true;
+        readonly requiresArg: true;
+        readonly type: "string";
+    };
+    readonly python: {
+        readonly default: true;
+        readonly description: "Validate Python 3 environment";
+        readonly group: "Validation Behavior:";
+        readonly type: "boolean";
+    };
+    readonly 'python-path': {
+        readonly defaultDescription: "(derived from shell)";
+        readonly description: "Path to python 3 executable";
+        readonly group: "Paths:";
+        readonly nargs: 1;
+        readonly normalize: true;
+        readonly requiresArg: true;
+        readonly type: "string";
+    };
+    readonly 'tsconfig-json': {
+        readonly defaultDescription: "./tsconfig.json";
+        readonly describe: "Path to tsconfig.json";
+        readonly group: "Paths:";
+        readonly nargs: 1;
+        readonly normalize: true;
+        readonly requiresArg: true;
+        readonly type: "string";
+    };
+    readonly typedoc: {
+        readonly default: true;
+        readonly description: "Validate TypoDoc environment";
+        readonly group: "Validation Behavior:";
+        readonly type: "boolean";
+    };
+    readonly 'typedoc-json': {
+        readonly defaultDescription: "./typedoc.json";
+        readonly describe: "Path to typedoc.json";
+        readonly group: "Paths:";
+        readonly nargs: 1;
+        readonly normalize: true;
+        readonly requiresArg: true;
+        readonly type: "string";
+    };
+    readonly typescript: {
+        readonly default: true;
+        readonly description: "Validate TypeScript environment";
+        readonly group: "Validation Behavior:";
+        readonly type: "boolean";
+    };
+};
+declare type ValidateOptions = InferredOptionTypes<typeof opts>;
+declare const validateCommand: CommandModule<{}, ValidateOptions>;
+export default validateCommand;
+//# sourceMappingURL=validate.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"validate.d.ts","sourceRoot":"","sources":["../../../../lib/cli/command/validate.ts"],"names":[],"mappings":"AACA,OAAO,EAAC,aAAa,EAAE,mBAAmB,EAAU,MAAM,OAAO,CAAC;AAUlE,QAAA,MAAM,IAAI;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAsEA,CAAC;AAEX,aAAK,eAAe,GAAG,mBAAmB,CAAC,OAAO,IAAI,CAAC,CAAC;AACxD,QAAA,MAAM,eAAe,EAAE,aAAa,CAAC,EAAE,EAAE,eAAe,CAmCvD,CAAC;AAEF,eAAe,eAAe,CAAC"}