@appium/docutils 0.1.6 → 0.2.0

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

@@ -0,0 +1,115 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const pluralize_1 = __importDefault(require("pluralize"));
+const error_1 = require("../../error");
+const validate_1 = require("../../validate");
+const logger_1 = __importDefault(require("../../logger"));
+const log = logger_1.default.withTag('validate');
+const NAME_GROUP_VALIDATE = 'Validation Behavior:';
+const NAME_GROUP_VALIDATE_PATHS = 'Paths:';
+const opts = {
+    mkdocs: {
+        default: true,
+        description: 'Validate MkDocs environment',
+        group: NAME_GROUP_VALIDATE,
+        type: 'boolean',
+    },
+    'mkdocs-yml': {
+        defaultDescription: './mkdocs.yml',
+        description: 'Path to mkdocs.yml',
+        group: NAME_GROUP_VALIDATE_PATHS,
+        nargs: 1,
+        normalize: true,
+        requiresArg: true,
+        type: 'string',
+    },
+    'npm-path': {
+        defaultDescription: '(derived from shell)',
+        description: 'Path to npm executable',
+        group: NAME_GROUP_VALIDATE_PATHS,
+        nargs: 1,
+        normalize: true,
+        requiresArg: true,
+        type: 'string',
+    },
+    python: {
+        default: true,
+        description: 'Validate Python 3 environment',
+        group: NAME_GROUP_VALIDATE,
+        type: 'boolean',
+    },
+    'python-path': {
+        defaultDescription: '(derived from shell)',
+        description: 'Path to python 3 executable',
+        group: NAME_GROUP_VALIDATE_PATHS,
+        nargs: 1,
+        normalize: true,
+        requiresArg: true,
+        type: 'string',
+    },
+    'tsconfig-json': {
+        defaultDescription: './tsconfig.json',
+        describe: 'Path to tsconfig.json',
+        group: NAME_GROUP_VALIDATE_PATHS,
+        nargs: 1,
+        normalize: true,
+        requiresArg: true,
+        type: 'string',
+    },
+    typedoc: {
+        default: true,
+        description: 'Validate TypoDoc environment',
+        group: NAME_GROUP_VALIDATE,
+        type: 'boolean',
+    },
+    'typedoc-json': {
+        defaultDescription: './typedoc.json',
+        describe: 'Path to typedoc.json',
+        group: NAME_GROUP_VALIDATE_PATHS,
+        nargs: 1,
+        normalize: true,
+        requiresArg: true,
+        type: 'string',
+    },
+    typescript: {
+        default: true,
+        description: 'Validate TypeScript environment',
+        group: NAME_GROUP_VALIDATE,
+        type: 'boolean',
+    },
+};
+opts;
+const validateCommand = {
+    command: 'validate',
+    describe: 'Validate Environment',
+    builder: opts,
+    async handler(args) {
+        if (!args.python && !args.typedoc && !args.typescript && !args.mkdocs) {
+            // specifically not a DocutilsError
+            throw new Error('No validation targets specified; one or more of --python, --typescript, --typedoc or --mkdocs must be provided');
+        }
+        let errorCount = 0;
+        const validator = new validate_1.DocutilsValidator(args)
+            .once(validate_1.DocutilsValidator.BEGIN, (kinds) => {
+            log.info(`Validating: ${kinds.join(', ')}`);
+        })
+            .once(validate_1.DocutilsValidator.END, (errCount) => {
+            errorCount = errCount;
+        })
+            .on(validate_1.DocutilsValidator.FAILURE, (err) => {
+            log.error(err.message);
+        })
+            .on(validate_1.DocutilsValidator.SUCCESS, (msg) => {
+            log.success(msg);
+        });
+        await validator.validate();
+        if (errorCount) {
+            throw new error_1.DocutilsError(`Validation failed with ${errorCount} ${(0, pluralize_1.default)('error', errorCount)}`);
+        }
+    },
+};
+exports.default = validateCommand;
+//# sourceMappingURL=validate.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"validate.js","sourceRoot":"","sources":["../../../../lib/cli/command/validate.ts"],"names":[],"mappings":";;;;;AAAA,0DAAkC;AAElC,uCAA0C;AAC1C,6CAAiE;AACjE,0DAAkC;AAElC,MAAM,GAAG,GAAG,gBAAM,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;AAEvC,MAAM,mBAAmB,GAAG,sBAAsB,CAAC;AACnD,MAAM,yBAAyB,GAAG,QAAQ,CAAC;AAE3C,MAAM,IAAI,GAAG;IACX,MAAM,EAAE;QACN,OAAO,EAAE,IAAI;QACb,WAAW,EAAE,6BAA6B;QAC1C,KAAK,EAAE,mBAAmB;QAC1B,IAAI,EAAE,SAAS;KAChB;IACD,YAAY,EAAE;QACZ,kBAAkB,EAAE,cAAc;QAClC,WAAW,EAAE,oBAAoB;QACjC,KAAK,EAAE,yBAAyB;QAChC,KAAK,EAAE,CAAC;QACR,SAAS,EAAE,IAAI;QACf,WAAW,EAAE,IAAI;QACjB,IAAI,EAAE,QAAQ;KACf;IACD,UAAU,EAAE;QACV,kBAAkB,EAAE,sBAAsB;QAC1C,WAAW,EAAE,wBAAwB;QACrC,KAAK,EAAE,yBAAyB;QAChC,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,+BAA+B;QAC5C,KAAK,EAAE,mBAAmB;QAC1B,IAAI,EAAE,SAAS;KAChB;IACD,aAAa,EAAE;QACb,kBAAkB,EAAE,sBAAsB;QAC1C,WAAW,EAAE,6BAA6B;QAC1C,KAAK,EAAE,yBAAyB;QAChC,KAAK,EAAE,CAAC;QACR,SAAS,EAAE,IAAI;QACf,WAAW,EAAE,IAAI;QACjB,IAAI,EAAE,QAAQ;KACf;IACD,eAAe,EAAE;QACf,kBAAkB,EAAE,iBAAiB;QACrC,QAAQ,EAAE,uBAAuB;QACjC,KAAK,EAAE,yBAAyB;QAChC,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,8BAA8B;QAC3C,KAAK,EAAE,mBAAmB;QAC1B,IAAI,EAAE,SAAS;KAChB;IACD,cAAc,EAAE;QACd,kBAAkB,EAAE,gBAAgB;QACpC,QAAQ,EAAE,sBAAsB;QAChC,KAAK,EAAE,yBAAyB;QAChC,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,iCAAiC;QAC9C,KAAK,EAAE,mBAAmB;QAC1B,IAAI,EAAE,SAAS;KAChB;CACO,CAAC;AACX,IAA+B,CAAC;AAEhC,MAAM,eAAe,GAAuC;IAC1D,OAAO,EAAE,UAAU;IACnB,QAAQ,EAAE,sBAAsB;IAChC,OAAO,EAAE,IAAI;IACb,KAAK,CAAC,OAAO,CAAC,IAAI;QAChB,IAAI,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,IAAI,CAAC,IAAI,CAAC,UAAU,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;YACrE,mCAAmC;YACnC,MAAM,IAAI,KAAK,CACb,gHAAgH,CACjH,CAAC;SACH;QAED,IAAI,UAAU,GAAG,CAAC,CAAC;QACnB,MAAM,SAAS,GAAG,IAAI,4BAAiB,CAAC,IAAI,CAAC;aAC1C,IAAI,CAAC,4BAAiB,CAAC,KAAK,EAAE,CAAC,KAAuB,EAAE,EAAE;YACzD,GAAG,CAAC,IAAI,CAAC,eAAe,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAC9C,CAAC,CAAC;aACD,IAAI,CAAC,4BAAiB,CAAC,GAAG,EAAE,CAAC,QAAgB,EAAE,EAAE;YAChD,UAAU,GAAG,QAAQ,CAAC;QACxB,CAAC,CAAC;aACD,EAAE,CAAC,4BAAiB,CAAC,OAAO,EAAE,CAAC,GAAkB,EAAE,EAAE;YACpD,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QACzB,CAAC,CAAC;aACD,EAAE,CAAC,4BAAiB,CAAC,OAAO,EAAE,CAAC,GAAW,EAAE,EAAE;YAC7C,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACnB,CAAC,CAAC,CAAC;QAEL,MAAM,SAAS,CAAC,QAAQ,EAAE,CAAC;QAE3B,IAAI,UAAU,EAAE;YACd,MAAM,IAAI,qBAAa,CACrB,0BAA0B,UAAU,IAAI,IAAA,mBAAS,EAAC,OAAO,EAAE,UAAU,CAAC,EAAE,CACzE,CAAC;SACH;IACH,CAAC;CACF,CAAC;AAEF,kBAAe,eAAe,CAAC"}

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=command-init.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"command-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=command-init.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"command-init.js","sourceRoot":"","sources":["../../../lib/cli/command-init.ts"],"names":[],"mappings":";;;;;AAAA,oDAAuB;AAEvB,kCAA6B;AAC7B,uDAA+B;AAC/B,kCAAkC;AAElC,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,52 @@
+import { CommandModule, InferredOptionTypes } from 'yargs';
+declare const opts: {
+    readonly python: {
+        readonly default: true;
+        readonly description: "Validate Python 3 environment";
+        readonly group: "Validation:";
+        readonly type: "boolean";
+    };
+    readonly 'python-path': {
+        readonly defaultDescription: "(derived from shell)";
+        readonly description: "Path to python 3 executable";
+        readonly group: "Validation:";
+        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: "Validation:";
+        readonly nargs: 1;
+        readonly normalize: true;
+        readonly requiresArg: true;
+        readonly type: "string";
+    };
+    readonly typedoc: {
+        readonly default: true;
+        readonly description: "Validate TypoDoc config";
+        readonly group: "Validation:";
+        readonly type: "boolean";
+    };
+    readonly 'typedoc-json': {
+        readonly defaultDescription: "./typedoc.json";
+        readonly describe: "Path to typedoc.json";
+        readonly group: "Validation:";
+        readonly nargs: 1;
+        readonly normalize: true;
+        readonly requiresArg: true;
+        readonly type: "string";
+    };
+    readonly typescript: {
+        readonly default: true;
+        readonly description: "Validate TypeScript config";
+        readonly group: "Validation:";
+        readonly type: "boolean";
+    };
+};
+declare type ValidateOptions = InferredOptionTypes<typeof opts>;
+declare const validateCommand: CommandModule<{}, ValidateOptions>;
+export default validateCommand;
+//# sourceMappingURL=command-validate.d.ts.map

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

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

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

@@ -0,0 +1,66 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const validate_1 = require("../validate");
+const NAME_GROUP_VALIDATE = 'Validation:';
+const opts = {
+    python: {
+        default: true,
+        description: 'Validate Python 3 environment',
+        group: NAME_GROUP_VALIDATE,
+        type: 'boolean',
+    },
+    'python-path': {
+        defaultDescription: '(derived from shell)',
+        description: 'Path to python 3 executable',
+        group: NAME_GROUP_VALIDATE,
+        nargs: 1,
+        normalize: true,
+        requiresArg: true,
+        type: 'string',
+    },
+    'tsconfig-json': {
+        defaultDescription: './tsconfig.json',
+        describe: 'Path to tsconfig.json',
+        group: NAME_GROUP_VALIDATE,
+        nargs: 1,
+        normalize: true,
+        requiresArg: true,
+        type: 'string',
+    },
+    typedoc: {
+        default: true,
+        description: 'Validate TypoDoc config',
+        group: NAME_GROUP_VALIDATE,
+        type: 'boolean',
+    },
+    'typedoc-json': {
+        defaultDescription: './typedoc.json',
+        describe: 'Path to typedoc.json',
+        group: NAME_GROUP_VALIDATE,
+        nargs: 1,
+        normalize: true,
+        requiresArg: true,
+        type: 'string',
+    },
+    typescript: {
+        default: true,
+        description: 'Validate TypeScript config',
+        group: NAME_GROUP_VALIDATE,
+        type: 'boolean',
+    },
+};
+opts;
+const validateCommand = {
+    command: 'validate',
+    describe: 'Validate Environment',
+    builder: opts,
+    async handler(args) {
+        if (!args.python && !args.typedoc && !args.typescript) {
+            // specifically not a DocutilsError
+            throw new Error('No validation targets specified; one or more of --python, --typescript or --typedoc must be provided');
+        }
+        await (0, validate_1.validate)(args);
+    },
+};
+exports.default = validateCommand;
+//# sourceMappingURL=command-validate.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"command-validate.js","sourceRoot":"","sources":["../../../lib/cli/command-validate.ts"],"names":[],"mappings":";;AACA,0CAAqC;AAErC,MAAM,mBAAmB,GAAG,aAAa,CAAC;AAE1C,MAAM,IAAI,GAAG;IACX,MAAM,EAAE;QACN,OAAO,EAAE,IAAI;QACb,WAAW,EAAE,+BAA+B;QAC5C,KAAK,EAAE,mBAAmB;QAC1B,IAAI,EAAE,SAAS;KAChB;IACD,aAAa,EAAE;QACb,kBAAkB,EAAE,sBAAsB;QAC1C,WAAW,EAAE,6BAA6B;QAC1C,KAAK,EAAE,mBAAmB;QAC1B,KAAK,EAAE,CAAC;QACR,SAAS,EAAE,IAAI;QACf,WAAW,EAAE,IAAI;QACjB,IAAI,EAAE,QAAQ;KACf;IACD,eAAe,EAAE;QACf,kBAAkB,EAAE,iBAAiB;QACrC,QAAQ,EAAE,uBAAuB;QACjC,KAAK,EAAE,mBAAmB;QAC1B,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,yBAAyB;QACtC,KAAK,EAAE,mBAAmB;QAC1B,IAAI,EAAE,SAAS;KAChB;IACD,cAAc,EAAE;QACd,kBAAkB,EAAE,gBAAgB;QACpC,QAAQ,EAAE,sBAAsB;QAChC,KAAK,EAAE,mBAAmB;QAC1B,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,4BAA4B;QACzC,KAAK,EAAE,mBAAmB;QAC1B,IAAI,EAAE,SAAS;KAChB;CACO,CAAC;AACX,IAA+B,CAAC;AAEhC,MAAM,eAAe,GAAuC;IAC1D,OAAO,EAAE,UAAU;IACnB,QAAQ,EAAE,sBAAsB;IAChC,OAAO,EAAE,IAAI;IACb,KAAK,CAAC,OAAO,CAAC,IAAI;QAChB,IAAI,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE;YACrD,mCAAmC;YACnC,MAAM,IAAI,KAAK,CACb,sGAAsG,CACvG,CAAC;SACH;QACD,MAAM,IAAA,mBAAQ,EAAC,IAAI,CAAC,CAAC;IACvB,CAAC;CACF,CAAC;AAEF,kBAAe,eAAe,CAAC"}

package/build/lib/cli/config.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Handles reading of a config file for docutils
+ * @module
+ */
+/**
+ * Controls how we load/find a config file.
+ *
+ * Takes _raw_ args from the CLI, and uses `yargs-parser` to parse them as to not interfere with the
+ * main usage of args.
+ *
+ * We're looking for various things in the CLI args:
+ * - `--no-config` - if this is present, we don't load a config file
+ * - `--log-level` - if this is present, we set the log level
+ * - `--verbose` - same as above
+ * - `--config` - if this is present, we load the config file at the given path
+ * - `--help`, `--version` - do nothing
+ * @param argv Raw CLI args
+ * @returns
+ */
+export declare function findConfig(argv?: string[]): Promise<any>;
+/**
+ * Loads a config file or finds and loads one if none provided
+ * @param filepath Config file path, if provided
+ * @param cwd Current working directory
+ * @returns A config object or an empty object. Could be anything; `yargs` will validate it.
+ */
+export declare function loadConfig(filepath?: string, cwd?: string): Promise<any>;
+//# sourceMappingURL=config.d.ts.map

package/build/lib/cli/config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../../lib/cli/config.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAwBH;;;;;;;;;;;;;;GAcG;AACH,wBAAsB,UAAU,CAAC,IAAI,GAAE,MAAM,EAA0B,gBAUtE;AAED;;;;;GAKG;AACH,wBAAsB,UAAU,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,GAAG,SAAgB,GAAG,OAAO,CAAC,GAAG,CAAC,CA4BrF"}