hereby 1.0.1 → 1.0.4

package/README.md

@@ -1,6 +1,8 @@
 # hereby
 
-[![npm version](https://badge.fury.io/js/hereby.svg)](https://badge.fury.io/js/hereby)
+[![npm](https://img.shields.io/npm/v/hereby.svg)](https://npmjs.com/package/hereby)
+[![node](https://img.shields.io/node/v/hereby.svg)](https://nodejs.org)
+[![install size](https://packagephobia.com/badge?p=hereby)](https://packagephobia.com/result?p=hereby)
 [![ci](https://github.com/jakebailey/hereby/actions/workflows/ci.yml/badge.svg)](https://github.com/jakebailey/hereby/actions/workflows/ci.yml)
 [![codecov](https://codecov.io/gh/jakebailey/hereby/branch/main/graph/badge.svg?token=YL2Z1uk5dh)](https://codecov.io/gh/jakebailey/hereby)
 
@@ -8,7 +10,10 @@
 
 # Herebyfile.mjs
 
-Tasks are defined in `Herebyfile.mjs`, like:
+Tasks are defined in `Herebyfile.mjs`. Exported tasks are available to run
+at the CLI, with support for `export default`.
+
+For example:
 
 ```js
 import { execa } from "execa";

package/dist/cli/reexec.js

@@ -2,6 +2,7 @@ import chalk from "chalk";
 import foregroundChild from "foreground-child";
 import { resolve } from "import-meta-resolve";
 import { fileURLToPath, pathToFileURL } from "url";
+import { UserError } from "./utils.js";
 export async function reexec(system, herebyfilePath) {
     // If hereby is installed globally, but run against a Herebyfile in some
     // other package, that Herebyfile's import will resolve to a different
@@ -15,7 +16,13 @@ export async function reexec(system, herebyfilePath) {
     // TODO: Rather than spawning a child process, perhaps we could instead
     // import the CLI from the other version and run it.
     const thisCLI = await resolveToPath("hereby/cli", new URL(import.meta.url));
-    const otherCLI = await resolveToPath("hereby/cli", pathToFileURL(herebyfilePath));
+    let otherCLI;
+    try {
+        otherCLI = await resolveToPath("hereby/cli", pathToFileURL(herebyfilePath));
+    }
+    catch {
+        throw new UserError("Unable to find hereby; ensure hereby is installed in your package.");
+    }
     if (thisCLI === otherCLI) {
         return false;
     }

package/dist/cli.js

@@ -1,3 +1,4 @@
+#!/usr/bin/env node
 import { main } from "./cli/index.js";
 import { createSystem } from "./cli/utils.js";
 // eslint-disable-next-line no-restricted-globals

package/dist/index.d.ts

@@ -24,6 +24,7 @@ export interface TaskOptions {
  * A hereby Task. To get an instance, call `test`.
  */
 export declare class Task {
+    private _options;
     private constructor();
 }
 /**

package/dist/index.js

@@ -3,6 +3,28 @@
  */
 export class Task {
     constructor(options) {
+        // Runtime typecheck; consumers of hereby may not have enabled
+        // typechecking, so this is helpful.
+        if (typeof options.name !== "string") {
+            throw new Error("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 (!Array.isArray(options.dependencies) && typeof options.dependencies !== "undefined") {
+            throw new Error("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.");
+                }
+            }
+        }
+        if (typeof options.run !== "function" && typeof options.run !== "undefined") {
+            throw new Error("Task run is not a function or undefined.");
+        }
+        // Non-type checks.
         if (!options.name) {
             throw new Error("Task name must not be empty.");
         }
@@ -12,7 +34,11 @@ export class Task {
         if (!options.dependencies?.length && !options.run) {
             throw new Error("Task must have at run function or dependencies.");
         }
-        this.options = options;
+        this._options = options;
+    }
+    /* @internal */
+    get options() {
+        return this._options;
     }
     /* @internal */
     static create(options) {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "hereby",
-    "version": "1.0.1",
+    "version": "1.0.4",
     "description": "A simple task runner",
     "repository": "github:jakebailey/hereby",
     "type": "module",