@appium/docutils 0.2.2 → 0.3.0

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

@@ -1,74 +1,82 @@
-import { CommandModule, InferredOptionTypes } from 'yargs';
-declare const _default: CommandModule<{}, InferredOptionTypes<Readonly<{
-    mkdocs: {
-        default: boolean;
-        description: string;
-        group: string;
-        type: "boolean";
+/**
+ * Yargs command module for the `validate` command.
+ * @module
+ */
+import type { CommandModule, InferredOptionTypes } from 'yargs';
+declare enum ValidateCommandGroup {
+    Behavior = "Validation Behavior:",
+    Paths = "Custom Paths:"
+}
+declare const _default: CommandModule<object, InferredOptionTypes<{
+    readonly mkdocs: {
+        readonly default: true;
+        readonly description: "Validate MkDocs environment";
+        readonly group: ValidateCommandGroup.Behavior;
+        readonly type: "boolean";
     };
-    'mkdocs-yml': {
-        defaultDescription: string;
-        description: string;
-        group: string;
-        nargs: number;
-        normalize: true;
-        requiresArg: true;
-        type: "string";
+    readonly 'mkdocs-yml': {
+        readonly defaultDescription: "./mkdocs.yml";
+        readonly description: "Path to mkdocs.yml";
+        readonly group: ValidateCommandGroup.Paths;
+        readonly nargs: 1;
+        readonly normalize: true;
+        readonly requiresArg: true;
+        readonly type: "string";
     };
-    'npm-path': {
-        defaultDescription: string;
-        description: string;
-        group: string;
-        nargs: number;
-        normalize: true;
-        requiresArg: true;
-        type: "string";
+    readonly 'npm-path': {
+        readonly defaultDescription: "(derived from shell)";
+        readonly description: "Path to npm executable";
+        readonly group: ValidateCommandGroup.Paths;
+        readonly nargs: 1;
+        readonly normalize: true;
+        readonly requiresArg: true;
+        readonly type: "string";
     };
-    python: {
-        default: boolean;
-        description: string;
-        group: string;
-        type: "boolean";
+    readonly python: {
+        readonly default: true;
+        readonly description: "Validate Python 3 environment";
+        readonly group: ValidateCommandGroup.Behavior;
+        readonly type: "boolean";
     };
-    'python-path': {
-        defaultDescription: string;
-        description: string;
-        group: string;
-        nargs: number;
-        normalize: true;
-        requiresArg: true;
-        type: "string";
+    readonly 'python-path': {
+        readonly defaultDescription: "(derived from shell)";
+        readonly description: "Path to python 3 executable";
+        readonly group: ValidateCommandGroup.Paths;
+        readonly nargs: 1;
+        readonly normalize: true;
+        readonly requiresArg: true;
+        readonly type: "string";
     };
-    'tsconfig-json': {
-        defaultDescription: string;
-        describe: string;
-        group: string;
-        nargs: number;
-        normalize: true;
-        requiresArg: true;
-        type: "string";
+    readonly 'tsconfig-json': {
+        readonly defaultDescription: "./tsconfig.json";
+        readonly describe: "Path to tsconfig.json";
+        readonly group: ValidateCommandGroup.Paths;
+        readonly nargs: 1;
+        readonly normalize: true;
+        readonly requiresArg: true;
+        readonly type: "string";
     };
-    typedoc: {
-        default: boolean;
-        description: string;
-        group: string;
-        type: "boolean";
+    readonly typedoc: {
+        readonly default: true;
+        readonly description: "Validate TypoDoc environment";
+        readonly group: ValidateCommandGroup.Behavior;
+        readonly type: "boolean";
     };
-    'typedoc-json': {
-        defaultDescription: string;
-        describe: string;
-        group: string;
-        nargs: number;
-        normalize: true;
-        requiresArg: true;
-        type: "string";
+    readonly 'typedoc-json': {
+        readonly defaultDescription: "./typedoc.json";
+        readonly describe: "Path to typedoc.json";
+        readonly group: ValidateCommandGroup.Paths;
+        readonly nargs: 1;
+        readonly normalize: true;
+        readonly requiresArg: true;
+        readonly type: "string";
     };
-    typescript: {
-        default: boolean;
-        description: string;
-        group: string;
-        type: "boolean";
+    readonly typescript: {
+        readonly default: true;
+        readonly description: "Validate TypeScript environment";
+        readonly group: ValidateCommandGroup.Behavior;
+        readonly type: "boolean";
     };
-}>>>;
+}>>;
 export default _default;
 //# sourceMappingURL=validate.d.ts.map

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

@@ -1 +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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAoFlE,wBAmCwC"}
+{"version":3,"file":"validate.d.ts","sourceRoot":"","sources":["../../../../lib/cli/command/validate.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,KAAK,EAAC,aAAa,EAAE,mBAAmB,EAAU,MAAM,OAAO,CAAC;AAQvE,aAAK,oBAAoB;IACvB,QAAQ,yBAAyB;IACjC,KAAK,kBAAkB;CACxB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA4ED,wBAmC4C"}

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

@@ -1,26 +1,34 @@
 "use strict";
+/**
+ * Yargs command module for the `validate` command.
+ * @module
+ */
 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 support_1 = require("@appium/support");
 const error_1 = require("../../error");
 const validate_1 = require("../../validate");
 const logger_1 = __importDefault(require("../../logger"));
+const check_1 = require("../check");
 const log = logger_1.default.withTag('validate');
-const NAME_GROUP_VALIDATE = 'Validation Behavior:';
-const NAME_GROUP_VALIDATE_PATHS = 'Paths:';
-const opts = Object.freeze({
+var ValidateCommandGroup;
+(function (ValidateCommandGroup) {
+    ValidateCommandGroup["Behavior"] = "Validation Behavior:";
+    ValidateCommandGroup["Paths"] = "Custom Paths:";
+})(ValidateCommandGroup || (ValidateCommandGroup = {}));
+const opts = {
     mkdocs: {
         default: true,
         description: 'Validate MkDocs environment',
-        group: NAME_GROUP_VALIDATE,
+        group: ValidateCommandGroup.Behavior,
         type: 'boolean',
     },
     'mkdocs-yml': {
         defaultDescription: './mkdocs.yml',
         description: 'Path to mkdocs.yml',
-        group: NAME_GROUP_VALIDATE_PATHS,
+        group: ValidateCommandGroup.Paths,
         nargs: 1,
         normalize: true,
         requiresArg: true,
@@ -29,7 +37,7 @@ const opts = Object.freeze({
     'npm-path': {
         defaultDescription: '(derived from shell)',
         description: 'Path to npm executable',
-        group: NAME_GROUP_VALIDATE_PATHS,
+        group: ValidateCommandGroup.Paths,
         nargs: 1,
         normalize: true,
         requiresArg: true,
@@ -38,13 +46,13 @@ const opts = Object.freeze({
     python: {
         default: true,
         description: 'Validate Python 3 environment',
-        group: NAME_GROUP_VALIDATE,
+        group: ValidateCommandGroup.Behavior,
         type: 'boolean',
     },
     'python-path': {
         defaultDescription: '(derived from shell)',
         description: 'Path to python 3 executable',
-        group: NAME_GROUP_VALIDATE_PATHS,
+        group: ValidateCommandGroup.Paths,
         nargs: 1,
         normalize: true,
         requiresArg: true,
@@ -53,7 +61,7 @@ const opts = Object.freeze({
     'tsconfig-json': {
         defaultDescription: './tsconfig.json',
         describe: 'Path to tsconfig.json',
-        group: NAME_GROUP_VALIDATE_PATHS,
+        group: ValidateCommandGroup.Paths,
         nargs: 1,
         normalize: true,
         requiresArg: true,
@@ -62,13 +70,13 @@ const opts = Object.freeze({
     typedoc: {
         default: true,
         description: 'Validate TypoDoc environment',
-        group: NAME_GROUP_VALIDATE,
+        group: ValidateCommandGroup.Behavior,
         type: 'boolean',
     },
     'typedoc-json': {
         defaultDescription: './typedoc.json',
         describe: 'Path to typedoc.json',
-        group: NAME_GROUP_VALIDATE_PATHS,
+        group: ValidateCommandGroup.Paths,
         nargs: 1,
         normalize: true,
         requiresArg: true,
@@ -77,19 +85,22 @@ const opts = Object.freeze({
     typescript: {
         default: true,
         description: 'Validate TypeScript environment',
-        group: NAME_GROUP_VALIDATE,
+        group: ValidateCommandGroup.Behavior,
         type: 'boolean',
     },
-});
+};
 exports.default = {
     command: 'validate',
     describe: 'Validate Environment',
-    builder: opts,
+    builder(yargs) {
+        return yargs.options(opts).check(async (argv) => {
+            if (!argv.python && !argv.typedoc && !argv.typescript && !argv.mkdocs) {
+                return 'No validation targets specified; one or more of --python, --typescript, --typedoc or --mkdocs must be provided';
+            }
+            return (0, check_1.checkMissingPaths)(opts, ValidateCommandGroup.Paths, argv);
+        });
+    },
     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) => {
@@ -106,7 +117,7 @@ exports.default = {
         });
         await validator.validate();
         if (errorCount) {
-            throw new error_1.DocutilsError(`Validation failed with ${errorCount} ${(0, pluralize_1.default)('error', errorCount)}`);
+            throw new error_1.DocutilsError(`Validation failed with ${errorCount} ${support_1.util.pluralize('error', errorCount)}`);
         }
     },
 };

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

@@ -1 +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,MAAM,CAAC,MAAM,CAAC;IACzB,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;CACF,CAAmC,CAAC;AAIrC,kBAAe;IACb,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;CACoC,CAAC"}
+{"version":3,"file":"validate.js","sourceRoot":"","sources":["../../../../lib/cli/command/validate.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;AAEH,6CAAqC;AAErC,uCAA0C;AAC1C,6CAAiE;AACjE,0DAAkC;AAClC,oCAA2C;AAE3C,MAAM,GAAG,GAAG,gBAAM,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;AAEvC,IAAK,oBAGJ;AAHD,WAAK,oBAAoB;IACvB,yDAAiC,CAAA;IACjC,+CAAuB,CAAA;AACzB,CAAC,EAHI,oBAAoB,KAApB,oBAAoB,QAGxB;AAED,MAAM,IAAI,GAAG;IACX,MAAM,EAAE;QACN,OAAO,EAAE,IAAI;QACb,WAAW,EAAE,6BAA6B;QAC1C,KAAK,EAAE,oBAAoB,CAAC,QAAQ;QACpC,IAAI,EAAE,SAAS;KAChB;IACD,YAAY,EAAE;QACZ,kBAAkB,EAAE,cAAc;QAClC,WAAW,EAAE,oBAAoB;QACjC,KAAK,EAAE,oBAAoB,CAAC,KAAK;QACjC,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,oBAAoB,CAAC,KAAK;QACjC,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,oBAAoB,CAAC,QAAQ;QACpC,IAAI,EAAE,SAAS;KAChB;IACD,aAAa,EAAE;QACb,kBAAkB,EAAE,sBAAsB;QAC1C,WAAW,EAAE,6BAA6B;QAC1C,KAAK,EAAE,oBAAoB,CAAC,KAAK;QACjC,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,oBAAoB,CAAC,KAAK;QACjC,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,oBAAoB,CAAC,QAAQ;QACpC,IAAI,EAAE,SAAS;KAChB;IACD,cAAc,EAAE;QACd,kBAAkB,EAAE,gBAAgB;QACpC,QAAQ,EAAE,sBAAsB;QAChC,KAAK,EAAE,oBAAoB,CAAC,KAAK;QACjC,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,oBAAoB,CAAC,QAAQ;QACpC,IAAI,EAAE,SAAS;KAChB;CACyC,CAAC;AAI7C,kBAAe;IACb,OAAO,EAAE,UAAU;IACnB,QAAQ,EAAE,sBAAsB;IAChC,OAAO,CAAC,KAAK;QACX,OAAO,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE;YAC9C,IAAI,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,IAAI,CAAC,IAAI,CAAC,UAAU,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;gBACrE,OAAO,gHAAgH,CAAC;aACzH;YACD,OAAO,IAAA,yBAAiB,EAAC,IAAI,EAAE,oBAAoB,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;QACnE,CAAC,CAAC,CAAC;IACL,CAAC;IACD,KAAK,CAAC,OAAO,CAAC,IAAI;QAChB,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,cAAI,CAAC,SAAS,CAAC,OAAO,EAAE,UAAU,CAAC,EAAE,CAC9E,CAAC;SACH;IACH,CAAC;CACwC,CAAC"}

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../lib/cli/index.ts"],"names":[],"mappings":";AAYA,wBAAsB,IAAI,CAAC,IAAI,WAAwB;;;;;;;;;;GAoEtD"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../lib/cli/index.ts"],"names":[],"mappings":";AAuBA,wBAAsB,IAAI,CAAC,IAAI,WAAwB;;;;;;;;;;GA4EtD"}

package/build/lib/cli/index.js

@@ -1,10 +1,15 @@
 #!/usr/bin/env node
 "use strict";
+/* eslint-disable no-console */
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.main = void 0;
+/**
+ * Main CLI entry point for `@appium/docutils`
+ * @module
+ */
 const logger_1 = __importDefault(require("../logger"));
 const lodash_1 = __importDefault(require("lodash"));
 const helpers_1 = require("yargs/helpers");
@@ -13,6 +18,9 @@ const constants_1 = require("../constants");
 const error_1 = require("../error");
 const command_1 = require("./command");
 const config_1 = require("./config");
+const support_1 = require("@appium/support");
+const read_pkg_1 = require("read-pkg");
+const pkg = (0, read_pkg_1.sync)({ cwd: support_1.fs.findRoot(__dirname) });
 const log = logger_1.default.withTag('cli');
 async function main(argv = (0, helpers_1.hideBin)(process.argv)) {
     const config = await (0, config_1.findConfig)(argv);
@@ -48,17 +56,25 @@ async function main(argv = (0, helpers_1.hideBin)(process.argv)) {
             describe: 'Disable config file discovery',
         },
     })
-        .middleware(
-    /**
-     * Configures logging; `--verbose` implies `--log-level=debug`
-     */
-    (argv) => {
-        if (argv.verbose) {
-            argv.logLevel = 'debug';
-            log.debug('Debug logging enabled via --verbose');
-        }
-        log.level = constants_1.LogLevelMap[argv.logLevel];
-    })
+        .middleware([
+        /**
+         * Configures logging; `--verbose` implies `--log-level=debug`
+         */
+        (argv) => {
+            if (argv.verbose) {
+                argv.logLevel = 'debug';
+                log.debug('Debug logging enabled via --verbose');
+            }
+            log.level = constants_1.LogLevelMap[argv.logLevel];
+        },
+        /**
+         * Writes a startup message, if logging is enabled
+         */
+        async () => {
+            log.info(`${pkg.name} @ v${pkg.version} (Node.js ${process.version})`);
+        },
+    ])
+        .epilog(`Please report bugs at ${pkg.bugs?.url}`)
         .fail(
     /**
      * Custom failure handler so we can log nicely.
@@ -70,6 +86,7 @@ async function main(argv = (0, helpers_1.hideBin)(process.argv)) {
         }
         else {
             y.showHelp();
+            console.log();
             log.error(msg ?? error.message);
         }
         y.exit(1, error);
@@ -83,7 +100,7 @@ async function main(argv = (0, helpers_1.hideBin)(process.argv)) {
 }
 exports.main = main;
 if (require.main === module) {
-    // eslint-disable-next-line promise/prefer-await-to-then
+    // eslint-disable-next-line promise/prefer-await-to-then, promise/prefer-await-to-callbacks
     main().catch((err) => {
         log.error('Caught otherwise-unhandled rejection (this is probably a bug):', err);
     });

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../lib/cli/index.ts"],"names":[],"mappings":";;;;;;;AACA,uDAA+B;AAE/B,oDAAuB;AACvB,2CAAsC;AACtC,wDAAgC;AAChC,4CAAsE;AACtE,oCAAuC;AACvC,uCAAgD;AAChD,qCAAoC;AAEpC,MAAM,GAAG,GAAG,gBAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;AAC3B,KAAK,UAAU,IAAI,CAAC,IAAI,GAAG,IAAA,iBAAO,EAAC,OAAO,CAAC,IAAI,CAAC;IACrD,MAAM,MAAM,GAAG,MAAM,IAAA,mBAAU,EAAC,IAAI,CAAC,CAAC;IAEtC,MAAM,CAAC,GAAG,IAAA,eAAK,EAAC,IAAI,CAAC,CAAC;IACtB,OAAO,MAAM,CAAC;SACX,UAAU,CAAC,oBAAQ,CAAC;SACpB,OAAO,CAAC,eAAK,CAAC;SACd,OAAO,CAAC,cAAI,CAAC;SACb,OAAO,CAAC,kBAAQ,CAAC;SACjB,OAAO,CAAC;QACP,OAAO,EAAE;YACP,IAAI,EAAE,SAAS;YACf,QAAQ,EAAE,6BAA6B;SACxC;QACD,WAAW,EAAE;YACX,KAAK,EAAE,GAAG;YACV,OAAO,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,CAAC;YACrD,QAAQ,EAAE,oBAAoB;YAC9B,OAAO,EAAE,6BAAiB;YAC1B,MAAM,EAAE,gBAAC,CAAC,QAAmD;SAC9D;QACD,MAAM,EAAE;YACN,KAAK,EAAE,GAAG;YACV,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,qBAAqB;YAC/B,SAAS,EAAE,IAAI;YACf,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,IAAI;YACjB,kBAAkB,EAAE,4BAA4B;SACjD;QACD,WAAW,EAAE;YACX,IAAI,EAAE,SAAS;YACf,QAAQ,EAAE,+BAA+B;SAC1C;KACF,CAAC;SACD,UAAU;IACT;;OAEG;IACH,CAAC,IAAI,EAAE,EAAE;QACP,IAAI,IAAI,CAAC,OAAO,EAAE;YAChB,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;YACxB,GAAG,CAAC,KAAK,CAAC,qCAAqC,CAAC,CAAC;SAClD;QACD,GAAG,CAAC,KAAK,GAAG,uBAAW,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACzC,CAAC,CACF;SACA,IAAI;IACH;;OAEG;IACH,CAAC,GAAkB,EAAE,KAAK,EAAE,EAAE;QAC5B,8DAA8D;QAC9D,IAAI,KAAK,YAAY,qBAAa,EAAE;YAClC,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;SAC1B;aAAM;YACL,CAAC,CAAC,QAAQ,EAAE,CAAC;YACb,GAAG,CAAC,KAAK,CAAC,GAAG,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC;SACjC;QACD,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;IACnB,CAAC,CACF;SACA,MAAM,CAAC,MAAM,CAAC;QACf,qEAAqE;SACpE,aAAa,CAAC,CAAC,CAAC;QACjB,gDAAgD;SAC/C,MAAM,EAAE;SACR,UAAU,EAAE,CAAC;AAClB,CAAC;AApED,oBAoEC;AAED,IAAI,OAAO,CAAC,IAAI,KAAK,MAAM,EAAE;IAC3B,wDAAwD;IACxD,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;QACnB,GAAG,CAAC,KAAK,CAAC,gEAAgE,EAAE,GAAG,CAAC,CAAC;IACnF,CAAC,CAAC,CAAC;CACJ"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../lib/cli/index.ts"],"names":[],"mappings":";;AACA,+BAA+B;;;;;;AAE/B;;;GAGG;AAEH,uDAA+B;AAE/B,oDAAuB;AACvB,2CAAsC;AACtC,wDAAgC;AAChC,4CAAsE;AACtE,oCAAuC;AACvC,uCAAgD;AAChD,qCAAoC;AACpC,6CAAmC;AACnC,uCAAyC;AAEzC,MAAM,GAAG,GAAG,IAAA,eAAO,EAAC,EAAC,GAAG,EAAE,YAAE,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAC,CAAC,CAAC;AAEnD,MAAM,GAAG,GAAG,gBAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;AAC3B,KAAK,UAAU,IAAI,CAAC,IAAI,GAAG,IAAA,iBAAO,EAAC,OAAO,CAAC,IAAI,CAAC;IACrD,MAAM,MAAM,GAAG,MAAM,IAAA,mBAAU,EAAC,IAAI,CAAC,CAAC;IAEtC,MAAM,CAAC,GAAG,IAAA,eAAK,EAAC,IAAI,CAAC,CAAC;IACtB,OAAO,MAAM,CAAC;SACX,UAAU,CAAC,oBAAQ,CAAC;SACpB,OAAO,CAAC,eAAK,CAAC;SACd,OAAO,CAAC,cAAI,CAAC;SACb,OAAO,CAAC,kBAAQ,CAAC;SACjB,OAAO,CAAC;QACP,OAAO,EAAE;YACP,IAAI,EAAE,SAAS;YACf,QAAQ,EAAE,6BAA6B;SACxC;QACD,WAAW,EAAE;YACX,KAAK,EAAE,GAAG;YACV,OAAO,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,CAAC;YACrD,QAAQ,EAAE,oBAAoB;YAC9B,OAAO,EAAE,6BAAiB;YAC1B,MAAM,EAAE,gBAAC,CAAC,QAAmD;SAC9D;QACD,MAAM,EAAE;YACN,KAAK,EAAE,GAAG;YACV,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,qBAAqB;YAC/B,SAAS,EAAE,IAAI;YACf,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,IAAI;YACjB,kBAAkB,EAAE,4BAA4B;SACjD;QACD,WAAW,EAAE;YACX,IAAI,EAAE,SAAS;YACf,QAAQ,EAAE,+BAA+B;SAC1C;KACF,CAAC;SACD,UAAU,CAAC;QACV;;WAEG;QACH,CAAC,IAAI,EAAE,EAAE;YACP,IAAI,IAAI,CAAC,OAAO,EAAE;gBAChB,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;gBACxB,GAAG,CAAC,KAAK,CAAC,qCAAqC,CAAC,CAAC;aAClD;YACD,GAAG,CAAC,KAAK,GAAG,uBAAW,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACzC,CAAC;QACD;;WAEG;QACH,KAAK,IAAI,EAAE;YACT,GAAG,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC,IAAI,OAAO,GAAG,CAAC,OAAO,aAAa,OAAO,CAAC,OAAO,GAAG,CAAC,CAAC;QACzE,CAAC;KACF,CAAC;SACD,MAAM,CAAC,yBAAyB,GAAG,CAAC,IAAI,EAAE,GAAG,EAAE,CAAC;SAChD,IAAI;IACH;;OAEG;IACH,CAAC,GAAkB,EAAE,KAAK,EAAE,EAAE;QAC5B,8DAA8D;QAC9D,IAAI,KAAK,YAAY,qBAAa,EAAE;YAClC,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;SAC1B;aAAM;YACL,CAAC,CAAC,QAAQ,EAAE,CAAC;YACb,OAAO,CAAC,GAAG,EAAE,CAAC;YACd,GAAG,CAAC,KAAK,CAAC,GAAG,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC;SACjC;QACD,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;IACnB,CAAC,CACF;SACA,MAAM,CAAC,MAAM,CAAC;QACf,qEAAqE;SACpE,aAAa,CAAC,CAAC,CAAC;QACjB,gDAAgD;SAC/C,MAAM,EAAE;SACR,UAAU,EAAE,CAAC;AAClB,CAAC;AA5ED,oBA4EC;AAED,IAAI,OAAO,CAAC,IAAI,KAAK,MAAM,EAAE;IAC3B,2FAA2F;IAC3F,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;QACnB,GAAG,CAAC,KAAK,CAAC,gEAAgE,EAAE,GAAG,CAAC,CAAC;IACnF,CAAC,CAAC,CAAC;CACJ"}

package/build/lib/constants.d.ts

@@ -72,6 +72,10 @@ export declare const NAME_ERR_ENOENT = "ENOENT";
  * Code for a "file already exists" error
  */
 export declare const NAME_ERR_EEXIST = "EEXIST";
+/**
+ * Name of the default theme
+ */
+export declare const NAME_THEME = "material";
 /**
  * Default log level
  */

package/build/lib/constants.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../lib/constants.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAAC,QAAQ,EAAC,MAAM,SAAS,CAAC;AAIjC,OAAO,EAAC,WAAW,EAAC,MAAM,WAAW,CAAC;AAEtC;;GAEG;AACH,eAAO,MAAM,QAAQ,gBAAgB,CAAC;AAEtC;;GAEG;AACH,eAAO,MAAM,eAAe,eAAe,CAAC;AAE5C;;GAEG;AACH,eAAO,MAAM,kBAAkB,kBAAkB,CAAC;AAClD;;GAEG;AACH,eAAO,MAAM,WAAW,WAAW,CAAC;AACpC;;GAEG;AACH,eAAO,MAAM,iBAAiB,iBAAiB,CAAC;AAChD;;GAEG;AACH,eAAO,MAAM,iBAAiB,iBAAiB,CAAC;AAChD;;GAEG;AACH,eAAO,MAAM,qBAAqB,qBAAqB,CAAC;AACxD;;;GAGG;AACH,eAAO,MAAM,WAAW,YAAY,CAAC;AACrC;;GAEG;AACH,eAAO,MAAM,WAAW,WAAW,CAAC;AAEpC;;GAEG;AACH,eAAO,MAAM,SAAS,SAAS,CAAC;AAEhC;;GAEG;AACH,eAAO,MAAM,YAAY,YAAY,CAAC;AAEtC;;;;;GAKG;AACH,eAAO,MAAM,QAAQ,QAAQ,CAAC;AAE9B;;GAEG;AACH,eAAO,MAAM,QAAQ,QAAQ,CAAC;AAE9B;;GAEG;AACH,eAAO,MAAM,eAAe,eAAe,CAAC;AAE5C;;GAEG;AACH,eAAO,MAAM,eAAe,WAAW,CAAC;AAExC;;GAEG;AACH,eAAO,MAAM,eAAe,WAAW,CAAC;AAExC;;GAEG;AACH,eAAO,MAAM,iBAAiB,SAAS,CAAC;AACxC;;GAEG;AACH,eAAO,MAAM,YAAY,QAAyB,CAAC;AACnD;;GAEG;AAEH,eAAO,MAAM,YAAY,EAAE,WAE1B,CAAC;AAEF;;GAEG;AAEH,eAAO,MAAM,qBAAqB,QAAiD,CAAC;AAEpF;;GAEG;AACH,eAAO,MAAM,4BAA4B,QAAiC,CAAC;AAE3E;;GAEG;AACH,eAAO,MAAM,qBAAqB,aAAa,CAAC;AAEhD;;GAEG;AACH,eAAO,MAAM,qBAAqB,WAAW,CAAC;AAE9C;;GAEG;AACH,eAAO,MAAM,kBAAkB,OAAO,CAAC;AAEvC;;GAEG;AACH,eAAO,MAAM,kBAAkB,cAAc,CAAC;AAE9C;;GAEG;AACH,eAAO,MAAM,WAAW;;;;;;CAMd,CAAC;AAEX;;GAEG;AACH,eAAO,MAAM,kBAAkB,cAAc,CAAC"}
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../lib/constants.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAAC,QAAQ,EAAC,MAAM,SAAS,CAAC;AAIjC,OAAO,EAAC,WAAW,EAAC,MAAM,WAAW,CAAC;AAEtC;;GAEG;AACH,eAAO,MAAM,QAAQ,gBAAgB,CAAC;AAEtC;;GAEG;AACH,eAAO,MAAM,eAAe,eAAe,CAAC;AAE5C;;GAEG;AACH,eAAO,MAAM,kBAAkB,kBAAkB,CAAC;AAClD;;GAEG;AACH,eAAO,MAAM,WAAW,WAAW,CAAC;AACpC;;GAEG;AACH,eAAO,MAAM,iBAAiB,iBAAiB,CAAC;AAChD;;GAEG;AACH,eAAO,MAAM,iBAAiB,iBAAiB,CAAC;AAChD;;GAEG;AACH,eAAO,MAAM,qBAAqB,qBAAqB,CAAC;AACxD;;;GAGG;AACH,eAAO,MAAM,WAAW,YAAY,CAAC;AACrC;;GAEG;AACH,eAAO,MAAM,WAAW,WAAW,CAAC;AAEpC;;GAEG;AACH,eAAO,MAAM,SAAS,SAAS,CAAC;AAEhC;;GAEG;AACH,eAAO,MAAM,YAAY,YAAY,CAAC;AAEtC;;;;;GAKG;AACH,eAAO,MAAM,QAAQ,QAAQ,CAAC;AAE9B;;GAEG;AACH,eAAO,MAAM,QAAQ,QAAQ,CAAC;AAE9B;;GAEG;AACH,eAAO,MAAM,eAAe,eAAe,CAAC;AAE5C;;GAEG;AACH,eAAO,MAAM,eAAe,WAAW,CAAC;AAExC;;GAEG;AACH,eAAO,MAAM,eAAe,WAAW,CAAC;AAExC;;GAEG;AACH,eAAO,MAAM,UAAU,aAAa,CAAC;AAErC;;GAEG;AACH,eAAO,MAAM,iBAAiB,SAAS,CAAC;AACxC;;GAEG;AACH,eAAO,MAAM,YAAY,QAAyB,CAAC;AACnD;;GAEG;AAEH,eAAO,MAAM,YAAY,EAAE,WAE1B,CAAC;AAEF;;GAEG;AAEH,eAAO,MAAM,qBAAqB,QAAiD,CAAC;AAEpF;;GAEG;AACH,eAAO,MAAM,4BAA4B,QAAiC,CAAC;AAE3E;;GAEG;AACH,eAAO,MAAM,qBAAqB,aAAa,CAAC;AAEhD;;GAEG;AACH,eAAO,MAAM,qBAAqB,WAAW,CAAC;AAE9C;;GAEG;AACH,eAAO,MAAM,kBAAkB,OAAO,CAAC;AAEvC;;GAEG;AACH,eAAO,MAAM,kBAAkB,cAAc,CAAC;AAE9C;;GAEG;AACH,eAAO,MAAM,WAAW;;;;;;CAMd,CAAC;AAEX;;GAEG;AACH,eAAO,MAAM,kBAAkB,cAAc,CAAC"}

package/build/lib/constants.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DEFAULT_NAV_HEADER = exports.LogLevelMap = exports.DEFAULT_SERVE_HOST = exports.DEFAULT_SERVE_PORT = exports.DEFAULT_DEPLOY_REMOTE = exports.DEFAULT_DEPLOY_BRANCH = exports.DEFAULT_REL_TYPEDOC_OUT_PATH = exports.REQUIREMENTS_TXT_PATH = exports.DOCUTILS_PKG = exports.PKG_ROOT_DIR = exports.DEFAULT_LOG_LEVEL = exports.NAME_ERR_EEXIST = exports.NAME_ERR_ENOENT = exports.NAME_TYPESCRIPT = exports.NAME_NPM = exports.NAME_PIP = exports.NAME_TYPEDOC = exports.NAME_MIKE = exports.NAME_MKDOCS = exports.NAME_SCHEMA = exports.NAME_REQUIREMENTS_TXT = exports.NAME_PACKAGE_JSON = exports.NAME_TYPEDOC_JSON = exports.NAME_PYTHON = exports.NAME_TSCONFIG_JSON = exports.NAME_MKDOCS_YML = exports.NAME_BIN = void 0;
+exports.DEFAULT_NAV_HEADER = exports.LogLevelMap = exports.DEFAULT_SERVE_HOST = exports.DEFAULT_SERVE_PORT = exports.DEFAULT_DEPLOY_REMOTE = exports.DEFAULT_DEPLOY_BRANCH = exports.DEFAULT_REL_TYPEDOC_OUT_PATH = exports.REQUIREMENTS_TXT_PATH = exports.DOCUTILS_PKG = exports.PKG_ROOT_DIR = exports.DEFAULT_LOG_LEVEL = exports.NAME_THEME = exports.NAME_ERR_EEXIST = exports.NAME_ERR_ENOENT = exports.NAME_TYPESCRIPT = exports.NAME_NPM = exports.NAME_PIP = exports.NAME_TYPEDOC = exports.NAME_MIKE = exports.NAME_MKDOCS = exports.NAME_SCHEMA = exports.NAME_REQUIREMENTS_TXT = exports.NAME_PACKAGE_JSON = exports.NAME_TYPEDOC_JSON = exports.NAME_PYTHON = exports.NAME_TSCONFIG_JSON = exports.NAME_MKDOCS_YML = exports.NAME_BIN = void 0;
 /**
  * Constants used across various modules in this package
  * @module
@@ -80,6 +80,10 @@ exports.NAME_ERR_ENOENT = 'ENOENT';
  * Code for a "file already exists" error
  */
 exports.NAME_ERR_EEXIST = 'EEXIST';
+/**
+ * Name of the default theme
+ */
+exports.NAME_THEME = 'material';
 /**
  * Default log level
  */

package/build/lib/constants.js.map

@@ -1 +1 @@
-{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../lib/constants.ts"],"names":[],"mappings":";;;;;;AAAA;;;GAGG;AACH,qCAAiC;AACjC,qCAAqC;AACrC,6CAAmC;AACnC,0DAA6B;AAG7B;;GAEG;AACU,QAAA,QAAQ,GAAG,aAAa,CAAC;AAEtC;;GAEG;AACU,QAAA,eAAe,GAAG,YAAY,CAAC;AAE5C;;GAEG;AACU,QAAA,kBAAkB,GAAG,eAAe,CAAC;AAClD;;GAEG;AACU,QAAA,WAAW,GAAG,QAAQ,CAAC;AACpC;;GAEG;AACU,QAAA,iBAAiB,GAAG,cAAc,CAAC;AAChD;;GAEG;AACU,QAAA,iBAAiB,GAAG,cAAc,CAAC;AAChD;;GAEG;AACU,QAAA,qBAAqB,GAAG,kBAAkB,CAAC;AACxD;;;GAGG;AACU,QAAA,WAAW,GAAG,SAAS,CAAC;AACrC;;GAEG;AACU,QAAA,WAAW,GAAG,QAAQ,CAAC;AAEpC;;GAEG;AACU,QAAA,SAAS,GAAG,MAAM,CAAC;AAEhC;;GAEG;AACU,QAAA,YAAY,GAAG,SAAS,CAAC;AAEtC;;;;;GAKG;AACU,QAAA,QAAQ,GAAG,KAAK,CAAC;AAE9B;;GAEG;AACU,QAAA,QAAQ,GAAG,KAAK,CAAC;AAE9B;;GAEG;AACU,QAAA,eAAe,GAAG,YAAY,CAAC;AAE5C;;GAEG;AACU,QAAA,eAAe,GAAG,QAAQ,CAAC;AAExC;;GAEG;AACU,QAAA,eAAe,GAAG,QAAQ,CAAC;AAExC;;GAEG;AACU,QAAA,iBAAiB,GAAG,MAAM,CAAC;AACxC;;GAEG;AACU,QAAA,YAAY,GAAG,YAAE,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;AACnD;;GAEG;AAEU,QAAA,YAAY,GAAgB,IAAI,CAAC,KAAK,CACjD,IAAA,sBAAY,EAAC,mBAAI,CAAC,IAAI,CAAC,oBAAY,EAAE,yBAAiB,CAAC,EAAE,MAAM,CAAC,CACjE,CAAC;AAEF;;GAEG;AAEU,QAAA,qBAAqB,GAAG,mBAAI,CAAC,IAAI,CAAC,oBAAY,EAAE,6BAAqB,CAAC,CAAC;AAEpF;;GAEG;AACU,QAAA,4BAA4B,GAAG,mBAAI,CAAC,IAAI,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;AAE3E;;GAEG;AACU,QAAA,qBAAqB,GAAG,UAAU,CAAC;AAEhD;;GAEG;AACU,QAAA,qBAAqB,GAAG,QAAQ,CAAC;AAE9C;;GAEG;AACU,QAAA,kBAAkB,GAAG,IAAI,CAAC;AAEvC;;GAEG;AACU,QAAA,kBAAkB,GAAG,WAAW,CAAC;AAE9C;;GAEG;AACU,QAAA,WAAW,GAAG;IACzB,MAAM,EAAE,kBAAQ,CAAC,MAAM;IACvB,KAAK,EAAE,kBAAQ,CAAC,KAAK;IACrB,IAAI,EAAE,kBAAQ,CAAC,IAAI;IACnB,IAAI,EAAE,kBAAQ,CAAC,IAAI;IACnB,KAAK,EAAE,kBAAQ,CAAC,KAAK;CACb,CAAC;AAEX;;GAEG;AACU,QAAA,kBAAkB,GAAG,WAAW,CAAC"}
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../lib/constants.ts"],"names":[],"mappings":";;;;;;AAAA;;;GAGG;AACH,qCAAiC;AACjC,qCAAqC;AACrC,6CAAmC;AACnC,0DAA6B;AAG7B;;GAEG;AACU,QAAA,QAAQ,GAAG,aAAa,CAAC;AAEtC;;GAEG;AACU,QAAA,eAAe,GAAG,YAAY,CAAC;AAE5C;;GAEG;AACU,QAAA,kBAAkB,GAAG,eAAe,CAAC;AAClD;;GAEG;AACU,QAAA,WAAW,GAAG,QAAQ,CAAC;AACpC;;GAEG;AACU,QAAA,iBAAiB,GAAG,cAAc,CAAC;AAChD;;GAEG;AACU,QAAA,iBAAiB,GAAG,cAAc,CAAC;AAChD;;GAEG;AACU,QAAA,qBAAqB,GAAG,kBAAkB,CAAC;AACxD;;;GAGG;AACU,QAAA,WAAW,GAAG,SAAS,CAAC;AACrC;;GAEG;AACU,QAAA,WAAW,GAAG,QAAQ,CAAC;AAEpC;;GAEG;AACU,QAAA,SAAS,GAAG,MAAM,CAAC;AAEhC;;GAEG;AACU,QAAA,YAAY,GAAG,SAAS,CAAC;AAEtC;;;;;GAKG;AACU,QAAA,QAAQ,GAAG,KAAK,CAAC;AAE9B;;GAEG;AACU,QAAA,QAAQ,GAAG,KAAK,CAAC;AAE9B;;GAEG;AACU,QAAA,eAAe,GAAG,YAAY,CAAC;AAE5C;;GAEG;AACU,QAAA,eAAe,GAAG,QAAQ,CAAC;AAExC;;GAEG;AACU,QAAA,eAAe,GAAG,QAAQ,CAAC;AAExC;;GAEG;AACU,QAAA,UAAU,GAAG,UAAU,CAAC;AAErC;;GAEG;AACU,QAAA,iBAAiB,GAAG,MAAM,CAAC;AACxC;;GAEG;AACU,QAAA,YAAY,GAAG,YAAE,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;AACnD;;GAEG;AAEU,QAAA,YAAY,GAAgB,IAAI,CAAC,KAAK,CACjD,IAAA,sBAAY,EAAC,mBAAI,CAAC,IAAI,CAAC,oBAAY,EAAE,yBAAiB,CAAC,EAAE,MAAM,CAAC,CACjE,CAAC;AAEF;;GAEG;AAEU,QAAA,qBAAqB,GAAG,mBAAI,CAAC,IAAI,CAAC,oBAAY,EAAE,6BAAqB,CAAC,CAAC;AAEpF;;GAEG;AACU,QAAA,4BAA4B,GAAG,mBAAI,CAAC,IAAI,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;AAE3E;;GAEG;AACU,QAAA,qBAAqB,GAAG,UAAU,CAAC;AAEhD;;GAEG;AACU,QAAA,qBAAqB,GAAG,QAAQ,CAAC;AAE9C;;GAEG;AACU,QAAA,kBAAkB,GAAG,IAAI,CAAC;AAEvC;;GAEG;AACU,QAAA,kBAAkB,GAAG,WAAW,CAAC;AAE9C;;GAEG;AACU,QAAA,WAAW,GAAG;IACzB,MAAM,EAAE,kBAAQ,CAAC,MAAM;IACvB,KAAK,EAAE,kBAAQ,CAAC,KAAK;IACrB,IAAI,EAAE,kBAAQ,CAAC,IAAI;IACnB,IAAI,EAAE,kBAAQ,CAAC,IAAI;IACnB,KAAK,EAAE,kBAAQ,CAAC,KAAK;CACb,CAAC;AAEX;;GAEG;AACU,QAAA,kBAAkB,GAAG,WAAW,CAAC"}

package/build/lib/error.d.ts

@@ -1,3 +1,8 @@
+/**
+ * A custom error class. This exists so we can use `instanceof` to differentiate between "expected"
+ * exceptions and unexpected ones.
+ * @module
+ */
 export declare class DocutilsError extends Error {
 }
 //# sourceMappingURL=error.d.ts.map

package/build/lib/error.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"error.d.ts","sourceRoot":"","sources":["../../lib/error.ts"],"names":[],"mappings":"AAAA,qBAAa,aAAc,SAAQ,KAAK;CAAG"}
+{"version":3,"file":"error.d.ts","sourceRoot":"","sources":["../../lib/error.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,qBAAa,aAAc,SAAQ,KAAK;CAAG"}

package/build/lib/error.js

@@ -1,4 +1,9 @@
 "use strict";
+/**
+ * A custom error class. This exists so we can use `instanceof` to differentiate between "expected"
+ * exceptions and unexpected ones.
+ * @module
+ */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DocutilsError = void 0;
 class DocutilsError extends Error {

package/build/lib/error.js.map

@@ -1 +1 @@
-{"version":3,"file":"error.js","sourceRoot":"","sources":["../../lib/error.ts"],"names":[],"mappings":";;;AAAA,MAAa,aAAc,SAAQ,KAAK;CAAG;AAA3C,sCAA2C"}
+{"version":3,"file":"error.js","sourceRoot":"","sources":["../../lib/error.ts"],"names":[],"mappings":";AAAA;;;;GAIG;;;AAEH,MAAa,aAAc,SAAQ,KAAK;CAAG;AAA3C,sCAA2C"}

package/build/lib/fs.d.ts

@@ -73,7 +73,7 @@ declare function _readPkgJson(cwd: string, normalize: true): Promise<{
     pkgPath: string;
     pkg: NormalizedPackageJson;
 }>;
-declare function _readPkgJson(cwd: string): Promise<{
+declare function _readPkgJson(cwd: string, normalize?: false): Promise<{
     pkgPath: string;
     pkg: PackageJson;
 }>;

package/build/lib/fs.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"fs.d.ts","sourceRoot":"","sources":["../../lib/fs.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAgB,EAAC,qBAAqB,EAAE,WAAW,EAAC,MAAM,UAAU,CAAC;AAErE,OAAO,EAAC,SAAS,EAAC,MAAM,WAAW,CAAC;AACpC,OAAO,EAAC,EAAE,EAAC,MAAM,iBAAiB,CAAC;AAEnC,OAAO,CAAC,MAAM,QAAQ,CAAC;AAcvB,OAAO,EAAC,SAAS,EAAC,MAAM,SAAS,CAAC;AAIlC;;;;GAIG;AACH,eAAO,MAAM,UAAU;;;sBAAqB,CAAC;AAE7C;;;;GAIG;AACH,eAAO,MAAM,aAAa,EAAE,CAAC,KAAK,EAAE,SAAS,KAAK,MAIjD,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,cAAc,EAAE,CAAC,KAAK,EAAE,SAAS,KAAK,MAEjD,CAAC;AAEH;;;;GAIG;AACH,eAAO,MAAM,aAAa,EAAE,CAAC,KAAK,EAAE,SAAS,KAAK,MAIjD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,QAAQ,cAA8B,MAAM,uCAKxD,CAAC;AAEF;;;;;;GAMG;AACH,wBAAsB,YAAY,CAChC,QAAQ,EAAE,MAAM,EAChB,GAAG,SAAgB,GAClB,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAM7B;AAED;;;;;;GAMG;AACH,eAAO,MAAM,mBAAmB,mEAI9B,CAAC;AAEH;;;;;;GAMG;AACH,eAAO,MAAM,aAAa,kFAAsD,CAAC;AAEjF;;;;;GAKG;AACH,iBAAe,YAAY,CACzB,GAAG,EAAE,MAAM,EACX,SAAS,EAAE,IAAI,GACd,OAAO,CAAC;IAAC,OAAO,EAAE,MAAM,CAAC;IAAC,GAAG,EAAE,qBAAqB,CAAA;CAAC,CAAC,CAAC;AAC1D,iBAAe,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;IAAC,OAAO,EAAE,MAAM,CAAC;IAAC,GAAG,EAAE,WAAW,CAAA;CAAC,CAAC,CAAC;AAsBvF;;GAEG;AACH,eAAO,MAAM,eAAe,0CAA0B,CAAC;AAEvD;;;;;GAKG;AACH,eAAO,MAAM,eAAe,qBAA+B,MAAM,8EAO/D,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,SAAS,mCACkB,MAAM,qCAE7C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,QAAQ,mCACmB,MAAM,qCAE7C,CAAC;AAEF;;;;;;;GAOG;AACH,wBAAgB,aAAa,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,SAAS,UAAQ,iBAMpF;AAED;;GAEG;AACH,eAAO,MAAM,WAAW,sCAAsB,CAAC;AAE/C;;GAEG;AACH,eAAO,MAAM,WAAW,4FAAsC,CAAC;AAE/D;;GAEG;AACH,eAAO,MAAM,QAAQ,4FAAmC,CAAC;AAEzD;;GAEG;AACH,eAAO,MAAM,WAAW,4FAAsC,CAAC;AAE/D;;GAEG;AACH,eAAO,MAAM,SAAS,4FAAoC,CAAC;AAE3D;;;;;;;GAOG;AACH,eAAO,MAAM,aAAa,cACP,MAAM,gBAAwB,QAAQ,SAAS,CAAC,sBAyBlE,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,UAAU,aAA6B,MAAM,KAAG,QAAQ,MAAM,EAAE,CAAC,sBAM5E,CAAC"}
+{"version":3,"file":"fs.d.ts","sourceRoot":"","sources":["../../lib/fs.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAgB,EAAC,qBAAqB,EAAE,WAAW,EAAC,MAAM,UAAU,CAAC;AAErE,OAAO,EAAC,SAAS,EAAC,MAAM,WAAW,CAAC;AACpC,OAAO,EAAC,EAAE,EAAC,MAAM,iBAAiB,CAAC;AAEnC,OAAO,CAAC,MAAM,QAAQ,CAAC;AAcvB,OAAO,EAAC,SAAS,EAAC,MAAM,SAAS,CAAC;AAIlC;;;;GAIG;AACH,eAAO,MAAM,UAAU;;;sBAAqB,CAAC;AAE7C;;;;GAIG;AACH,eAAO,MAAM,aAAa,EAAE,CAAC,KAAK,EAAE,SAAS,KAAK,MAIjD,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,cAAc,EAAE,CAAC,KAAK,EAAE,SAAS,KAAK,MAEjD,CAAC;AAEH;;;;GAIG;AACH,eAAO,MAAM,aAAa,EAAE,CAAC,KAAK,EAAE,SAAS,KAAK,MAIjD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,QAAQ,cAA8B,MAAM,uCAKxD,CAAC;AAEF;;;;;;GAMG;AACH,wBAAsB,YAAY,CAChC,QAAQ,EAAE,MAAM,EAChB,GAAG,SAAgB,GAClB,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAM7B;AAED;;;;;;GAMG;AACH,eAAO,MAAM,mBAAmB,mEAI9B,CAAC;AAEH;;;;;;GAMG;AACH,eAAO,MAAM,aAAa,kFAAsD,CAAC;AAEjF;;;;;GAKG;AACH,iBAAe,YAAY,CACzB,GAAG,EAAE,MAAM,EACX,SAAS,EAAE,IAAI,GACd,OAAO,CAAC;IAAC,OAAO,EAAE,MAAM,CAAC;IAAC,GAAG,EAAE,qBAAqB,CAAA;CAAC,CAAC,CAAC;AAC1D,iBAAe,YAAY,CACzB,GAAG,EAAE,MAAM,EACX,SAAS,CAAC,EAAE,KAAK,GAChB,OAAO,CAAC;IAAC,OAAO,EAAE,MAAM,CAAC;IAAC,GAAG,EAAE,WAAW,CAAA;CAAC,CAAC,CAAC;AAsBhD;;GAEG;AACH,eAAO,MAAM,eAAe,0CAA0B,CAAC;AAEvD;;;;;GAKG;AACH,eAAO,MAAM,eAAe,qBAA+B,MAAM,8EAO/D,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,SAAS,mCACkB,MAAM,qCAE7C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,QAAQ,mCACmB,MAAM,qCAE7C,CAAC;AAEF;;;;;;;GAOG;AACH,wBAAgB,aAAa,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,SAAS,UAAQ,iBAMpF;AAED;;GAEG;AACH,eAAO,MAAM,WAAW,sCAAsB,CAAC;AAE/C;;GAEG;AACH,eAAO,MAAM,WAAW,4FAAsC,CAAC;AAE/D;;GAEG;AACH,eAAO,MAAM,QAAQ,4FAAmC,CAAC;AAEzD;;GAEG;AACH,eAAO,MAAM,WAAW,4FAAsC,CAAC;AAE/D;;GAEG;AACH,eAAO,MAAM,SAAS,4FAAoC,CAAC;AAE3D;;;;;;;GAOG;AACH,eAAO,MAAM,aAAa,cACP,MAAM,gBAAwB,QAAQ,SAAS,CAAC,sBAyBlE,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,UAAU,aAA6B,MAAM,KAAG,QAAQ,MAAM,EAAE,CAAC,sBAM5E,CAAC"}

package/build/lib/fs.js

@@ -200,14 +200,14 @@ exports.whichMike = lodash_1.default.partial(exports.cachedWhich, constants_1.NA
  * @returns Parsed `mkdocs.yml` file
  */
 exports.readMkDocsYml = lodash_1.default.memoize(async (filepath, cwd = process.cwd()) => {
-    let mkDocsYml = await (0, exports.readYaml)(filepath);
+    let mkDocsYml = (await (0, exports.readYaml)(filepath));
     if (mkDocsYml.site_dir) {
         mkDocsYml.site_dir = node_path_1.default.resolve(cwd, node_path_1.default.dirname(filepath), mkDocsYml.site_dir);
     }
     if (mkDocsYml.INHERIT) {
         let inheritPath = node_path_1.default.resolve(node_path_1.default.dirname(filepath), mkDocsYml.INHERIT);
         while (inheritPath) {
-            const inheritYml = await (0, exports.readYaml)(inheritPath);
+            const inheritYml = (await (0, exports.readYaml)(inheritPath));
             if (inheritYml.site_dir) {
                 inheritYml.site_dir = node_path_1.default.resolve(node_path_1.default.dirname(inheritPath), inheritYml.site_dir);
                 log.debug('Resolved site_dir to %s', inheritYml.site_dir);

package/build/lib/fs.js.map

@@ -1 +1 @@
-{"version":3,"file":"fs.js","sourceRoot":"","sources":["../../lib/fs.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,sDAA6B;AAC7B,gDAAwB;AACxB,wDAAqE;AACrE,0DAA6B;AAE7B,6CAAmC;AACnC,6CAA+B;AAC/B,oDAAuB;AACvB,sDAA8B;AAC9B,sDAA8B;AAC9B,qCAAmD;AACnD,2CAQqB;AACrB,mCAAsC;AAGtC,MAAM,GAAG,GAAG,gBAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;AAEjC;;;;GAIG;AACU,QAAA,UAAU,GAAG,gBAAC,CAAC,OAAO,CAAC,iBAAO,CAAC,CAAC;AAE7C;;;;GAIG;AACU,QAAA,aAAa,GAAiC,gBAAC,CAAC,YAAY,CACvE,cAAI,CAAC,SAAS,EACd,EAAC,MAAM,EAAE,CAAC,EAAC,EACX,SAAS,CACV,CAAC;AAEF;;;;;GAKG;AACU,QAAA,cAAc,GAAiC,gBAAC,CAAC,YAAY,CAAC,KAAK,CAAC,SAAS,EAAE;IAC1F,MAAM,EAAE,CAAC;CACV,CAAC,CAAC;AAEH;;;;GAIG;AACU,QAAA,aAAa,GAAiC,gBAAC,CAAC,YAAY,CACvE,IAAI,CAAC,SAAS,EACd,CAAC,EACD,SAAS,CACV,CAAC;AAEF;;GAEG;AACU,QAAA,QAAQ,GAAG,gBAAC,CAAC,OAAO,CAAC,KAAK,EAAE,QAAgB,EAAE,EAAE,CAC3D,cAAI,CAAC,KAAK,CAAC,MAAM,YAAE,CAAC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,EAAE;IAC9C,YAAY,EAAE,KAAK;IACnB,QAAQ,EAAE,QAAQ;CACnB,CAAC,CACH,CAAC;AAEF;;;;;;GAMG;AACI,KAAK,UAAU,YAAY,CAChC,QAAgB,EAChB,GAAG,GAAG,OAAO,CAAC,GAAG,EAAE;IAEnB,MAAM,MAAM,GAAG,MAAM,IAAA,kBAAU,EAAC,GAAG,CAAC,CAAC;IACrC,IAAI,CAAC,MAAM,EAAE;QACX,OAAO;KACR;IACD,OAAO,mBAAI,CAAC,IAAI,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;AACrC,CAAC;AATD,oCASC;AAED;;;;;;GAMG;AACU,QAAA,mBAAmB,GAAG,gBAAC,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,GAAG,OAAO,CAAC,GAAG,EAAE,EAAE,EAAE;IACzE,MAAM,QAAQ,GAAG,MAAM,IAAA,iBAAM,EAAC,6BAAiB,EAAE,EAAC,GAAG,EAAE,IAAI,EAAE,MAAM,EAAC,CAAC,CAAC;IACtE,GAAG,CAAC,KAAK,CAAC,4BAA4B,EAAE,QAAQ,CAAC,CAAC;IAClD,OAAO,QAAQ,CAAC;AAClB,CAAC,CAAC,CAAC;AAEH;;;;;;GAMG;AACU,QAAA,aAAa,GAAG,gBAAC,CAAC,OAAO,CAAC,gBAAC,CAAC,OAAO,CAAC,YAAY,EAAE,2BAAe,CAAC,CAAC,CAAC;AAajF,KAAK,UAAU,YAAY,CACzB,GAAW,EACX,SAAmB;IAEnB,MAAM,MAAM,GAAG,MAAM,IAAA,kBAAU,EAAC,GAAG,CAAC,CAAC;IACrC,IAAI,CAAC,MAAM,EAAE;QACX,MAAM,IAAI,qBAAa,CACrB,oBAAoB,6BAAiB,SAAS,GAAG,8CAA8C,CAChG,CAAC;KACH;IACD,MAAM,OAAO,GAAG,mBAAI,CAAC,IAAI,CAAC,MAAM,EAAE,6BAAiB,CAAC,CAAC;IACrD,GAAG,CAAC,KAAK,CAAC,4BAA4B,EAAE,OAAO,CAAC,CAAC;IACjD,IAAI,SAAS,EAAE;QACb,MAAM,GAAG,GAAG,MAAM,IAAA,kBAAO,EAAC,EAAC,GAAG,EAAE,MAAM,EAAE,SAAS,EAAC,CAAC,CAAC;QACpD,OAAO,EAAC,GAAG,EAAE,OAAO,EAAC,CAAC;KACvB;SAAM;QACL,MAAM,GAAG,GAAG,MAAM,IAAA,kBAAO,EAAC,EAAC,GAAG,EAAE,MAAM,EAAC,CAAC,CAAC;QACzC,OAAO,EAAC,GAAG,EAAE,OAAO,EAAC,CAAC;KACvB;AACH,CAAC;AAED;;GAEG;AACU,QAAA,eAAe,GAAG,gBAAC,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;AAEvD;;;;;GAKG;AACU,QAAA,eAAe,GAAG,gBAAC,CAAC,OAAO,CAAC,CAAC,eAAuB,EAAE,EAAE;IACnE,MAAM,GAAG,GAAG,IAAI,qBAAW,EAAE,CAAC;IAC9B,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IACvC,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IACvC,GAAG,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,uBAAa,EAAE,CAAC,CAAC;IAC3C,GAAG,CAAC,SAAS,CAAC,EAAC,OAAO,EAAE,mBAAI,CAAC,OAAO,CAAC,eAAe,CAAC,EAAC,CAAC,CAAC;IACxD,OAAO,GAAG,CAAC,OAAO,CAAC,YAAY,EAAE,CAAC;AACpC,CAAC,CAAC,CAAC;AAEH;;GAEG;AACU,QAAA,SAAS,GAAG,gBAAC,CAAC,OAAO,CAChC,KAAK,EAAuB,QAAgB,EAAc,EAAE,CAC1D,KAAK,CAAC,KAAK,CAAC,MAAM,YAAE,CAAC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,CACnD,CAAC;AAEF;;GAEG;AACU,QAAA,QAAQ,GAAG,gBAAC,CAAC,OAAO,CAC/B,KAAK,EAAuB,QAAgB,EAAc,EAAE,CAC1D,IAAI,CAAC,KAAK,CAAC,MAAM,YAAE,CAAC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,CAClD,CAAC;AAEF;;;;;;;GAOG;AACH,SAAgB,aAAa,CAAC,QAAgB,EAAE,OAAkB,EAAE,SAAS,GAAG,KAAK;IACnF,MAAM,IAAI,GAAW,gBAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC;IAC3F,OAAO,YAAE,CAAC,SAAS,CAAC,QAAQ,EAAE,IAAI,EAAE;QAClC,QAAQ,EAAE,MAAM;QAChB,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI;KAC7B,CAAC,CAAC;AACL,CAAC;AAND,sCAMC;AAED;;GAEG;AACU,QAAA,WAAW,GAAG,gBAAC,CAAC,OAAO,CAAC,YAAE,CAAC,KAAK,CAAC,CAAC;AAE/C;;GAEG;AACU,QAAA,WAAW,GAAG,gBAAC,CAAC,OAAO,CAAC,mBAAW,EAAE,uBAAW,CAAC,CAAC;AAE/D;;GAEG;AACU,QAAA,QAAQ,GAAG,gBAAC,CAAC,OAAO,CAAC,mBAAW,EAAE,oBAAQ,CAAC,CAAC;AAEzD;;GAEG;AACU,QAAA,WAAW,GAAG,gBAAC,CAAC,OAAO,CAAC,mBAAW,EAAE,uBAAW,CAAC,CAAC;AAE/D;;GAEG;AACU,QAAA,SAAS,GAAG,gBAAC,CAAC,OAAO,CAAC,mBAAW,EAAE,qBAAS,CAAC,CAAC;AAE3D;;;;;;;GAOG;AACU,QAAA,aAAa,GAAG,gBAAC,CAAC,OAAO,CACpC,KAAK,EAAE,QAAgB,EAAE,GAAG,GAAG,OAAO,CAAC,GAAG,EAAE,EAAsB,EAAE;IAClE,IAAI,SAAS,GAAc,MAAM,IAAA,gBAAQ,EAAC,QAAQ,CAAC,CAAC;IACpD,IAAI,SAAS,CAAC,QAAQ,EAAE;QACtB,SAAS,CAAC,QAAQ,GAAG,mBAAI,CAAC,OAAO,CAAC,GAAG,EAAE,mBAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,SAAS,CAAC,QAAQ,CAAC,CAAC;KACpF;IACD,IAAI,SAAS,CAAC,OAAO,EAAE;QACrB,IAAI,WAAW,GAAuB,mBAAI,CAAC,OAAO,CAAC,mBAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,SAAS,CAAC,OAAO,CAAC,CAAC;QAC9F,OAAO,WAAW,EAAE;YAClB,MAAM,UAAU,GAAc,MAAM,IAAA,gBAAQ,EAAC,WAAW,CAAC,CAAC;YAC1D,IAAI,UAAU,CAAC,QAAQ,EAAE;gBACvB,UAAU,CAAC,QAAQ,GAAG,mBAAI,CAAC,OAAO,CAAC,mBAAI,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,UAAU,CAAC,QAAQ,CAAC,CAAC;gBACnF,GAAG,CAAC,KAAK,CAAC,yBAAyB,EAAE,UAAU,CAAC,QAAQ,CAAC,CAAC;aAC3D;YACD,IAAI,UAAU,CAAC,QAAQ,EAAE;gBACvB,UAAU,CAAC,QAAQ,GAAG,mBAAI,CAAC,OAAO,CAAC,mBAAI,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,UAAU,CAAC,QAAQ,CAAC,CAAC;gBACnF,GAAG,CAAC,KAAK,CAAC,yBAAyB,EAAE,UAAU,CAAC,QAAQ,CAAC,CAAC;aAC3D;YACD,SAAS,GAAG,gBAAC,CAAC,YAAY,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;YAClD,WAAW,GAAG,UAAU,CAAC,OAAO;gBAC9B,CAAC,CAAC,mBAAI,CAAC,OAAO,CAAC,mBAAI,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,UAAU,CAAC,OAAO,CAAC;gBAC7D,CAAC,CAAC,SAAS,CAAC;SACf;KACF;IACD,OAAO,SAAS,CAAC;AACnB,CAAC,CACF,CAAC;AAEF;;GAEG;AACU,QAAA,UAAU,GAAG,gBAAC,CAAC,OAAO,CAAC,KAAK,EAAE,OAAe,EAAqB,EAAE;IAC/E,IAAI,CAAC,mBAAI,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE;QAC7B,MAAM,IAAI,qBAAa,CAAC,gCAAgC,OAAO,GAAG,CAAC,CAAC;KACrE;IACD,MAAM,OAAO,GAAG,MAAM,YAAE,CAAC,OAAO,CAAC,OAAO,EAAE,EAAC,aAAa,EAAE,IAAI,EAAC,CAAC,CAAC;IACjE,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,mBAAI,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC;AAC/F,CAAC,CAAC,CAAC"}
+{"version":3,"file":"fs.js","sourceRoot":"","sources":["../../lib/fs.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,sDAA6B;AAC7B,gDAAwB;AACxB,wDAAqE;AACrE,0DAA6B;AAE7B,6CAAmC;AACnC,6CAA+B;AAC/B,oDAAuB;AACvB,sDAA8B;AAC9B,sDAA8B;AAC9B,qCAAmD;AACnD,2CAQqB;AACrB,mCAAsC;AAGtC,MAAM,GAAG,GAAG,gBAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;AAEjC;;;;GAIG;AACU,QAAA,UAAU,GAAG,gBAAC,CAAC,OAAO,CAAC,iBAAO,CAAC,CAAC;AAE7C;;;;GAIG;AACU,QAAA,aAAa,GAAiC,gBAAC,CAAC,YAAY,CACvE,cAAI,CAAC,SAAS,EACd,EAAC,MAAM,EAAE,CAAC,EAAC,EACX,SAAS,CACV,CAAC;AAEF;;;;;GAKG;AACU,QAAA,cAAc,GAAiC,gBAAC,CAAC,YAAY,CAAC,KAAK,CAAC,SAAS,EAAE;IAC1F,MAAM,EAAE,CAAC;CACV,CAAC,CAAC;AAEH;;;;GAIG;AACU,QAAA,aAAa,GAAiC,gBAAC,CAAC,YAAY,CACvE,IAAI,CAAC,SAAS,EACd,CAAC,EACD,SAAS,CACV,CAAC;AAEF;;GAEG;AACU,QAAA,QAAQ,GAAG,gBAAC,CAAC,OAAO,CAAC,KAAK,EAAE,QAAgB,EAAE,EAAE,CAC3D,cAAI,CAAC,KAAK,CAAC,MAAM,YAAE,CAAC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,EAAE;IAC9C,YAAY,EAAE,KAAK;IACnB,QAAQ,EAAE,QAAQ;CACnB,CAAC,CACH,CAAC;AAEF;;;;;;GAMG;AACI,KAAK,UAAU,YAAY,CAChC,QAAgB,EAChB,GAAG,GAAG,OAAO,CAAC,GAAG,EAAE;IAEnB,MAAM,MAAM,GAAG,MAAM,IAAA,kBAAU,EAAC,GAAG,CAAC,CAAC;IACrC,IAAI,CAAC,MAAM,EAAE;QACX,OAAO;KACR;IACD,OAAO,mBAAI,CAAC,IAAI,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;AACrC,CAAC;AATD,oCASC;AAED;;;;;;GAMG;AACU,QAAA,mBAAmB,GAAG,gBAAC,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,GAAG,OAAO,CAAC,GAAG,EAAE,EAAE,EAAE;IACzE,MAAM,QAAQ,GAAG,MAAM,IAAA,iBAAM,EAAC,6BAAiB,EAAE,EAAC,GAAG,EAAE,IAAI,EAAE,MAAM,EAAC,CAAC,CAAC;IACtE,GAAG,CAAC,KAAK,CAAC,4BAA4B,EAAE,QAAQ,CAAC,CAAC;IAClD,OAAO,QAAQ,CAAC;AAClB,CAAC,CAAC,CAAC;AAEH;;;;;;GAMG;AACU,QAAA,aAAa,GAAG,gBAAC,CAAC,OAAO,CAAC,gBAAC,CAAC,OAAO,CAAC,YAAY,EAAE,2BAAe,CAAC,CAAC,CAAC;AAgBjF,KAAK,UAAU,YAAY,CACzB,GAAW,EACX,SAAmB;IAEnB,MAAM,MAAM,GAAG,MAAM,IAAA,kBAAU,EAAC,GAAG,CAAC,CAAC;IACrC,IAAI,CAAC,MAAM,EAAE;QACX,MAAM,IAAI,qBAAa,CACrB,oBAAoB,6BAAiB,SAAS,GAAG,8CAA8C,CAChG,CAAC;KACH;IACD,MAAM,OAAO,GAAG,mBAAI,CAAC,IAAI,CAAC,MAAM,EAAE,6BAAiB,CAAC,CAAC;IACrD,GAAG,CAAC,KAAK,CAAC,4BAA4B,EAAE,OAAO,CAAC,CAAC;IACjD,IAAI,SAAS,EAAE;QACb,MAAM,GAAG,GAAG,MAAM,IAAA,kBAAO,EAAC,EAAC,GAAG,EAAE,MAAM,EAAE,SAAS,EAAC,CAAC,CAAC;QACpD,OAAO,EAAC,GAAG,EAAE,OAAO,EAAC,CAAC;KACvB;SAAM;QACL,MAAM,GAAG,GAAG,MAAM,IAAA,kBAAO,EAAC,EAAC,GAAG,EAAE,MAAM,EAAC,CAAC,CAAC;QACzC,OAAO,EAAC,GAAG,EAAE,OAAO,EAAC,CAAC;KACvB;AACH,CAAC;AAED;;GAEG;AACU,QAAA,eAAe,GAAG,gBAAC,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;AAEvD;;;;;GAKG;AACU,QAAA,eAAe,GAAG,gBAAC,CAAC,OAAO,CAAC,CAAC,eAAuB,EAAE,EAAE;IACnE,MAAM,GAAG,GAAG,IAAI,qBAAW,EAAE,CAAC;IAC9B,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IACvC,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IACvC,GAAG,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,uBAAa,EAAE,CAAC,CAAC;IAC3C,GAAG,CAAC,SAAS,CAAC,EAAC,OAAO,EAAE,mBAAI,CAAC,OAAO,CAAC,eAAe,CAAC,EAAC,CAAC,CAAC;IACxD,OAAO,GAAG,CAAC,OAAO,CAAC,YAAY,EAAE,CAAC;AACpC,CAAC,CAAC,CAAC;AAEH;;GAEG;AACU,QAAA,SAAS,GAAG,gBAAC,CAAC,OAAO,CAChC,KAAK,EAAuB,QAAgB,EAAc,EAAE,CAC1D,KAAK,CAAC,KAAK,CAAC,MAAM,YAAE,CAAC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,CACnD,CAAC;AAEF;;GAEG;AACU,QAAA,QAAQ,GAAG,gBAAC,CAAC,OAAO,CAC/B,KAAK,EAAuB,QAAgB,EAAc,EAAE,CAC1D,IAAI,CAAC,KAAK,CAAC,MAAM,YAAE,CAAC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,CAClD,CAAC;AAEF;;;;;;;GAOG;AACH,SAAgB,aAAa,CAAC,QAAgB,EAAE,OAAkB,EAAE,SAAS,GAAG,KAAK;IACnF,MAAM,IAAI,GAAW,gBAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC;IAC3F,OAAO,YAAE,CAAC,SAAS,CAAC,QAAQ,EAAE,IAAI,EAAE;QAClC,QAAQ,EAAE,MAAM;QAChB,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI;KAC7B,CAAC,CAAC;AACL,CAAC;AAND,sCAMC;AAED;;GAEG;AACU,QAAA,WAAW,GAAG,gBAAC,CAAC,OAAO,CAAC,YAAE,CAAC,KAAK,CAAC,CAAC;AAE/C;;GAEG;AACU,QAAA,WAAW,GAAG,gBAAC,CAAC,OAAO,CAAC,mBAAW,EAAE,uBAAW,CAAC,CAAC;AAE/D;;GAEG;AACU,QAAA,QAAQ,GAAG,gBAAC,CAAC,OAAO,CAAC,mBAAW,EAAE,oBAAQ,CAAC,CAAC;AAEzD;;GAEG;AACU,QAAA,WAAW,GAAG,gBAAC,CAAC,OAAO,CAAC,mBAAW,EAAE,uBAAW,CAAC,CAAC;AAE/D;;GAEG;AACU,QAAA,SAAS,GAAG,gBAAC,CAAC,OAAO,CAAC,mBAAW,EAAE,qBAAS,CAAC,CAAC;AAE3D;;;;;;;GAOG;AACU,QAAA,aAAa,GAAG,gBAAC,CAAC,OAAO,CACpC,KAAK,EAAE,QAAgB,EAAE,GAAG,GAAG,OAAO,CAAC,GAAG,EAAE,EAAsB,EAAE;IAClE,IAAI,SAAS,GAAG,CAAC,MAAM,IAAA,gBAAQ,EAAC,QAAQ,CAAC,CAAc,CAAC;IACxD,IAAI,SAAS,CAAC,QAAQ,EAAE;QACtB,SAAS,CAAC,QAAQ,GAAG,mBAAI,CAAC,OAAO,CAAC,GAAG,EAAE,mBAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,SAAS,CAAC,QAAQ,CAAC,CAAC;KACpF;IACD,IAAI,SAAS,CAAC,OAAO,EAAE;QACrB,IAAI,WAAW,GAAuB,mBAAI,CAAC,OAAO,CAAC,mBAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,SAAS,CAAC,OAAO,CAAC,CAAC;QAC9F,OAAO,WAAW,EAAE;YAClB,MAAM,UAAU,GAAG,CAAC,MAAM,IAAA,gBAAQ,EAAC,WAAW,CAAC,CAAc,CAAC;YAC9D,IAAI,UAAU,CAAC,QAAQ,EAAE;gBACvB,UAAU,CAAC,QAAQ,GAAG,mBAAI,CAAC,OAAO,CAAC,mBAAI,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,UAAU,CAAC,QAAQ,CAAC,CAAC;gBACnF,GAAG,CAAC,KAAK,CAAC,yBAAyB,EAAE,UAAU,CAAC,QAAQ,CAAC,CAAC;aAC3D;YACD,IAAI,UAAU,CAAC,QAAQ,EAAE;gBACvB,UAAU,CAAC,QAAQ,GAAG,mBAAI,CAAC,OAAO,CAAC,mBAAI,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,UAAU,CAAC,QAAQ,CAAC,CAAC;gBACnF,GAAG,CAAC,KAAK,CAAC,yBAAyB,EAAE,UAAU,CAAC,QAAQ,CAAC,CAAC;aAC3D;YACD,SAAS,GAAG,gBAAC,CAAC,YAAY,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;YAClD,WAAW,GAAG,UAAU,CAAC,OAAO;gBAC9B,CAAC,CAAC,mBAAI,CAAC,OAAO,CAAC,mBAAI,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,UAAU,CAAC,OAAO,CAAC;gBAC7D,CAAC,CAAC,SAAS,CAAC;SACf;KACF;IACD,OAAO,SAAS,CAAC;AACnB,CAAC,CACF,CAAC;AAEF;;GAEG;AACU,QAAA,UAAU,GAAG,gBAAC,CAAC,OAAO,CAAC,KAAK,EAAE,OAAe,EAAqB,EAAE;IAC/E,IAAI,CAAC,mBAAI,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE;QAC7B,MAAM,IAAI,qBAAa,CAAC,gCAAgC,OAAO,GAAG,CAAC,CAAC;KACrE;IACD,MAAM,OAAO,GAAG,MAAM,YAAE,CAAC,OAAO,CAAC,OAAO,EAAE,EAAC,aAAa,EAAE,IAAI,EAAC,CAAC,CAAC;IACjE,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,mBAAI,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC;AAC/F,CAAC,CAAC,CAAC"}

package/build/lib/index.d.ts

@@ -1,3 +1,7 @@
+/**
+ * Main entry point
+ * @module
+ */
 export * from './mike';
 export * from './builder';
 export * from './validate';

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../lib/index.ts"],"names":[],"mappings":"AAAA,cAAc,QAAQ,CAAC;AACvB,cAAc,WAAW,CAAC;AAC1B,cAAc,YAAY,CAAC;AAC3B,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../lib/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,cAAc,QAAQ,CAAC;AACvB,cAAc,WAAW,CAAC;AAC1B,cAAc,YAAY,CAAC;AAC3B,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC"}

package/build/lib/index.js

@@ -1,4 +1,8 @@
 "use strict";
+/**
+ * Main entry point
+ * @module
+ */
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     var desc = Object.getOwnPropertyDescriptor(m, k);

package/build/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../lib/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,yCAAuB;AACvB,4CAA0B;AAC1B,6CAA2B;AAC3B,6CAA2B;AAC3B,8CAA4B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../lib/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;;;;;;;;;;;AAEH,yCAAuB;AACvB,4CAA0B;AAC1B,6CAA2B;AAC3B,6CAA2B;AAC3B,8CAA4B"}

package/build/lib/init.d.ts

@@ -13,7 +13,7 @@ export declare const initTsConfigJson: import("./scaffold").ScaffoldTask<InitTsC
 /**
  * Function which scaffolds a `typedoc.json` file
  */
-export declare const initTypeDocJson: import("./scaffold").ScaffoldTask<InitTypeDocOptions, import("type-fest/source/jsonify").JsonifyObject<{
+export declare const initTypeDocJson: import("./scaffold").ScaffoldTask<ScaffoldTaskOptions, import("type-fest/source/jsonify").JsonifyObject<{
     $schema?: string | undefined;
     includes?: string | undefined;
     options?: string | undefined;
@@ -119,7 +119,7 @@ export declare const initMkDocs: import("./scaffold").ScaffoldTask<InitMkDocsOpt
  * Installs Python dependencies
  * @param opts Options
  */
-export declare function initPython({ pythonPath, dryRun, }?: InitPythonOptions): Promise<void>;
+export declare function initPython({ pythonPath, dryRun, upgrade, }?: InitPythonOptions): Promise<void>;
 /**
  * Options for {@linkcode initMkDocs}
  */
@@ -136,9 +136,8 @@ export interface InitMkDocsOptions extends ScaffoldTaskOptions {
  * This runs tasks in serial; it _could_ run in parallel, but it has deleterious effects upon
  * console output which would need mitigation.
  */
-export declare function init({ typescript, typedoc, python, tsconfigJson: tsconfigJsonPath, packageJson: packageJsonPath, overwrite, include, mkdocs, mkdocsYml: mkdocsYmlPath, siteName, repoName, repoUrl, copyright, dryRun, cwd, pythonPath, typedocJson: typeDocJsonPath, }?: InitOptions): Promise<void>;
-export interface InitTypeDocOptions extends ScaffoldTaskOptions {
-}
+export declare function init({ typescript, typedoc, python, tsconfigJson: tsconfigJsonPath, packageJson: packageJsonPath, overwrite, include, mkdocs, mkdocsYml: mkdocsYmlPath, siteName, repoName, repoUrl, copyright, dryRun, cwd, pythonPath, upgrade, typedocJson: typeDocJsonPath, }?: InitOptions): Promise<void>;
+export type InitTypeDocOptions = ScaffoldTaskOptions;
 export interface InitTsConfigOptions extends ScaffoldTaskOptions {
     /**
      * List of source files (globs supported); typically `src` or `lib`
@@ -150,6 +149,10 @@ export interface InitPythonOptions extends ScaffoldTaskOptions {
      * Path to `python` (v3.x) executable
      */
     pythonPath?: string;
+    /**
+     * If true, upgrade only
+     */
+    upgrade?: boolean;
 }
 /**
  * Options for `init` command handler
@@ -189,5 +192,9 @@ export type InitOptions = Simplify<Omit<InitPythonOptions & InitTsConfigOptions
      * Path to new or existing `mkdocs.yml` file
      */
     mkdocsYml?: string;
+    /**
+     * If `true`, upgrade only
+     */
+    upgrade?: boolean;
 }>;
 //# sourceMappingURL=init.d.ts.map