hereby 1.6.4 → 1.7.1

package/README.md

@@ -108,7 +108,7 @@ well.
 `hereby` does not support running tasks in series; specifying multiple tasks at
 the CLI or as dependencies of another task will run them in parallel. This
 matches the behavior of tools like `make`, which like `hereby` intend to encode
-a dedpendency graph of tasks, not act as a script.
+a dependency graph of tasks, not act as a script.
 
 In general, if you're trying to emulate a serial task, you will likely be better
 served by writing out explicit dependencies for your tasks.

package/dist/cli/formatTasks.js

@@ -2,8 +2,7 @@ import commandLineUsage from "command-line-usage";
 import pc from "picocolors";
 import { stringSorter, taskSorter } from "./utils.js";
 export function formatTasks(format, tasks, defaultTask) {
-    tasks = tasks
-        .slice(0)
+    tasks = [...tasks]
         .filter((task) => !task.options.hiddenFromTaskList)
         .sort(taskSorter);
     if (format === "simple") {
@@ -14,9 +13,9 @@ export function formatTasks(format, tasks, defaultTask) {
         header: "Available tasks",
         content: tasks.map((task) => {
             var _a;
-            const name = task !== defaultTask
-                ? pc.blue(task.options.name)
-                : `${pc.green(task.options.name)} (default)`;
+            const name = task === defaultTask
+                ? `${pc.green(task.options.name)} (default)`
+                : pc.blue(task.options.name);
             const descriptionParts = [];
             if (task.options.description) {
                 descriptionParts.push(task.options.description);

package/dist/cli/index.js

@@ -1,4 +1,4 @@
-import path from "path";
+import path from "node:path";
 import pc from "picocolors";
 import { formatTasks } from "./formatTasks.js";
 import { findHerebyfile, loadHerebyfile } from "./loadHerebyfile.js";
@@ -79,7 +79,7 @@ export async function selectTasks(d, herebyfile, herebyfilePath, taskNames) {
             if (!task) {
                 let message = `Task "${name}" does not exist or is not exported from ${d.simplifyPath(herebyfilePath)}.`;
                 const { closest, distance } = await import("fastest-levenshtein");
-                const candidate = closest(name, Array.from(allTasks.keys()));
+                const candidate = closest(name, [...allTasks.keys()]);
                 if (distance(name, candidate) < name.length * 0.4) {
                     message += ` Did you mean "${candidate}"?`;
                 }

package/dist/cli/loadHerebyfile.js

@@ -1,12 +1,12 @@
-import fs from "fs";
-import path from "path";
+import fs from "node:fs";
+import path from "node:path";
+import { pathToFileURL } from "node:url";
 import pc from "picocolors";
-import { pathToFileURL } from "url";
 import { Task } from "../index.js";
 import { UserError } from "./utils.js";
 const filenames = ["Herebyfile", "herebyfile"];
 const extensions = ["mjs", "js"];
-const allFilenames = new Set(extensions.map((e) => filenames.map((f) => `${f}.${e}`)).flat());
+const allFilenames = new Set(extensions.flatMap((e) => filenames.map((f) => `${f}.${e}`)));
 export async function findHerebyfile(dir) {
     const root = path.parse(dir).root;
     for (; dir !== root; dir = path.dirname(dir)) {
@@ -52,7 +52,7 @@ export async function loadHerebyfile(herebyfilePath) {
     if (exportedTasks.size === 0) {
         throw new UserError("No tasks found. Did you forget to export your tasks?");
     }
-    const tasks = Array.from(exportedTasks.values());
+    const tasks = [...exportedTasks.values()];
     // We check this here by walking the DAG, as some dependencies may not be
     // exported and therefore would not be seen by the above loop.
     checkTaskInvariants(tasks);

package/dist/cli/parseArgs.js

@@ -20,7 +20,7 @@ export function parseArgs(argv) {
         help: options["help"],
         run: options["run"],
         herebyfile: options["herebyfile"],
-        printTasks: options["tasks"] ? "normal" : options["tasks-simple"] ? "simple" : undefined,
+        printTasks: options["tasks"] ? "normal" : (options["tasks-simple"] ? "simple" : undefined),
         version: options["version"],
     };
 }

package/dist/cli/reexec.js

@@ -1,17 +1,20 @@
-import { fileURLToPath, pathToFileURL } from "url";
+import { pathToFileURL } from "node:url";
 import { UserError } from "./utils.js";
+const cliExportName = "hereby/cli";
+/**
+ * Checks to see if we need to re-exec another version of hereby.
+ * If this function returns true, the caller should return immediately
+ * and do no further work.
+ */
 export async function reexec(d, herebyfilePath) {
     // If hereby is installed globally, but run against a Herebyfile in some
     // other package, that Herebyfile's import will resolve to a different
     // installation of the hereby package. There's no guarantee that the two
-    // are compatible (in fact, are guaranteed not to be as Task is a class).
+    // are compatible (in fact, they are guaranteed not to as Task is a class).
     //
     // Rather than trying to fix this by messing around with Node's resolution
     // (which won't work in ESM anyway), instead opt to figure out the location
-    // of hereby as imported by the Herebyfile, and fork to execute it instead.
-    //
-    // TODO: Rather than spawning a child process, perhaps we could instead
-    // import the CLI from the other version and run it.
+    // of hereby as imported by the Herebyfile, and then "reexec" it by importing.
     if (d.isPnP) {
         // When we are running within PnP, we can't really figure out what to
         // do. import-meta-resolve doesn't implement this, so we can't do
@@ -21,10 +24,10 @@ export async function reexec(d, herebyfilePath) {
         // a mismatch.
         return false;
     }
-    const thisCLI = await resolveToPath("hereby/cli", new URL(import.meta.url));
+    const thisCLI = await d.resolve(cliExportName, import.meta.url);
     let otherCLI;
     try {
-        otherCLI = await resolveToPath("hereby/cli", pathToFileURL(herebyfilePath));
+        otherCLI = await d.resolve(cliExportName, pathToFileURL(herebyfilePath).toString());
     }
     catch {
         throw new UserError("Unable to find hereby; ensure hereby is installed in your package.");
@@ -32,11 +35,7 @@ export async function reexec(d, herebyfilePath) {
     if (thisCLI === otherCLI) {
         return false;
     }
-    const args = [...d.execArgv, otherCLI, ...d.argv.slice(2)];
-    await d.foregroundChild(d.execPath, args);
+    await import(otherCLI);
     return true;
-    async function resolveToPath(specifier, url) {
-        return fileURLToPath(new URL(await d.resolve(specifier, url.toString())));
-    }
 }
 //# sourceMappingURL=reexec.js.map

package/dist/cli/runner.js

@@ -1,4 +1,4 @@
-import assert from "assert";
+import assert from "node:assert";
 import pc from "picocolors";
 export class Runner {
     constructor(d) {

package/dist/cli/utils.js

@@ -1,7 +1,7 @@
-import fs from "fs";
-import os from "os";
-import path from "path";
-import { fileURLToPath } from "url";
+import fs from "node:fs";
+import os from "node:os";
+import path from "node:path";
+import { fileURLToPath } from "node:url";
 export function taskSorter(a, b) {
     return stringSorter(a.options.name, b.options.name);
 }
@@ -52,8 +52,6 @@ export async function real() {
         chdir: process.chdir,
         simplifyPath,
         argv: process.argv,
-        execArgv: process.execArgv,
-        execPath: process.execPath,
         setExitCode: (code) => {
             process.exitCode = code;
         },
@@ -61,16 +59,11 @@ export async function real() {
             // Not bothering to memoize this function; it will only be called once.
             const resolve = await importResolve();
             const packageJsonPath = fileURLToPath(await resolve("hereby/package.json", import.meta.url));
-            const packageJson = await fs.promises.readFile(packageJsonPath, "utf-8");
+            const packageJson = await fs.promises.readFile(packageJsonPath, "utf8");
             const { version } = JSON.parse(packageJson);
             return version;
         },
         isPnP: !!process.versions["pnp"],
-        foregroundChild: async (program, args) => {
-            // Not bothering to memoize this import; it will only be called once.
-            const { default: foregroundChild } = await import("foreground-child");
-            foregroundChild(program, args);
-        },
         resolve: async (specifier, parent) => {
             const resolve = await importResolve();
             return resolve(specifier, parent);

package/dist/index.d.ts

@@ -11,7 +11,7 @@ export interface TaskOptions {
      */
     description?: string | undefined;
     /**
-     * A list of tasks that must has been run to completion before
+     * A list of tasks that must have been run to completion before
      * this task can execute.
      */
     dependencies?: readonly Task[] | undefined;

package/dist/index.js

@@ -2,28 +2,36 @@
  * A hereby Task. To get an instance, call `test`.
  */
 export class Task {
+    /* @internal */
+    get options() {
+        return this._options;
+    }
+    /* @internal */
+    static create(options) {
+        return new Task(options);
+    }
     constructor(options) {
         // Runtime typecheck; consumers of hereby may not have enabled
         // typechecking, so this is helpful.
         var _a;
         if (typeof options.name !== "string") {
-            throw new Error("Task name is not a string.");
+            throw new TypeError("Task name is not a string.");
         }
-        if (typeof options.description !== "string" && typeof options.description !== "undefined") {
-            throw new Error("Task description is not a string or undefined.");
+        if (typeof options.description !== "string" && options.description !== undefined) {
+            throw new TypeError("Task description is not a string or undefined.");
         }
-        if (!Array.isArray(options.dependencies) && typeof options.dependencies !== "undefined") {
-            throw new Error("Task dependencies is not an array or undefined.");
+        if (!Array.isArray(options.dependencies) && options.dependencies !== undefined) {
+            throw new TypeError("Task dependencies is not an array or undefined.");
         }
         if (options.dependencies) {
             for (const dep of options.dependencies) {
                 if (!(dep instanceof Task)) {
-                    throw new Error("Task dependency is not a task.");
+                    throw new TypeError("Task dependency is not a task.");
                 }
             }
         }
-        if (typeof options.run !== "function" && typeof options.run !== "undefined") {
-            throw new Error("Task run is not a function or undefined.");
+        if (typeof options.run !== "function" && options.run !== undefined) {
+            throw new TypeError("Task run is not a function or undefined.");
         }
         // Non-type checks.
         if (!options.name) {
@@ -37,14 +45,6 @@ export class Task {
         }
         this._options = options;
     }
-    /* @internal */
-    get options() {
-        return this._options;
-    }
-    /* @internal */
-    static create(options) {
-        return new Task(options);
-    }
 }
 /**
  * Creates a new Task.

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "hereby",
-    "version": "1.6.4",
+    "version": "1.7.1",
     "description": "A simple task runner",
     "repository": "github:jakebailey/hereby",
     "type": "module",
@@ -41,8 +41,7 @@
         "command-line-args": "^5.2.1",
         "command-line-usage": "^6.1.3",
         "fastest-levenshtein": "^1.0.16",
-        "foreground-child": "^2.0.0",
-        "import-meta-resolve": "^2.1.0",
+        "import-meta-resolve": "^2.2.1",
         "picocolors": "^1.0.0",
         "pretty-ms": "^8.0.0"
     },
@@ -51,23 +50,27 @@
         "@tsconfig/node12": "^1.0.11",
         "@types/command-line-args": "^5.2.0",
         "@types/command-line-usage": "^5.0.2",
-        "@types/foreground-child": "^2.0.0",
-        "@types/node": "^14.18.32",
+        "@types/node": "^14.18.36",
         "@types/tmp": "^0.2.3",
-        "@typescript-eslint/eslint-plugin": "^5.40.1",
-        "@typescript-eslint/parser": "^5.40.1",
-        "ava": "^5.0.1",
+        "@typescript-eslint/eslint-plugin": "^5.48.2",
+        "@typescript-eslint/parser": "^5.48.2",
+        "ava": "~5.0.1",
         "c8": "^7.12.0",
-        "dprint": "^0.32.2",
-        "eslint": "^8.26.0",
-        "eslint-plugin-ava": "^13.2.0",
-        "eslint-plugin-simple-import-sort": "^8.0.0",
+        "dprint": "^0.34.4",
+        "eslint": "^8.32.0",
+        "eslint-plugin-ava": "^14.0.0",
+        "eslint-plugin-simple-import-sort": "^9.0.0",
+        "eslint-plugin-unicorn": "^45.0.2",
         "execa": "^6.1.0",
         "moq.ts": "^9.0.2",
-        "release-it": "^15.5.0",
-        "rimraf": "^3.0.2",
+        "rimraf": "^4.1.1",
         "tmp": "^0.2.1",
-        "typescript": "~4.8.4"
+        "typescript": "~4.9.4"
+    },
+    "overrides": {
+        "ava": {
+            "emittery": "1.0.0"
+        }
     },
     "packageManager": "npm@8.17.0",
     "volta": {