runset 0.0.1 → 0.0.2

package/README.md

@@ -1,10 +1,16 @@
 # runset
 
-Run npm scripts in sequence or in parallel. Based on ideas from
-[`npm-run-all`](https://github.com/mysticatea/npm-run-all), with reusable
-pipelines, colored labels, and grouped output.
-
-Requires Node.js 24.2 or later. No runtime dependencies.
+Run npm scripts and shell commands in parallel or sequence, with glob matching,
+reusable pipelines, colored labels, and grouped output. Inspired by
+`npm-run-all`, with more control over execution and output.
+
+- **Flexible execution** — mix parallel and sequential steps, with concurrency
+  limits
+- **Readable output** — colored labels, grouped logs, and output redirection
+- **Process control** — stop, continue, or restart on exit, clean up process
+  trees on interruption
+- **Workspace support**
+- **Zero dependencies**
 
 ```sh
 npm install --save-dev runset
@@ -214,21 +220,21 @@ to the commands that follow them.
 The same object may live in a `runset` section of `package.json` instead; a
 `runset.config.*` file in the same directory wins over it.
 
-Use `commandDictionary` to give a command or pipeline a reusable name:
+Use `scripts` to give a command or pipeline a reusable name:
 
 ```ts
 import type { ConfigJs } from 'runset';
 
 export default {
-  commandDictionary: {
+  scripts: {
     check: ['lint', 'test'],
     api: { command: 'node server.js', env: { PORT: '4000' } },
   },
 } satisfies ConfigJs;
 ```
 
-Run these with `npx runset check` or `npx runset api`. Dictionary names take
-priority over npm script names.
+Run these with `npx runset check` or `npx runset api`. Names in `scripts` take
+priority over the same names in `package.json`.
 
 Config files also support `.js`, `.mjs`, `.cjs`, and `.json`. runset looks in
 the working directory and its parents. CLI commands run **after** any `commands`
@@ -248,9 +254,8 @@ Config modules can also export a synchronous function receiving
 `commands` are skipped, so lists can contain conditional commands.
 
 Named pipelines can run together: with `api: ['build:api', 'test:api']` and
-`web: ['build:web', 'test:web']` in `commandDictionary`, `npx runset -p api web`
-runs both builds, then both tests. Both builds must finish before either test
-starts.
+`web: ['build:web', 'test:web']` in `scripts`, `npx runset -p api web` runs both
+builds, then both tests. Both builds must finish before either test starts.
 
 ## Library
 

package/dist/index.d.mts

@@ -76,8 +76,6 @@ export type CommandDefinition = CommandEntry | CommandSettings | false | null |
 export interface ConfigJs {
   /** Default: `'auto'`. */
   color?: ColorMode;
-  /** Named commands, resolved before `package.json` scripts. An entry may be a list. */
-  commandDictionary?: Record<string, CommandDefinition | CommandDefinition[]>;
   commands?: CommandDefinition[];
   cwd?: string;
   dryRun?: boolean;
@@ -107,6 +105,8 @@ export interface ConfigJs {
   parallel?: boolean;
   /** The default `recursive` for every command. Default: `false`. */
   recursive?: boolean;
+  /** Named commands, resolved before `package.json` scripts. An entry may be a list. */
+  scripts?: Record<string, CommandDefinition | CommandDefinition[]>;
   /** Print each command before it starts. Default: `false`. */
   showCommand?: boolean;
   /** Print how each command exited, green or red. Default: `false`. */
@@ -178,7 +178,7 @@ interface ParsedCli {
 /** The resolved run-wide configuration: CLI flag → config file → default. */
 declare class Config {
   readonly commands: CommandDefinition[];
-  readonly commandDictionary: Record<string, CommandDefinition | CommandDefinition[]>;
+  readonly scripts: Record<string, CommandDefinition | CommandDefinition[]>;
   /** Everything after `--`, for placeholders. */
   readonly args: string[];
   readonly cwd: string;

package/dist/index.mjs

@@ -563,7 +563,7 @@ const COLOR_MODES = /* @__PURE__ */ new Set([
 ]);
 const KNOWN_KEYS = /* @__PURE__ */ new Set([
 	"color",
-	"commandDictionary",
+	"scripts",
 	"commands",
 	"cwd",
 	"dryRun",
@@ -599,7 +599,7 @@ function createConfig({ cli = parseCli(process.argv.slice(2)), configJs, cwd = p
 /** The resolved run-wide configuration: CLI flag → config file → default. */
 var Config = class {
 	commands;
-	commandDictionary;
+	scripts;
 	/** Everything after `--`, for placeholders. */
 	args;
 	cwd;
@@ -647,7 +647,7 @@ var Config = class {
 			...options.env
 		};
 		this.commands = [...file.commands ?? [], ...cli.commands].filter(Boolean);
-		this.commandDictionary = file.commandDictionary ?? {};
+		this.scripts = file.scripts ?? {};
 		this.args = cli.positional;
 		this.jobs = options.jobs ?? file.jobs ?? Number.POSITIVE_INFINITY;
 		this.killTimeout = options.killTimeout ?? file.killTimeout ?? DEFAULT_KILL_TIMEOUT;
@@ -694,7 +694,7 @@ var Config = class {
 			stdError("stdout", this.stdout),
 			stdError("stderr", this.stderr),
 			this.formatLabel !== void 0 && typeof this.formatLabel !== "function" ? "formatLabel must be a function." : void 0,
-			typeof this.commandDictionary !== "object" || this.commandDictionary === null || Array.isArray(this.commandDictionary) ? "commandDictionary must be an object." : void 0,
+			typeof this.scripts !== "object" || this.scripts === null || Array.isArray(this.scripts) ? "scripts must be an object." : void 0,
 			actionError("onSuccess", this.onSuccess),
 			actionError("onFailure", this.onFailure)
 		].find((error) => error !== void 0), ConfigError);
@@ -1376,9 +1376,9 @@ function normalize(config, packageInfo) {
 	function resolveToken(raw, inherited, overrides, seen) {
 		const token = splitToken(raw);
 		const inline = resolveCwd(parseInlineOptions(token.options, config.args), inherited.cwd ?? config.cwd);
-		if (Object.hasOwn(config.commandDictionary, token.name)) {
+		if (Object.hasOwn(config.scripts, token.name)) {
 			if (seen.has(token.name)) throw new NormalizeError(`Command "${token.name}" refers to itself.`);
-			const resolved = resolveEntry(config.commandDictionary[token.name], inherited, layer(inline, overrides), /* @__PURE__ */ new Set([...seen, token.name]));
+			const resolved = resolveEntry(config.scripts[token.name], inherited, layer(inline, overrides), /* @__PURE__ */ new Set([...seen, token.name]));
 			return token.args === "" ? resolved : appendArgs(resolved, token);
 		}
 		const settled = layer(inherited, inline, overrides);
@@ -1414,7 +1414,7 @@ function normalize(config, packageInfo) {
 	function resolve(definition, inherited, overrides, seen) {
 		if (!definition) return EMPTY_SEGMENT;
 		if (typeof definition === "string") return resolveToken(definition, inherited, overrides, seen);
-		if (Array.isArray(definition)) throw new NormalizeError("A list of commands belongs in \"commands\" or in a \"commandDictionary\" entry, not inside one.");
+		if (Array.isArray(definition)) throw new NormalizeError("A list of commands belongs in \"commands\" or in a \"scripts\" entry, not inside one.");
 		if (isCommandSettings(definition)) throw new NormalizeError("A command definition needs a \"command\" field.");
 		const entry = definition;
 		if (typeof entry.command !== "string") throw new NormalizeError("A command's \"command\" must be a string.");
@@ -1422,7 +1422,7 @@ function normalize(config, packageInfo) {
 		return resolveToken(command, layer(inherited, resolveCwd(raw, inherited.cwd ?? config.cwd)), overrides, seen);
 	}
 	/**
-	* `commands`, or a dictionary entry that is a list. The list's own
+	* `commands`, or a `scripts` entry that is a list. The list's own
 	* `parallel` places the list as a whole and is not passed to its members.
 	*/
 	function resolveList(definitions, inherited, overrides, seen) {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "runset",
-  "version": "0.0.1",
-  "description": "A fast, feature-rich task runner for npm scripts — run them in parallel or in sequence, with glob matching and reusable pipelines.",
+  "version": "0.0.2",
+  "description": "Run npm scripts and shell commands in parallel or sequence, with glob matching, reusable pipelines, colored labels, and grouped output",
   "keywords": [
     "npm-run-all",
     "run",