numux 1.18.0 → 1.20.0

package/README.md

@@ -191,7 +191,8 @@ Top-level options apply to all processes (process-level settings override):
 |-------|------|-------------|
 | `cwd` | `string` | Working directory for all processes (process `cwd` overrides) |
 | `env` | `Record<string, string>` | Environment variables merged into all processes (process `env` overrides per key) |
-| `envFile` | `string \| string[]` | `.env` file(s) for all processes (process `envFile` replaces if set) |
+| `envFile` | `string \| string[] \| false` | `.env` file(s) for all processes (process `envFile` replaces if set; `false` disables) |
+| `showCommand` | `boolean` | Print the command being run as the first line of output (default: `true`) |
 
 ```ts
 export default defineConfig({
@@ -211,10 +212,10 @@ Each process accepts:
 
 | Field | Type | Default | Description |
 |-------|------|---------|-------------|
-| `command` | `string` | *required* | Shell command to run |
+| `command` | `string` | *required* | Shell command to run. Supports `$dep.group` references from dependency capture groups |
 | `cwd` | `string` | `process.cwd()` | Working directory |
-| `env` | `Record<string, string>` | — | Extra environment variables |
-| `envFile` | `string \| string[]` | — | `.env` file path(s) to load (relative to `cwd`) |
+| `env` | `Record<string, string>` | — | Extra environment variables. Values support `$dep.group` references from dependency capture groups |
+| `envFile` | `string \| string[] \| false` | — | `.env` file path(s) to load (relative to `cwd`); `false` disables inherited envFile |
 | `dependsOn` | `string[]` | — | Processes that must be ready first |
 | `readyPattern` | `string \| RegExp` | — | Regex matched against stdout to signal readiness. Use `RegExp` to capture groups (see below) |
 | `readyTimeout` | `number` | — | Milliseconds to wait for `readyPattern` before failing |
@@ -222,11 +223,13 @@ Each process accepts:
 | `maxRestarts` | `number` | `Infinity` | Max auto-restart attempts before giving up |
 | `delay` | `number` | — | Milliseconds to wait before starting the process |
 | `condition` | `string` | — | Env var name; process skipped if falsy. Prefix with `!` to negate |
+| `platform` | `string \| string[]` | — | OS(es) this process runs on (e.g. `'darwin'`, `'linux'`). Non-matching processes are removed; dependents still start |
 | `stopSignal` | `string` | `SIGTERM` | Signal for graceful stop (`SIGTERM`, `SIGINT`, or `SIGHUP`) |
 | `color` | `string \| string[]` | auto | Hex (e.g. `"#ff6600"`) or basic name: black, red, green, yellow, blue, magenta, cyan, white, gray, orange, purple |
 | `watch` | `string \| string[]` | — | Glob patterns — restart process when matching files change |
 | `interactive` | `boolean` | `false` | When `true`, keyboard input is forwarded to the process |
 | `errorMatcher` | `boolean \| string` | — | `true` detects ANSI red output, string = regex pattern — shows error indicator on tab |
+| `showCommand` | `boolean` | `true` | Print the command being run as the first line of output |
 
 ### File watching
 

package/dist/config.d.ts

@@ -1,4 +1,4 @@
 import type { NumuxConfig } from './types';
 export type { NumuxConfig, NumuxProcessConfig } from './types';
 /** Type-safe helper for numux.config.ts files. */
-export declare function defineConfig(config: NumuxConfig): NumuxConfig;
+export declare function defineConfig<K extends string>(config: NumuxConfig<K>): NumuxConfig<K>;

package/dist/numux.js

@@ -36,7 +36,7 @@ var __commonJS = (cb, mod) => () => (mod || cb((mod = { exports: {} }).exports,
 var require_package = __commonJS((exports, module) => {
   module.exports = {
     name: "numux",
-    version: "1.18.0",
+    version: "1.20.0",
     description: "Terminal multiplexer with dependency orchestration",
     type: "module",
     license: "MIT",
@@ -826,6 +826,34 @@ async function autoDetectConfig(cwd) {
   throw new Error(`No numux config found. Create one of: ${CONFIG_FILES.join(", ")}, or add a "numux" key to package.json`);
 }
 
+// src/config/platform.ts
+function filterByPlatform(config, currentPlatform = process.platform) {
+  const excluded = new Set;
+  for (const [name, proc] of Object.entries(config.processes)) {
+    if (!proc.platform)
+      continue;
+    const platforms = Array.isArray(proc.platform) ? proc.platform : [proc.platform];
+    if (!platforms.includes(currentPlatform)) {
+      excluded.add(name);
+    }
+  }
+  if (excluded.size === 0)
+    return config;
+  const processes = {};
+  for (const [name, proc] of Object.entries(config.processes)) {
+    if (excluded.has(name))
+      continue;
+    const copy = { ...proc };
+    if (copy.dependsOn) {
+      copy.dependsOn = copy.dependsOn.filter((d) => !excluded.has(d));
+      if (copy.dependsOn.length === 0)
+        copy.dependsOn = undefined;
+    }
+    processes[name] = copy;
+  }
+  return { processes };
+}
+
 // src/config/resolver.ts
 function resolveDependencyTiers(config) {
   const names = Object.keys(config.processes);
@@ -1030,8 +1058,10 @@ function validateConfig(raw, warnings) {
       throw new Error(`Process "${name}" must have a non-empty "command" string`);
     }
     if (p.dependsOn !== undefined) {
+      if (typeof p.dependsOn === "string")
+        p.dependsOn = [p.dependsOn];
       if (!Array.isArray(p.dependsOn)) {
-        throw new Error(`Process "${name}".dependsOn must be an array`);
+        throw new Error(`Process "${name}".dependsOn must be a string or array`);
       }
       for (const dep of p.dependsOn) {
         if (typeof dep !== "string") {
@@ -1084,6 +1114,7 @@ function validateConfig(raw, warnings) {
     const processEnv = p.env && typeof p.env === "object" ? p.env : undefined;
     const processEnvFile = validateEnvFile(p.envFile);
     const showCommand = typeof p.showCommand === "boolean" ? p.showCommand : globalShowCommand ?? true;
+    const platform = validatePlatform(name, p.platform);
     validated[name] = {
       command: p.command,
       cwd: processCwd ?? globalCwd,
@@ -1096,6 +1127,7 @@ function validateConfig(raw, warnings) {
       readyTimeout: typeof p.readyTimeout === "number" && p.readyTimeout > 0 ? p.readyTimeout : undefined,
       delay: typeof p.delay === "number" && p.delay > 0 ? p.delay : undefined,
       condition: typeof p.condition === "string" && p.condition.trim() ? p.condition.trim() : undefined,
+      platform,
       stopSignal: validateStopSignal(p.stopSignal),
       color: typeof p.color === "string" ? p.color : Array.isArray(p.color) ? p.color : undefined,
       watch: validateStringOrStringArray(p.watch),
@@ -1134,6 +1166,19 @@ function validateErrorMatcher(name, value) {
   }
   return;
 }
+var VALID_PLATFORMS = new Set(["aix", "darwin", "freebsd", "linux", "openbsd", "sunos", "win32"]);
+function validatePlatform(name, value) {
+  const arr = validateStringOrStringArray(value);
+  if (arr === undefined)
+    return;
+  const values = typeof arr === "string" ? [arr] : arr;
+  for (const v of values) {
+    if (!VALID_PLATFORMS.has(v)) {
+      throw new Error(`Process "${name}".platform "${v}" is not valid. Must be one of: ${[...VALID_PLATFORMS].join(", ")}`);
+    }
+  }
+  return arr;
+}
 var VALID_STOP_SIGNALS = new Set(["SIGTERM", "SIGINT", "SIGHUP"]);
 function validateStopSignal(value) {
   if (typeof value === "string" && VALID_STOP_SIGNALS.has(value)) {
@@ -3300,6 +3345,7 @@ async function main() {
     const raw = expandScriptPatterns(await loadConfig(parsed.configPath));
     const warnings2 = [];
     let config2 = validateConfig(raw, warnings2);
+    config2 = filterByPlatform(config2);
     if (parsed.only || parsed.exclude) {
       config2 = filterConfig(config2, parsed.only, parsed.exclude);
     }
@@ -3323,6 +3369,10 @@ async function main() {
           flags.push(`delay: ${proc.delay}ms`);
         if (proc.condition)
           flags.push(`if: ${proc.condition}`);
+        if (proc.platform) {
+          const p = Array.isArray(proc.platform) ? proc.platform : [proc.platform];
+          flags.push(`platform: ${p.join(", ")}`);
+        }
         if (proc.watch) {
           const patterns = Array.isArray(proc.watch) ? proc.watch : [proc.watch];
           flags.push(`watch: ${patterns.join(", ")}`);
@@ -3412,6 +3462,7 @@ async function main() {
   } else {
     const raw = expandScriptPatterns(await loadConfig(parsed.configPath));
     config = validateConfig(raw, warnings);
+    config = filterByPlatform(config);
     if (parsed.noRestart) {
       for (const proc of Object.values(config.processes)) {
         proc.maxRestarts = 0;

package/dist/types.d.ts

@@ -1,42 +1,91 @@
-export interface NumuxProcessConfig {
+export interface NumuxProcessConfig<K extends string = string> {
+    /** Shell command to run. Supports `$dep.group` references from dependency capture groups */
     command: string;
+    /** Working directory for the process */
     cwd?: string;
+    /**
+     * Extra environment variables. Values support `$dep.group` references
+     * from dependency capture groups.
+     * @example { DB_PORT: '$db.port' }
+     */
     env?: Record<string, string>;
+    /** .env file path(s) to load, or `false` to disable */
     envFile?: string | string[] | false;
-    dependsOn?: string[];
+    /** Processes that must be ready before this one starts */
+    dependsOn?: NoInfer<K> | NoInfer<K>[];
+    /** Regex matched against stdout to signal readiness. Use `RegExp` to capture groups for `$dep.group` expansion */
     readyPattern?: string | RegExp;
+    /**
+     * Set to `false` for one-shot processes
+     * @default true
+     */
     persistent?: boolean;
+    /**
+     * Limit auto-restart attempts
+     * @default Infinity
+     */
     maxRestarts?: number;
+    /** Milliseconds to wait for readyPattern before failing */
     readyTimeout?: number;
+    /** Milliseconds to wait before starting the process */
     delay?: number;
+    /** Env var name (prefix with `!` to negate); process skipped if condition is falsy */
     condition?: string;
+    /** OS(es) this process runs on (e.g. `'darwin'`, `'linux'`). Non-matching processes are removed, their dependents still start */
+    platform?: string | string[];
+    /**
+     * Signal for graceful stop
+     * @default 'SIGTERM'
+     */
     stopSignal?: 'SIGTERM' | 'SIGINT' | 'SIGHUP';
+    /** Hex color (e.g. `"#ff6600"`) or color name. Array for round-robin in script patterns */
     color?: string | string[];
+    /** Glob patterns — restart process when matching files change */
     watch?: string | string[];
+    /**
+     * When true, keyboard input is forwarded to the process
+     * @default false
+     */
     interactive?: boolean;
+    /** `true` = detect ANSI red output, string = regex pattern */
     errorMatcher?: boolean | string;
+    /**
+     * Print the command being run as the first line of output
+     * @default true
+     */
     showCommand?: boolean;
 }
 /** Config for npm: wildcard entries — command is derived from package.json scripts */
-export type NumuxScriptPattern = Omit<NumuxProcessConfig, 'command'> & {
+export type NumuxScriptPattern<K extends string = string> = Omit<NumuxProcessConfig<K>, 'command'> & {
     command?: never;
 };
 /** Raw config as authored — processes can be string shorthand, full objects, or wildcard patterns */
-export interface NumuxConfig {
+export interface NumuxConfig<K extends string = string> {
+    /** Global working directory, inherited by all processes */
     cwd?: string;
+    /** Global env vars, merged into each process (process-level overrides) */
     env?: Record<string, string>;
+    /** Global .env file(s), inherited by processes without their own envFile; `false` disables */
     envFile?: string | string[] | false;
+    /**
+     * Global showCommand flag, inherited by all processes
+     * @default true
+     */
     showCommand?: boolean;
-    processes: Record<string, NumuxProcessConfig | NumuxScriptPattern | string>;
+    processes: Record<K, NumuxProcessConfig<K> | NumuxScriptPattern<K> | string>;
+}
+/** Process config after validation — dependsOn is always normalized to an array */
+export interface ResolvedProcessConfig extends Omit<NumuxProcessConfig, 'dependsOn'> {
+    dependsOn?: string[];
 }
 /** Validated config with all shorthand expanded to full objects */
 export interface ResolvedNumuxConfig {
-    processes: Record<string, NumuxProcessConfig>;
+    processes: Record<string, ResolvedProcessConfig>;
 }
 export type ProcessStatus = 'pending' | 'starting' | 'ready' | 'running' | 'stopping' | 'stopped' | 'finished' | 'failed' | 'skipped';
 export interface ProcessState {
     name: string;
-    config: NumuxProcessConfig;
+    config: ResolvedProcessConfig;
     status: ProcessStatus;
     exitCode: number | null;
     restartCount: number;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "numux",
-  "version": "1.18.0",
+  "version": "1.20.0",
   "description": "Terminal multiplexer with dependency orchestration",
   "type": "module",
   "license": "MIT",