@appium/docutils 2.3.0 → 2.4.0

package/lib/validate.ts

@@ -41,6 +41,29 @@ const log = getLogger('validate');
  */
 export type ValidationKind = typeof NAME_PYTHON | typeof NAME_MKDOCS;
 
+export interface DocutilsValidatorOpts {
+  /**
+   * Current working directory
+   */
+  cwd?: string;
+  /**
+   * Path to `mkdocs.yml`
+   */
+  mkdocsYml?: string;
+  /**
+   * If `true`, run Python validation
+   */
+  python?: boolean;
+  /**
+   * Path to `python` executable
+   */
+  pythonPath?: string;
+  /**
+   * If `true`, run MkDocs validation
+   */
+  mkdocs?: boolean;
+}
+
 /**
  * This class is designed to run _all_ validation checks (as requested by the user), and emit events for
  * each failure encountered.
@@ -51,6 +74,30 @@ export type ValidationKind = typeof NAME_PYTHON | typeof NAME_MKDOCS;
  * @todo Use [`strict-event-emitter-types`](https://npm.im/strict-event-emitter-types)
  */
 export class DocutilsValidator extends EventEmitter {
+  /**
+   * Emitted when validation begins with a list of validation kinds to be performed
+   * @event
+   */
+  public static readonly BEGIN = 'begin';
+
+  /**
+   * Emitted when validation ends with an error count
+   * @event
+   */
+  public static readonly END = 'end';
+
+  /**
+   * Emitted when a validation fails, with the associated {@linkcode DocutilsError}
+   * @event
+   */
+  public static readonly FAILURE = 'fail';
+
+  /**
+   * Emitted when a validation succeeds
+   * @event
+   */
+  public static readonly SUCCESS = 'ok';
+
   /**
    * Current working directory. Defaults to `process.cwd()`
    * @todo This cannot yet be overridden by user
@@ -82,30 +129,6 @@ export class DocutilsValidator extends EventEmitter {
    */
   protected mkDocsYmlPath?: string;
 
-  /**
-   * Emitted when validation begins with a list of validation kinds to be performed
-   * @event
-   */
-  public static readonly BEGIN = 'begin';
-
-  /**
-   * Emitted when validation ends with an error count
-   * @event
-   */
-  public static readonly END = 'end';
-
-  /**
-   * Emitted when a validation fails, with the associated {@linkcode DocutilsError}
-   * @event
-   */
-  public static readonly FAILURE = 'fail';
-
-  /**
-   * Emitted when a validation succeeds
-   * @event
-   */
-  public static readonly SUCCESS = 'ok';
-
   private requirementsTxt: PipPackage[] | undefined;
 
   /**
@@ -197,8 +220,11 @@ export class DocutilsValidator extends EventEmitter {
         requiredPackages.push({name, version});
       }
       log.debug('Parsed %s: %O', NAME_REQUIREMENTS_TXT, requiredPackages);
-    } catch {
-      throw new DocutilsError(`Could not find ${REQUIREMENTS_TXT_PATH}. This is a bug`);
+    } catch (e) {
+      throw new DocutilsError(
+        `Could not find ${REQUIREMENTS_TXT_PATH}. This is a bug`,
+        {cause: e}
+      );
     }
 
     return (this.requirementsTxt = requiredPackages);
@@ -392,30 +418,3 @@ export class DocutilsValidator extends EventEmitter {
     this.ok('Python version OK');
   }
 }
-
-/**
- * Options for {@linkcode DocutilsValidator} constructor
- */
-
-export interface DocutilsValidatorOpts {
-  /**
-   * Current working directory
-   */
-  cwd?: string;
-  /**
-   * Path to `mkdocs.yml`
-   */
-  mkdocsYml?: string;
-  /**
-   * If `true`, run Python validation
-   */
-  python?: boolean;
-  /**
-   * Path to `python` executable
-   */
-  pythonPath?: string;
-  /**
-   * If `true`, run MkDocs validation
-   */
-  mkdocs?: boolean;
-}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appium/docutils",
-  "version": "2.3.0",
+  "version": "2.4.0",
   "description": "Documentation generation utilities for Appium and related projects",
   "keywords": [
     "automation",
@@ -46,16 +46,16 @@
     "start": "node ./build/lib/cli/index.js"
   },
   "dependencies": {
-    "@appium/support": "7.1.0",
+    "@appium/support": "7.2.0",
     "consola": "3.4.2",
-    "diff": "8.0.4",
+    "diff": "9.0.0",
     "lilconfig": "3.1.3",
     "lodash": "4.18.1",
     "package-directory": "8.2.0",
     "read-pkg": "10.1.0",
-    "teen_process": "4.1.0",
-    "type-fest": "5.5.0",
-    "yaml": "2.8.3",
+    "teen_process": "4.1.3",
+    "type-fest": "5.6.0",
+    "yaml": "2.8.4",
     "yargs": "18.0.0",
     "yargs-parser": "22.0.0"
   },
@@ -66,5 +66,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "7a8965f5c30ffec2ad04ce75903b3960537cef06"
+  "gitHead": "915d767085c6b40ae90b7592d5130c76414ca3b5"
 }

package/requirements.txt

@@ -2,4 +2,4 @@ mkdocs==1.6.1
 mkdocs-git-revision-date-localized-plugin==1.5.1
 mkdocs-material==9.7.6
 mkdocs-redirects==1.2.3
-mike==2.1.4
+mike==2.2.0