@appium/docutils 2.4.1 → 2.4.3

package/lib/util.ts

@@ -1,21 +1,21 @@
-/**
- * Utilities
- * @module
- */
-
-import _ from 'lodash';
 import type {SpawnOptions} from 'node:child_process';
 import {spawn} from 'node:child_process';
 import path from 'node:path';
 import type {ExecError, TeenProcessExecOptions} from 'teen_process';
 import {exec} from 'teen_process';
+import {util as supportUtil} from '@appium/support';
 
 /**
  * Computes a relative path, prepending `./`
  */
-export const relative = _.curry(
-  (from: string, to: string): string => `.${path.sep}${path.relative(from, to)}`
-);
+export function relative(from: string): (to: string) => string;
+export function relative(from: string, to: string): string;
+export function relative(from: string, to?: string): string | ((to: string) => string) {
+  if (to === undefined) {
+    return (nextTo: string) => `.${path.sep}${path.relative(from, nextTo)}`;
+  }
+  return `.${path.sep}${path.relative(from, to)}`;
+}
 
 /**
  * A stopwatch-like thing
@@ -48,9 +48,8 @@ export type TupleToObject<
  * @param value any value
  * @returns `true` if the array is `string[]`
  */
-export const isStringArray = _.overEvery(_.isArray, _.partial(_.every, _, _.isString)) as (
-  value: any
-) => value is string[];
+export const isStringArray = (value: any): value is string[] =>
+  Array.isArray(value) && value.every((item) => typeof item === 'string');
 
 /**
  * Converts an object of string values to an array of arguments for CLI
@@ -58,23 +57,67 @@ export const isStringArray = _.overEvery(_.isArray, _.partial(_.every, _, _.isSt
  * Supports `boolean` and `number` values as well.  `boolean`s are assumed to be flags which default
  * to `false`, so they will only be added to the array if the value is `true`.
  */
-export const argify: (obj: Record<string, string | number | boolean | undefined>) => string[] =
-  _.flow(
-    _.entries,
-    (list) =>
-      list.map(([key, value]) => {
-        if (value === true) {
-          return [`--${key}`];
-        } else if (value === false || value === undefined) {
-          return;
-        }
-        return [`--${key}`, value];
-      }),
-    _.flatten
-  );
+export const argify = (obj: Record<string, string | number | boolean | undefined>): string[] => {
+  const args: string[] = [];
+  for (const [key, value] of Object.entries(obj)) {
+    if (value === true) {
+      args.push(`--${key}`);
+    } else if (value === false || value === undefined) {
+      continue;
+    } else {
+      args.push(`--${key}`, String(value));
+    }
+  }
+  return args;
+};
 
 export type SpawnBackgroundProcessOpts = Omit<SpawnOptions, 'stdio'>;
 
+/**
+ * Converts a string to kebab-case.
+ * @param value Input string
+ * @returns Kebab-cased string
+ */
+export function kebabCase(value: string): string {
+  return value
+    .replace(/([a-z0-9])([A-Z])/g, '$1-$2')
+    .replace(/[_\s]+/g, '-')
+    .toLowerCase();
+}
+
+/**
+ * Performs a deep "defaults" merge into a clone of `target`.
+ * Only undefined properties in `target` are filled from `defaults`.
+ * @param target Destination object
+ * @param defaults Default values object
+ * @returns Merged clone
+ */
+export function mergeDefaultsDeep<T extends Record<string, any>>(target: T, defaults: T): T {
+  const out = structuredClone(target);
+  const stack: Array<{dest: Record<string, any>; src: Record<string, any>}> = [
+    {dest: out, src: defaults},
+  ];
+
+  while (stack.length) {
+    const next = stack.pop();
+    if (!next) {
+      continue;
+    }
+    const {dest, src} = next;
+    for (const [key, srcVal] of Object.entries(src)) {
+      const destVal = dest[key];
+      if (destVal === undefined) {
+        dest[key] = structuredClone(srcVal);
+        continue;
+      }
+      if (supportUtil.isPlainObject(destVal) && supportUtil.isPlainObject(srcVal)) {
+        stack.push({dest: destVal, src: srcVal});
+      }
+    }
+  }
+  return out as T;
+}
+
 /**
  * Spawns a long-running "background" child process.  This is expected to only return control to the
  * parent process in the case of a nonzero exit code from the child process.

package/lib/validate.ts

@@ -5,7 +5,6 @@
  */
 
 import {fs, util} from '@appium/support';
-import _ from 'lodash';
 import {EventEmitter} from 'node:events';
 import {exec} from 'teen_process';
 import {
@@ -184,7 +183,7 @@ export class DocutilsValidator extends EventEmitter {
    * @returns
    */
   protected fail(err: DocutilsError | string) {
-    const dErr = _.isString(err) ? new DocutilsError(err) : err;
+    const dErr = typeof err === 'string' ? new DocutilsError(err) : err;
     if (!this.emittedErrors.has(dErr.message)) {
       this.emit(DocutilsValidator.FAILURE, dErr);
     }
@@ -265,7 +264,7 @@ export class DocutilsValidator extends EventEmitter {
     }
     const version = match[1];
     const reqs = await this.parseRequirementsTxt();
-    const mkDocsPipPkg = _.find(reqs, {name: NAME_MKDOCS});
+    const mkDocsPipPkg = reqs.find((pkg) => pkg.name === NAME_MKDOCS);
     if (!mkDocsPipPkg) {
       throw new DocutilsError(
         `No ${NAME_MKDOCS} package in ${REQUIREMENTS_TXT_PATH}. This is a bug`,
@@ -350,7 +349,7 @@ export class DocutilsValidator extends EventEmitter {
       return this.fail(`Could not parse output of "${NAME_PIP} list" as JSON: ${pipListOutput}`);
     }
 
-    const pkgsByName = _.mapValues(_.keyBy(installedPkgs, 'name'), 'version');
+    const pkgsByName = Object.fromEntries(installedPkgs.map((pkg) => [pkg.name, pkg.version]));
     log.debug('Installed Python packages: %O', pkgsByName);
 
     const requiredPackages = await this.parseRequirementsTxt();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appium/docutils",
-  "version": "2.4.1",
+  "version": "2.4.3",
   "description": "Documentation generation utilities for Appium and related projects",
   "keywords": [
     "automation",
@@ -46,16 +46,15 @@
     "start": "node ./build/lib/cli/index.js"
   },
   "dependencies": {
-    "@appium/support": "7.2.1",
+    "@appium/support": "7.2.3",
     "consola": "3.4.2",
     "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.3",
     "type-fest": "5.6.0",
-    "yaml": "2.8.4",
+    "yaml": "2.9.0",
     "yargs": "18.0.0",
     "yargs-parser": "22.0.0"
   },
@@ -66,5 +65,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "fd6dbe9eff4b52bd5436811ae71b0425c0ebfff4"
+  "gitHead": "8018f8b70ecc975fa115e19072ef337b8473865d"
 }

package/requirements.txt

@@ -1,5 +1,5 @@
 mkdocs==1.6.1
-mkdocs-git-revision-date-localized-plugin==1.5.1
+mkdocs-git-revision-date-localized-plugin==1.5.2
 mkdocs-material==9.7.6
 mkdocs-redirects==1.2.3
 mike==2.2.0