hereby 1.11.1 → 1.13.0

package/dist/cli/formatTasks.js

@@ -1,29 +1,57 @@
-import commandLineUsage from "command-line-usage";
 import pc from "picocolors";
+import Wordwrap from "wordwrapjs";
 import { compareTaskNames } from "./utils.js";
-export function formatTasks(format, tasks, defaultTask) {
+export function formatTasks(format, tasks, defaultTask, columns) {
     const visibleTasks = [...tasks].filter(isTaskVisible).sort(compareTaskNames);
     if (format === "simple") {
         return visibleTasks.map((task) => task.options.name).join("\n");
     }
-    return commandLineUsage({
-        header: "Available tasks",
-        content: visibleTasks.map((task) => {
-            var _a;
-            const name = task === defaultTask
-                ? `${pc.green(task.options.name)} (default)`
-                : pc.blue(task.options.name);
-            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") };
-        }),
+    const names = visibleTasks.map((task) => task === defaultTask ? `${pc.green(task.options.name)} (default)` : pc.blue(task.options.name));
+    const descriptions = visibleTasks.map((task) => {
+        var _a, _b;
+        let parts = 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));
+            (parts !== null && parts !== void 0 ? parts : (parts = [])).push(`Depends on: ${depNames.join(", ")}`);
+        }
+        return (_b = parts === null || parts === void 0 ? void 0 : parts.join("\n")) !== null && _b !== void 0 ? _b : "";
     });
+    // There's a 2 space indent plus 3 spaces between columns, hence take away 5
+    // padding spaces from the available width
+    const maxTotalWidth = columns - 5;
+    const maxNameWidth = Math.max(...names.map(visibleLength));
+    // Check the name doesn't take up more than half the space
+    const nameWidth = Math.min(maxNameWidth, maxTotalWidth >> 1);
+    const descriptionWidth = maxTotalWidth - nameWidth;
+    const formatted = names.map((name, i) => formatAsColumns("  ", name, nameWidth, descriptions[i], descriptionWidth));
+    return `
+${pc.bold(pc.underline("Available tasks"))}
+
+${formatted.join("")}`;
 }
 function isTaskVisible(task) {
     return !task.options.hiddenFromTaskList;
 }
+function formatAsColumns(indent, leftText, leftWidth, rightText, rightWidth) {
+    const leftLines = wrapText(leftText, leftWidth);
+    const rightLines = wrapText(rightText, rightWidth);
+    const maxLines = Math.max(leftLines.length, rightLines.length);
+    let result = "";
+    for (let i = 0; i < maxLines; i++) {
+        const leftPart = leftLines[i] || "";
+        const rightPart = rightLines[i] || "";
+        const paddedLeft = leftPart.padEnd(leftWidth, " ");
+        result += `${indent}${paddedLeft}   ${rightPart}\n`;
+    }
+    return result;
+}
+// eslint-disable-next-line no-control-regex
+const ANSI_REGEX = /\u001B\[([0-9]{1,2})m/g;
+function visibleLength(str) {
+    return str.replace(ANSI_REGEX, "").length;
+}
+function wrapText(text, maxWidth) {
+    return Wordwrap.lines(text, { width: maxWidth, break: true });
+}
 //# sourceMappingURL=formatTasks.js.map

package/dist/cli/index.js

@@ -7,7 +7,7 @@ import { findHerebyfile, loadHerebyfile } from "./loadHerebyfile.js";
 import { getUsage, parseArgs } from "./parseArgs.js";
 import { reexec } from "./reexec.js";
 import { Runner } from "./runner.js";
-import { UserError } from "./utils.js";
+import { prettyMilliseconds, UserError } from "./utils.js";
 export async function main(d) {
     try {
         await mainWorker(d);
@@ -42,7 +42,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.values(), herebyfile.defaultTask));
+        d.log(formatTasks(args.printTasks, herebyfile.tasks.values(), herebyfile.defaultTask, d.columns()));
         return;
     }
     const tasks = await selectTasks(d, herebyfile, herebyfilePath, args.run);
@@ -62,7 +62,7 @@ async function mainWorker(d) {
     finally {
         const took = performance.now() - start;
         const failed = runner.failedTasks.length > 0;
-        d.log(`Completed ${taskNames}${failed ? pc.red(" with errors") : ""} in ${d.prettyMilliseconds(took)}`);
+        d.log(`Completed ${taskNames}${failed ? pc.red(" with errors") : ""} in ${prettyMilliseconds(took)}`);
         if (failed) {
             const names = runner.failedTasks.sort().map((task) => pc.red(task)).join(", ");
             d.log(`Failed tasks: ${names}`);

package/dist/cli/parseArgs.js

@@ -1,5 +1,5 @@
-import commandLineUsage from "command-line-usage";
 import minimist from "minimist";
+import pc from "picocolors";
 export function parseArgs(argv) {
     let parseUnknownAsTask = true;
     const options = minimist(argv, {
@@ -21,54 +21,29 @@ export function parseArgs(argv) {
     };
 }
 export function getUsage() {
-    const usage = commandLineUsage([
-        {
-            header: "hereby",
-            content: "A simple task runner.",
-        },
-        {
-            header: "Synopsis",
-            content: "$ hereby <task>",
-        },
-        {
-            header: "Options",
-            optionList: [
-                {
-                    name: "help",
-                    description: "Display this usage guide.",
-                    alias: "h",
-                    type: Boolean,
-                },
-                {
-                    name: "herebyfile",
-                    description: "A path to a Herebyfile. Optional.",
-                    type: String,
-                    defaultOption: true,
-                    typeLabel: "{underline path}",
-                },
-                {
-                    name: "tasks",
-                    description: "Print a listing of the available tasks.",
-                    alias: "T",
-                    type: Boolean,
-                },
-                {
-                    name: "version",
-                    description: "Print the current hereby version.",
-                    type: Boolean,
-                },
-            ],
-        },
-        {
-            header: "Example usage",
-            content: [
-                "$ hereby build",
-                "$ hereby build lint",
-                "$ hereby test --skip someTest --lint=false",
-                "$ hereby --tasks",
-            ],
-        },
-    ]);
-    return usage;
+    const header = (text) => pc.bold(pc.underline(text));
+    return `
+${header("hereby")}
+
+  A simple task runner.
+
+${header("Synopsis")}
+
+  $ hereby <task>
+
+${header("Options")}
+
+  ${pc.bold("-h, --help")}          Display this usage guide.
+  ${pc.bold("--herebyfile")} ${pc.underline("path")}   A path to a Herebyfile. Optional.
+  ${pc.bold("-T, --tasks")}         Print a listing of the available tasks.
+  ${pc.bold("--version")}           Print the current hereby version.
+
+${header("Example usage")}
+
+  $ hereby build
+  $ hereby build lint
+  $ hereby test --skip someTest --lint=false
+  $ hereby --tasks
+`;
 }
 //# sourceMappingURL=parseArgs.js.map

package/dist/cli/runner.js

@@ -1,11 +1,11 @@
 import { performance } from "node:perf_hooks";
 import pc from "picocolors";
+import { prettyMilliseconds } from "./utils.js";
 export class Runner {
     constructor(_d) {
         this._d = _d;
         this._addedTasks = new Map();
         this.failedTasks = [];
-        this._startTimes = new Map();
     }
     async runTasks(...tasks) {
         // Using allSettled here so that we don't immediately exit; it could be
@@ -32,34 +32,25 @@ export class Runner {
         }
         if (!run)
             return;
+        const start = performance.now();
         try {
-            this.onTaskStart(task);
+            if (this.failedTasks.length === 0) {
+                this._d.log(`Starting ${pc.blue(task.options.name)}`);
+            }
             await run();
-            this.onTaskFinish(task);
+            if (this.failedTasks.length === 0) {
+                const took = performance.now() - start;
+                this._d.log(`Finished ${pc.green(task.options.name)} in ${prettyMilliseconds(took)}`);
+            }
         }
         catch (e) {
-            this.onTaskError(task, e);
+            this.failedTasks.push(task.options.name);
+            if (this.failedTasks.length === 1) {
+                const took = performance.now() - start;
+                this._d.error(`Error in ${pc.red(task.options.name)} in ${prettyMilliseconds(took)}\n${e}`);
+            }
             throw e;
         }
     }
-    onTaskStart(task) {
-        this._startTimes.set(task, performance.now());
-        if (this.failedTasks.length > 0)
-            return; // Skip logging.
-        this._d.log(`Starting ${pc.blue(task.options.name)}`);
-    }
-    onTaskFinish(task) {
-        if (this.failedTasks.length > 0)
-            return; // Skip logging.
-        const took = performance.now() - this._startTimes.get(task);
-        this._d.log(`Finished ${pc.green(task.options.name)} in ${this._d.prettyMilliseconds(took)}`);
-    }
-    onTaskError(task, e) {
-        this.failedTasks.push(task.options.name);
-        if (this.failedTasks.length > 1)
-            return; // Skip logging.
-        const took = performance.now() - this._startTimes.get(task);
-        this._d.error(`Error in ${pc.red(task.options.name)} in ${this._d.prettyMilliseconds(took)}\n${e}`);
-    }
 }
 //# sourceMappingURL=runner.js.map

package/dist/cli/utils.js

@@ -28,16 +28,34 @@ export function findUp(dir, predicate) {
     }
     return undefined;
 }
+export function prettyMilliseconds(ms) {
+    if (ms < 1000)
+        return `${Math.ceil(ms)}ms`;
+    const seconds = (ms / 1000) % 60;
+    const minutes = Math.floor(ms / 60000) % 60;
+    const hours = Math.floor(ms / 3600000);
+    // Round to one decimal, with an epsilon to avoid floating point errors (e.g. 5.0000001 -> 5).
+    const roundedSeconds = Math.floor(seconds * 10 + 1e-7) / 10;
+    const parts = [];
+    if (hours > 0)
+        parts.push(`${hours}h`);
+    if (minutes > 0)
+        parts.push(`${minutes}m`);
+    if (roundedSeconds > 0) {
+        parts.push(roundedSeconds % 1 === 0 ? `${roundedSeconds}s` : `${roundedSeconds.toFixed(1)}s`);
+    }
+    return parts.join(" ");
+}
 /**
  * UserError is a special error that, when caught in the CLI will be printed
  * as a message only, without stacktrace. Use this instead of process.exit.
  */
 export class UserError extends Error {
 }
-export async function real() {
-    const { default: prettyMilliseconds } = await import("pretty-ms");
+export function real() {
     /* eslint-disable no-restricted-globals */
     return {
+        columns: () => process.stdout.isTTY && process.stdout.columns || 80,
         log: console.log,
         error: console.error,
         // eslint-disable-next-line @typescript-eslint/unbound-method
@@ -54,7 +72,6 @@ export async function real() {
             const packageJson = fs.readFileSync(packageJsonURL, "utf8");
             return JSON.parse(packageJson).version;
         },
-        prettyMilliseconds,
     };
     /* eslint-enable no-restricted-globals */
 }

package/dist/cli.js

@@ -6,7 +6,7 @@ if (module.enableCompileCache) {
 async function run() {
     const { main } = await import("./cli/index.js");
     const { real } = await import("./cli/utils.js");
-    await main(await real());
+    await main(real());
 }
 void run();
 //# sourceMappingURL=cli.js.map

package/dist/index.d.ts

@@ -27,7 +27,7 @@ export interface TaskOptions {
     hiddenFromTaskList?: boolean | undefined;
 }
 /**
- * A hereby Task. To get an instance, call `test`.
+ * A hereby Task. To get an instance, call `task`.
  */
 export declare class Task {
     private _;

package/dist/index.js

@@ -1,5 +1,6 @@
+import assert from "node:assert";
 /**
- * A hereby Task. To get an instance, call `test`.
+ * A hereby Task. To get an instance, call `task`.
  */
 export class Task {
     /* @internal */
@@ -13,34 +14,19 @@ export class Task {
         // typechecking, so this is helpful.
         var _a, _b;
         /* eslint-disable @typescript-eslint/no-unnecessary-condition */
-        if (typeof options.name !== "string") {
-            throw new TypeError("Task name is not a string.");
-        }
-        if (typeof options.description !== "string" && options.description !== undefined) {
-            throw new TypeError("Task description is not a string or undefined.");
-        }
-        if (!Array.isArray(options.dependencies) && options.dependencies !== undefined) {
-            throw new TypeError("Task dependencies is not an array or undefined.");
-        }
+        assert.ok(typeof options.name === "string", "Task name is not a string.");
+        assert.ok(typeof options.description === "string" || options.description === undefined, "Task description is not a string or undefined.");
+        assert.ok(Array.isArray(options.dependencies) || options.dependencies === undefined, "Task dependencies is not an array or undefined.");
         for (const dep of (_a = options.dependencies) !== null && _a !== void 0 ? _a : []) {
-            if (!(dep instanceof Task)) {
-                throw new TypeError("Task dependency is not a task.");
-            }
-        }
-        if (typeof options.run !== "function" && options.run !== undefined) {
-            throw new TypeError("Task run is not a function or undefined.");
+            assert.ok(dep instanceof Task, "Task dependency is not a task.");
         }
+        assert.ok(typeof options.run === "function" || options.run === undefined, "Task run is not a function or undefined.");
         /* eslint-enable @typescript-eslint/no-unnecessary-condition */
         // Non-type checks.
-        if (!options.name) {
-            throw new Error("Task name must not be empty.");
-        }
-        if (options.name.startsWith("-")) {
-            throw new Error('Task name must not start with "-".');
-        }
-        if (!((_b = options.dependencies) === null || _b === void 0 ? void 0 : _b.length) && !options.run) {
-            throw new Error("Task must have a run function or dependencies.");
-        }
+        assert.ok(options.name !== "", "Task name must not be empty.");
+        assert.ok(!options.name.startsWith("-"), 'Task name must not start with "-".');
+        // eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing
+        assert.ok(!!(((_b = options.dependencies) === null || _b === void 0 ? void 0 : _b.length) || options.run), "Task must have a run function or dependencies.");
         this.options = options;
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "hereby",
-    "version": "1.11.1",
+    "version": "1.13.0",
     "description": "A simple task runner",
     "repository": "github:jakebailey/hereby",
     "type": "module",
@@ -39,38 +39,35 @@
         "./dist/index.d.ts"
     ],
     "dependencies": {
-        "command-line-usage": "^6.1.3",
         "fastest-levenshtein": "^1.0.16",
         "minimist": "^1.2.8",
         "picocolors": "^1.1.0",
-        "pretty-ms": "^8.0.0"
+        "wordwrapjs": "^5.1.1"
     },
     "devDependencies": {
         "@ava/typescript": "^3.0.1",
-        "@changesets/cli": "^2.29.7",
-        "@codspeed/tinybench-plugin": "^4.0.1",
-        "@fast-check/ava": "2.0.1",
-        "@tsconfig/node12": "^12.1.5",
-        "@types/command-line-usage": "^5.0.4",
+        "@changesets/cli": "^2.30.0",
+        "@eslint/js": "^10.0.1",
+        "@tsconfig/node12": "^12.1.7",
         "@types/minimist": "^1.2.5",
-        "@types/node": "^24.7.2",
+        "@types/node": "^25.3.3",
         "@types/tmp": "^0.2.6",
+        "@types/wordwrapjs": "^5.1.2",
         "ava": "~5.0.1",
-        "c8": "^10.1.3",
-        "dprint": "^0.50.2",
-        "eslint": "^9.37.0",
-        "eslint-plugin-ava": "^15.1.0",
+        "c8": "^11.0.0",
+        "dprint": "^0.52.0",
+        "eslint": "^10.0.2",
+        "eslint-plugin-ava": "^16.0.0",
         "eslint-plugin-simple-import-sort": "^12.1.1",
-        "eslint-plugin-unicorn": "^61.0.2",
+        "eslint-plugin-unicorn": "^63.0.0",
         "execa": "^6.1.0",
-        "globals": "^16.4.0",
+        "globals": "^17.4.0",
         "monocart-coverage-reports": "^2.12.9",
         "moq.ts": "^10.1.0",
         "rimraf": "^5.0.10",
-        "tinybench": "~2.8.0",
         "tmp": "0.2.1",
         "typescript": "^5.9.3",
-        "typescript-eslint": "^8.46.0"
+        "typescript-eslint": "^8.56.1"
     },
     "overrides": {
         "ava": {