hereby 1.8.6 → 1.8.8

package/README.md

@@ -11,7 +11,7 @@
 
 `hereby` is a simple task runner.
 
-```
+```console
 $ npm i -D hereby
 $ yarn add -D hereby
 ```
@@ -73,7 +73,7 @@ export const bundle = task({
 
 Given the above Herebyfile:
 
-```
+```console
 $ hereby build        # Run the "build" task
 $ hereby test         # Run the "test" task, which depends on "build".
 $ hereby              # Run the default exported task.
@@ -84,7 +84,7 @@ $ hereby test bundle  # Run the "test" and "bundle" tasks in parallel.
 
 `hereby` also supports a handful of flags:
 
-```
+```console
 -h, --help          Display this usage guide.
 --herebyfile path   A path to a Herebyfile. Optional.
 -T, --tasks         Print a listing of the available tasks.
@@ -125,7 +125,7 @@ anyway).
 To run tasks in a specific order and more than once, run `hereby` multiple
 times:
 
-```
+```console
 $ hereby build
 $ hereby clean
 $ hereby build

package/dist/cli/formatTasks.js

@@ -1,28 +1,22 @@
 import commandLineUsage from "command-line-usage";
 import pc from "picocolors";
-import { compareStrings, compareTaskNames } from "./utils.js";
+import { compareTaskNames } from "./utils.js";
 export function formatTasks(format, tasks, defaultTask) {
-    tasks = tasks.filter(isTaskVisible).sort(compareTaskNames);
+    const visibleTasks = [...tasks].filter(isTaskVisible).sort(compareTaskNames);
     if (format === "simple") {
-        return tasks.map((task) => task.options.name).join("\n");
+        return visibleTasks.map((task) => task.options.name).join("\n");
     }
     return commandLineUsage({
         header: "Available tasks",
-        content: tasks.map((task) => {
+        content: visibleTasks.map((task) => {
             var _a;
             const name = task === defaultTask
                 ? `${pc.green(task.options.name)} (default)`
                 : pc.blue(task.options.name);
-            let descriptionParts;
-            if (task.options.description) {
-                descriptionParts = [task.options.description];
-            }
-            const deps = (_a = task.options.dependencies) === null || _a === void 0 ? void 0 : _a.filter(isTaskVisible);
-            if (deps && deps.length > 0) {
-                const depNames = deps
-                    .map((task) => task.options.name)
-                    .sort(compareStrings)
-                    .map((v) => pc.blue(v));
+            let descriptionParts = task.options.description ? [task.options.description] : undefined;
+            const deps = (_a = task.options.dependencies) === null || _a === void 0 ? void 0 : _a.filter(isTaskVisible).sort(compareTaskNames);
+            if (deps === null || deps === void 0 ? void 0 : deps.length) {
+                const depNames = deps.map((task) => pc.blue(task.options.name));
                 (descriptionParts !== null && descriptionParts !== void 0 ? descriptionParts : (descriptionParts = [])).push(`Depends on: ${depNames.join(", ")}`);
             }
             return { name, description: descriptionParts === null || descriptionParts === void 0 ? void 0 : descriptionParts.join("\n") };

package/dist/cli/index.js

@@ -1,11 +1,12 @@
 import path from "node:path";
+import util from "node:util";
 import pc from "picocolors";
 import { formatTasks } from "./formatTasks.js";
 import { findHerebyfile, loadHerebyfile } from "./loadHerebyfile.js";
 import { getUsage, parseArgs } from "./parseArgs.js";
 import { reexec } from "./reexec.js";
 import { Runner } from "./runner.js";
-import { compareTaskNames, ExitCodeError, UserError } from "./utils.js";
+import { ExitCodeError, UserError } from "./utils.js";
 export async function main(d) {
     try {
         await mainWorker(d);
@@ -13,14 +14,18 @@ export async function main(d) {
     catch (e) {
         if (e instanceof ExitCodeError) {
             d.setExitCode(e.exitCode);
+            return;
         }
-        else if (e instanceof UserError) {
+        if (e instanceof UserError) {
             d.error(`${pc.red("Error")}: ${e.message}`);
-            d.setExitCode(1);
+        }
+        else if (util.types.isNativeError(e) && e.stack) {
+            d.error(e.stack);
         }
         else {
-            throw e;
+            d.error(`${e}`);
         }
+        d.setExitCode(1);
     }
 }
 async function mainWorker(d) {
@@ -30,7 +35,7 @@ async function mainWorker(d) {
         d.log(getUsage());
         return;
     }
-    let herebyfilePath = (_a = args.herebyfile) !== null && _a !== void 0 ? _a : (await findHerebyfile(d.cwd()));
+    let herebyfilePath = (_a = args.herebyfile) !== null && _a !== void 0 ? _a : findHerebyfile(d.cwd());
     herebyfilePath = path.resolve(d.cwd(), herebyfilePath);
     if (await reexec(d, herebyfilePath)) {
         return;
@@ -42,7 +47,7 @@ async function mainWorker(d) {
     d.chdir(path.dirname(herebyfilePath));
     const herebyfile = await loadHerebyfile(herebyfilePath);
     if (args.printTasks) {
-        d.log(formatTasks(args.printTasks, herebyfile.tasks, herebyfile.defaultTask));
+        d.log(formatTasks(args.printTasks, herebyfile.tasks.values(), herebyfile.defaultTask));
         return;
     }
     const tasks = await selectTasks(d, herebyfile, herebyfilePath, args.run);
@@ -68,30 +73,26 @@ async function mainWorker(d) {
 }
 // Exported for testing.
 export async function selectTasks(d, herebyfile, herebyfilePath, taskNames) {
-    const allTasks = new Map();
-    for (const task of herebyfile.tasks) {
-        allTasks.set(task.options.name, task);
+    if (taskNames.length === 0) {
+        if (!herebyfile.defaultTask) {
+            throw new UserError(`No default task has been exported from ${d.simplifyPath(herebyfilePath)}; please specify a task name.`);
+        }
+        return [herebyfile.defaultTask];
     }
-    if (taskNames.length > 0) {
-        const tasks = [];
-        for (const name of taskNames) {
-            const task = allTasks.get(name);
-            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, [...allTasks.keys()]);
-                if (distance(name, candidate) < name.length * 0.4) {
-                    message += ` Did you mean "${candidate}"?`;
-                }
-                throw new UserError(message);
+    const tasks = [];
+    for (const name of taskNames) {
+        const task = herebyfile.tasks.get(name);
+        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, [...herebyfile.tasks.keys()]);
+            if (distance(name, candidate) < name.length * 0.4) {
+                message += ` Did you mean "${candidate}"?`;
             }
-            tasks.push(task);
+            throw new UserError(message);
         }
-        return tasks.sort(compareTaskNames);
-    }
-    if (!herebyfile.defaultTask) {
-        throw new UserError(`No default task has been exported from ${d.simplifyPath(herebyfilePath)}; please specify a task name.`);
+        tasks.push(task);
     }
-    return [herebyfile.defaultTask];
+    return tasks;
 }
 //# sourceMappingURL=index.js.map

package/dist/cli/loadHerebyfile.js

@@ -4,28 +4,29 @@ import { pathToFileURL } from "node:url";
 import pc from "picocolors";
 import { Task } from "../index.js";
 import { UserError } from "./utils.js";
-const filenames = ["Herebyfile", "herebyfile"];
-const extensions = ["mjs", "js"];
-const allFilenames = new Set(extensions.flatMap((e) => filenames.map((f) => `${f}.${e}`)));
-export async function findHerebyfile(dir) {
+const herebyfileRegExp = /^herebyfile\.m?js$/i;
+export function findHerebyfile(dir) {
     const root = path.parse(dir).root;
-    for (; dir !== root; dir = path.dirname(dir)) {
-        const entries = await fs.promises.readdir(dir);
-        const matching = entries.filter((e) => allFilenames.has(e));
+    while (true) {
+        const entries = fs.readdirSync(dir);
+        const matching = entries.filter((e) => herebyfileRegExp.test(e));
         if (matching.length > 1) {
             throw new UserError(`Found more than one Herebyfile: ${matching.join(", ")}`);
         }
         if (matching.length === 1) {
             const candidate = path.join(dir, matching[0]);
-            const stat = await fs.promises.stat(candidate);
+            const stat = fs.statSync(candidate);
             if (!stat.isFile()) {
                 throw new UserError(`${matching[0]} is not a file.`);
             }
             return candidate;
         }
         if (entries.includes("package.json")) {
-            break;
+            break; // TODO: Is this actually desirable? What about monorepos?
         }
+        if (dir === root)
+            break;
+        dir = path.dirname(dir);
     }
     throw new UserError("Unable to find Herebyfile.");
 }
@@ -54,14 +55,11 @@ export async function loadHerebyfile(herebyfilePath) {
     if (exportedTasks.size === 0) {
         throw new UserError("No tasks found. Did you forget to export your tasks?");
     }
-    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);
-    return {
-        tasks,
-        defaultTask,
-    };
+    checkTaskInvariants(exportedTasks);
+    const tasks = new Map([...exportedTasks.values()].map((task) => [task.options.name, task]));
+    return { tasks, defaultTask };
 }
 function checkTaskInvariants(tasks) {
     const checkedTasks = new Set();

package/dist/cli/runner.js

@@ -1,11 +1,10 @@
-import assert from "node:assert";
 import pc from "picocolors";
 export class Runner {
-    constructor(d) {
+    constructor(_d) {
+        this._d = _d;
         this._addedTasks = new Map();
         this._errored = false;
         this._startTimes = new Map();
-        this._d = d;
     }
     async runTasks(...tasks) {
         // Using allSettled here so that we don't immediately exit; it could be
@@ -55,7 +54,7 @@ export class Runner {
         if (this._errored) {
             return; // Skip logging.
         }
-        const took = Date.now() - checkDefined(this._startTimes.get(task));
+        const took = Date.now() - this._startTimes.get(task);
         this._d.log(`Finished ${pc.green(task.options.name)} in ${this._d.prettyMilliseconds(took)}`);
     }
     onTaskError(task, e) {
@@ -63,12 +62,8 @@ export class Runner {
             return; // Skip logging.
         }
         this._errored = true;
-        const took = Date.now() - checkDefined(this._startTimes.get(task));
+        const took = Date.now() - this._startTimes.get(task);
         this._d.error(`Error in ${pc.red(task.options.name)} in ${this._d.prettyMilliseconds(took)}\n${e}`);
     }
 }
-function checkDefined(value) {
-    assert(value !== undefined);
-    return value;
-}
 //# sourceMappingURL=runner.js.map

package/dist/cli/utils.js

@@ -6,13 +6,11 @@ export function compareTaskNames(a, b) {
     return compareStrings(a.options.name, b.options.name);
 }
 // eslint-disable-next-line @typescript-eslint/unbound-method
-export const compareStrings = new Intl.Collator(undefined, { numeric: true }).compare;
+const compareStrings = new Intl.Collator(undefined, { numeric: true }).compare;
 // Exported for testing.
 export function simplifyPath(p) {
-    let homedir = os.homedir();
-    if (!p.endsWith(path.sep)) {
-        homedir += path.sep;
-    }
+    p = path.normalize(p);
+    const homedir = path.normalize(os.homedir() + path.sep);
     if (p.startsWith(homedir)) {
         p = p.slice(homedir.length);
         return `~${path.sep}${p}`;
@@ -24,9 +22,6 @@ export function simplifyPath(p) {
  * as a message only, without stacktrace. Use this instead of process.exit.
  */
 export class UserError extends Error {
-    constructor(message) {
-        super(message);
-    }
 }
 /**
  * When thrown, ExitCodeError causes the process to exit with a specific error code,
@@ -39,7 +34,6 @@ export class ExitCodeError {
     }
 }
 export async function real() {
-    const importResolve = memoize(async () => (await import("import-meta-resolve")).resolve);
     const { default: prettyMilliseconds } = await import("pretty-ms");
     /* eslint-disable no-restricted-globals */
     return {
@@ -55,23 +49,18 @@ export async function real() {
             process.exitCode = code;
         },
         version: async () => {
-            // Not bothering to memoize this function; it will only be called once.
-            const resolve = await importResolve();
+            const { resolve } = await import("import-meta-resolve");
             const packageJsonPath = fileURLToPath(await resolve("hereby/package.json", import.meta.url));
             const packageJson = await fs.promises.readFile(packageJsonPath, "utf8");
             const { version } = JSON.parse(packageJson);
             return version;
         },
         resolve: async (specifier, parent) => {
-            const resolve = await importResolve();
+            const { resolve } = await import("import-meta-resolve");
             return resolve(specifier, parent);
         },
         prettyMilliseconds,
     };
     /* eslint-enable no-restricted-globals */
 }
-function memoize(fn) {
-    let value;
-    return () => (value !== null && value !== void 0 ? value : (value = fn()));
-}
 //# sourceMappingURL=utils.js.map

package/dist/cli.js

@@ -1,15 +1,7 @@
 import { main } from "./cli/index.js";
 import { real } from "./cli/utils.js";
 async function run() {
-    try {
-        await main(await real());
-    }
-    catch (e) {
-        // eslint-disable-next-line no-restricted-globals
-        console.error(e);
-        // eslint-disable-next-line no-restricted-globals
-        process.exitCode = 1;
-    }
+    await main(await real());
 }
 void run();
 //# sourceMappingURL=cli.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "hereby",
-    "version": "1.8.6",
+    "version": "1.8.8",
     "description": "A simple task runner",
     "repository": "github:jakebailey/hereby",
     "type": "module",
@@ -48,23 +48,24 @@
     },
     "devDependencies": {
         "@ava/typescript": "^3.0.1",
+        "@changesets/cli": "^2.26.2",
         "@tsconfig/node12": "^12.1.0",
-        "@types/command-line-usage": "^5.0.2",
-        "@types/minimist": "^1.2.2",
-        "@types/node": "^14.18.56",
-        "@types/tmp": "^0.2.3",
-        "@typescript-eslint/eslint-plugin": "^6.4.1",
-        "@typescript-eslint/parser": "^6.4.1",
+        "@types/command-line-usage": "^5.0.3",
+        "@types/minimist": "^1.2.4",
+        "@types/node": "^20.8.10",
+        "@types/tmp": "^0.2.5",
+        "@typescript-eslint/eslint-plugin": "^6.9.1",
+        "@typescript-eslint/parser": "^6.9.1",
         "ava": "~5.0.1",
         "c8": "^8.0.1",
-        "dprint": "^0.40.2",
-        "eslint": "^8.48.0",
+        "dprint": "^0.42.5",
+        "eslint": "^8.52.0",
         "eslint-plugin-ava": "^14.0.0",
         "eslint-plugin-simple-import-sort": "^10.0.0",
-        "eslint-plugin-unicorn": "^48.0.1",
+        "eslint-plugin-unicorn": "^49.0.0",
         "execa": "^6.1.0",
-        "moq.ts": "^10.0.6",
-        "rimraf": "^5.0.1",
+        "moq.ts": "^10.0.8",
+        "rimraf": "^5.0.5",
         "tmp": "^0.2.1",
         "typescript": "^5.2.2"
     },
@@ -101,17 +102,5 @@
             "html",
             "lcov"
         ]
-    },
-    "release-it": {
-        "npm": {
-            "publish": false
-        },
-        "git": {
-            "commitMessage": "Release v${version}",
-            "tagName": "v${version}"
-        },
-        "hooks": {
-            "before:init": "npm run build && npm run test"
-        }
     }
 }