scripts-orchestrator 2.15.1 → 3.0.0

package/README.md

@@ -48,12 +48,14 @@ Create a configuration file (default: `scripts-orchestrator.config.js`) that def
 
 ```javascript
 {
-  command: 'command_name',           // The npm script to run
+  command: 'command_name',           // The command to run (see "Command prefix" below)
   description: 'Description',        // Optional description
   status: 'enabled',                 // 'enabled' or 'disabled'
   attempts: 1,                       // Number of retry attempts
   dependencies: [],                 // Array of dependent commands
   background: false,                // Whether to run in background
+  shell: false,                     // true => run `command` verbatim as a shell command (no prefix)
+  prefix: 'npm run',                // Optional per-command prefix override ('' to disable)
   env: {                            // Optional environment variables
     PORT: 3000,
     NODE_ENV: 'production'
@@ -70,6 +72,44 @@ Create a configuration file (default: `scripts-orchestrator.config.js`) that def
 }
 ```
 
+### Command prefix (`npm run` is optional)
+
+By default every `command` is run as an npm script — the orchestrator prepends `npm run`,
+so `command: 'build'` executes `npm run build`. This prefix is configurable:
+
+- **Global default** — set `command_prefix` at the top level of the config. Use it to point at a
+  different runner (`'pnpm run'`, `'yarn'`) or to disable prefixing entirely so commands run as
+  regular shell commands:
+
+  ```javascript
+  export default {
+    command_prefix: '',              // '' / false / null => run commands verbatim (plain shell)
+    phases: [
+      { name: 'checks', parallel: [
+        { command: 'eslint . --max-warnings 0' },   // runs as-is, supports args/pipes/&&
+        { command: './scripts/verify.sh' },
+      ]},
+    ],
+  };
+  ```
+
+- **Per command** — `shell: true` forces a single command to run verbatim as a shell command
+  (ignoring any global prefix), and `prefix: '...'` overrides the prefix for just that command:
+
+  ```javascript
+  {
+    phases: [{ name: 'mixed', parallel: [
+      { command: 'build' },                          // -> npm run build (global default)
+      { command: 'docker compose up -d', shell: true }, // raw shell command
+      { command: 'release', prefix: 'yarn' },        // -> yarn release
+    ]}],
+  }
+  ```
+
+Precedence per command: `shell: true` (raw) → per-command `prefix` → global `command_prefix`
+→ the built-in `npm run` default. Existing configs are unaffected — omitting all of these keeps
+the original `npm run` behaviour.
+
 ### Phase Configuration
 
 When using the phases format, each phase can have the following properties:

package/lib/orchestrator.js

@@ -27,6 +27,12 @@ export class Orchestrator {
     this.sequential = sequential;
     this.force = force;
     this.metrics = Array.isArray(metrics) ? metrics : [];
+    // Global command prefix. Defaults to 'npm run' so existing configs keep working.
+    // Set `command_prefix` to '' / false / null in the config to run commands verbatim
+    // as regular shell commands. Per-command `shell: true` or `prefix` overrides this.
+    this.commandPrefix = Object.prototype.hasOwnProperty.call(config ?? {}, 'command_prefix')
+      ? this._normalizePrefix(config.command_prefix)
+      : 'npm run';
     this.jsonResultsPath = jsonResultsPath ?? null;
     this.htmlResultsPath = htmlResultsPath ?? null;
     this.processManager = processManager;
@@ -263,6 +269,29 @@ export class Orchestrator {
     }
   }
 
+  // Normalize a prefix value into a clean string. false/null/'' all mean "no prefix"
+  // (run the command verbatim); any string is trimmed.
+  _normalizePrefix(value) {
+    if (value === false || value === null || value === undefined) return '';
+    return String(value).trim();
+  }
+
+  // Resolve the effective prefix for a single command.
+  // Precedence: per-command `shell: true` (raw) > per-command `prefix` > global commandPrefix.
+  _resolvePrefix(commandConfig = {}) {
+    if (commandConfig.shell === true) return '';
+    if (Object.prototype.hasOwnProperty.call(commandConfig, 'prefix')) {
+      return this._normalizePrefix(commandConfig.prefix);
+    }
+    return this.commandPrefix;
+  }
+
+  // Format a command for display, honoring its resolved prefix.
+  _displayCommand(command, commandConfig = {}) {
+    const prefix = this._resolvePrefix(commandConfig);
+    return prefix ? `${prefix} ${command}` : command;
+  }
+
   async executeCommand(commandConfig, visited = new Set(), phaseName = null) {
     const {
       command,
@@ -281,6 +310,8 @@ export class Orchestrator {
     } = commandConfig;
 
     const startTime = Date.now();
+    // Effective invocation prefix for this command ('' => run verbatim as a shell command).
+    const prefix = this._resolvePrefix(commandConfig);
 
     // Record the destination log file for this command (honors per-command override).
     // Done early so even disabled/skipped commands report where output would land.
@@ -303,7 +334,7 @@ export class Orchestrator {
 
     // Skip execution if the command is disabled
     if (status === 'disabled') {
-      this.logger.warn(`Skipping: npm run ${command} (status: disabled)`);
+      this.logger.warn(`Skipping: ${this._displayCommand(command, commandConfig)} (status: disabled)`);
       this.skippedCommands.push(command);
       this.skipReasons.set(command, 'disabled');
       setTiming(Date.now() - startTime);
@@ -336,6 +367,7 @@ export class Orchestrator {
           startedByScript: false,
           process_tracking,
           kill_command,
+          prefix,
         });
         setTiming(Date.now() - startTime);
         visited.delete(command);
@@ -411,6 +443,7 @@ export class Orchestrator {
         env,
         reportTime: this.metrics.includes('time'),
         reportMemory: this.metrics.includes('memory'),
+        prefix,
       });
       lastRunResult = runResult;
       const { success, output } = runResult;

package/lib/orchestrator.prefix.test.js

@@ -0,0 +1,60 @@
+import { Orchestrator } from './orchestrator.js';
+
+const baseConfig = (extra = {}) => ({
+  phases: [{ name: 'p', parallel: [{ command: 'build' }] }],
+  ...extra,
+});
+
+describe('Orchestrator command prefix resolution', () => {
+  test('defaults to "npm run" when no command_prefix is configured', () => {
+    const orch = new Orchestrator(baseConfig());
+    expect(orch.commandPrefix).toBe('npm run');
+    expect(orch._resolvePrefix({ command: 'build' })).toBe('npm run');
+    expect(orch._displayCommand('build', { command: 'build' })).toBe('npm run build');
+  });
+
+  test('global command_prefix can be disabled with empty string', () => {
+    const orch = new Orchestrator(baseConfig({ command_prefix: '' }));
+    expect(orch.commandPrefix).toBe('');
+    expect(orch._resolvePrefix({ command: 'ls -la' })).toBe('');
+    expect(orch._displayCommand('ls -la', { command: 'ls -la' })).toBe('ls -la');
+  });
+
+  test('global command_prefix can be disabled with false or null', () => {
+    expect(new Orchestrator(baseConfig({ command_prefix: false })).commandPrefix).toBe('');
+    expect(new Orchestrator(baseConfig({ command_prefix: null })).commandPrefix).toBe('');
+  });
+
+  test('global command_prefix can be set to a custom runner', () => {
+    const orch = new Orchestrator(baseConfig({ command_prefix: 'pnpm run' }));
+    expect(orch._resolvePrefix({ command: 'build' })).toBe('pnpm run');
+    expect(orch._displayCommand('build', { command: 'build' })).toBe('pnpm run build');
+  });
+
+  test('per-command shell:true runs verbatim as a bash command (overrides global)', () => {
+    const orch = new Orchestrator(baseConfig({ command_prefix: 'npm run' }));
+    const cmd = { command: 'echo hello && ls', shell: true };
+    expect(orch._resolvePrefix(cmd)).toBe('');
+    expect(orch._displayCommand('echo hello && ls', cmd)).toBe('echo hello && ls');
+  });
+
+  test('per-command prefix string overrides the global prefix', () => {
+    const orch = new Orchestrator(baseConfig({ command_prefix: 'npm run' }));
+    const cmd = { command: 'build', prefix: 'yarn' };
+    expect(orch._resolvePrefix(cmd)).toBe('yarn');
+    expect(orch._displayCommand('build', cmd)).toBe('yarn build');
+  });
+
+  test('per-command empty prefix runs verbatim even when global prefix is set', () => {
+    const orch = new Orchestrator(baseConfig({ command_prefix: 'npm run' }));
+    const cmd = { command: 'make build', prefix: '' };
+    expect(orch._resolvePrefix(cmd)).toBe('');
+    expect(orch._displayCommand('make build', cmd)).toBe('make build');
+  });
+
+  test('shell:true takes precedence over an explicit prefix', () => {
+    const orch = new Orchestrator(baseConfig());
+    const cmd = { command: 'echo hi', shell: true, prefix: 'yarn' };
+    expect(orch._resolvePrefix(cmd)).toBe('');
+  });
+});

package/lib/process-manager.js

@@ -46,6 +46,7 @@ export class ProcessManager {
     startedByScript,
     process_tracking,
     kill_command,
+    prefix = 'npm run',
   }) {
     this.logger.verbose(`Adding background process: ${command} (${url})`);
     this.backgroundProcessesDetails.push({
@@ -54,6 +55,7 @@ export class ProcessManager {
       startedByScript,
       process_tracking,
       kill_command,
+      prefix,
     });
   }
 
@@ -93,7 +95,13 @@ export class ProcessManager {
     env = null,
     reportTime = false,
     reportMemory = false,
+    prefix = 'npm run',
   }) {
+    // Resolve how the command is invoked. A non-empty prefix (e.g. 'npm run') is
+    // prepended to the command name; an empty/false prefix runs the command verbatim
+    // as a regular shell command. `displayCmd` is what we surface in logs.
+    const commandPrefix = prefix ? String(prefix).trim() : '';
+    const displayCmd = commandPrefix ? `${commandPrefix} ${cmd}` : cmd;
     const baseDir = this.logFolder
       ? path.resolve(this.logFolder)
       : process.cwd();
@@ -131,12 +139,12 @@ export class ProcessManager {
       const startTime = Date.now();
       let timeOutputPath = null;
       // Build command with environment variables if provided
-      let fullCommand = `npm run ${cmd}`;
+      let fullCommand = displayCmd;
       if (env && Object.keys(env).length > 0) {
         const envStr = Object.entries(env)
           .map(([key, value]) => `${key}=${value}`)
           .join(' ');
-        fullCommand = `${envStr} npm run ${cmd}`;
+        fullCommand = `${envStr} ${displayCmd}`;
       }
       const useTimeWrapper =
         reportMemory && !background && (process.platform === 'linux' || process.platform === 'darwin');
@@ -286,6 +294,7 @@ export class ProcessManager {
                   url: healthCheck?.url,
                   startedByScript: true,
                   kill_command,
+                  prefix: commandPrefix,
                 });
 
                 this.logger.verbose(`Unreferencing process ${processGroupId}`);
@@ -293,7 +302,7 @@ export class ProcessManager {
 
                 this.logger.stopTask(cmd);
                 this.logger.verbose(
-                  `Background process started: npm run ${cmd} (PGID: ${processGroupId})`,
+                  `Background process started: ${displayCmd} (PGID: ${processGroupId})`,
                 );
                 return {
                   success: true,
@@ -304,7 +313,7 @@ export class ProcessManager {
               } catch (error) {
                 if (attempt === maxAttempts) {
                   this.logger.error(
-                    `Failed to start background process: npm run ${cmd}`,
+                    `Failed to start background process: ${displayCmd}`,
                   );
                   this.logger.verbose(
                     `Final verification attempt failed: ${error.message}`,
@@ -382,7 +391,7 @@ export class ProcessManager {
 
             if (code !== 0) {
               this.logger.error(
-                `Failed: npm run ${cmd} ❌${durationStr} (exit code: ${code})`,
+                `Failed: ${displayCmd} ❌${durationStr} (exit code: ${code})`,
               );
               this.logger.verbose(`Process output: ${output}`);
               resolve({
@@ -392,7 +401,7 @@ export class ProcessManager {
                 memoryKb,
               });
             } else {
-              this.logger.success(`Completed: npm run ${cmd} ✅${durationStr}`);
+              this.logger.success(`Completed: ${displayCmd} ✅${durationStr}`);
               resolve({
                 success: true,
                 output,
@@ -507,13 +516,14 @@ export class ProcessManager {
     );
 
     const killPromises = commandProcesses.map(
-      async ({ command, pgid, url, startedByScript, kill_command }) => {
+      async ({ command, pgid, url, startedByScript, kill_command, prefix }) => {
         await this.cleanupProcess({
           command,
           pgid,
           url,
           startedByScript,
           kill_command,
+          prefix,
         });
       },
     );
@@ -529,7 +539,7 @@ export class ProcessManager {
     );
   }
 
-  async cleanupProcess({ command, pgid, url, startedByScript, kill_command }) {
+  async cleanupProcess({ command, pgid, url, startedByScript, kill_command, prefix = 'npm run' }) {
     if (!startedByScript) {
       this.logger.verbose(
         `- Skipping cleanup for ${command} (${url}) as it was not started by this script`,
@@ -544,13 +554,15 @@ export class ProcessManager {
     // Try custom kill command first if specified
     if (kill_command) {
       try {
+        const killDisplay = prefix ? `${String(prefix).trim()} ${kill_command}` : kill_command;
         this.logger.verbose(
-          `- Using custom kill command: npm run ${kill_command}`,
+          `- Using custom kill command: ${killDisplay}`,
         );
         const result = await this.runCommand({
           cmd: kill_command,
           logFile: null,
           background: false,
+          prefix,
         });
         if (result.success) {
           this.logger.verbose(

package/lib/process-manager.test.js

@@ -1,4 +1,6 @@
 import path from 'path';
+import fs from 'fs';
+import os from 'os';
 import { ProcessManager } from './process-manager.js';
 
 describe('ProcessManager.getLogPath', () => {
@@ -20,3 +22,59 @@ describe('ProcessManager.getLogPath', () => {
     expect(result).toBe(path.resolve(override));
   });
 });
+
+describe('ProcessManager.runCommand prefix handling', () => {
+  let tmpDir;
+  let prevCwd;
+
+  beforeEach(() => {
+    tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), 'so-prefix-'));
+    prevCwd = process.cwd();
+    process.chdir(tmpDir);
+  });
+
+  afterEach(() => {
+    process.chdir(prevCwd);
+    fs.rmSync(tmpDir, { recursive: true, force: true });
+  });
+
+  test('runs a regular bash command verbatim when prefix is disabled', async () => {
+    const pm = new ProcessManager();
+    pm.setLogFolder(tmpDir);
+    const marker = 'orchestrator-raw-bash-ok';
+    const result = await pm.runCommand({
+      cmd: `echo ${marker}`,
+      background: false,
+      prefix: '',
+    });
+    expect(result.success).toBe(true);
+    const logPath = pm.getLogPath(`echo ${marker}`);
+    expect(fs.readFileSync(logPath, 'utf8')).toContain(marker);
+  });
+
+  test('honors a custom prefix by invoking it (failure surfaces a non-zero exit)', async () => {
+    const pm = new ProcessManager();
+    pm.setLogFolder(tmpDir);
+    // With prefix 'npm run' and no package.json script, the command must fail —
+    // proving the prefix is actually prepended rather than the command run raw.
+    const result = await pm.runCommand({
+      cmd: 'definitely-not-a-script',
+      background: false,
+      prefix: 'npm run',
+    });
+    expect(result.success).toBe(false);
+  });
+
+  test('supports multi-token shell commands (pipes, &&) when run raw', async () => {
+    const pm = new ProcessManager();
+    pm.setLogFolder(tmpDir);
+    const result = await pm.runCommand({
+      cmd: 'printf "a\\nb\\nc\\n" | grep b',
+      background: false,
+      prefix: '',
+    });
+    expect(result.success).toBe(true);
+    const logPath = pm.getLogPath('printf');
+    expect(fs.readFileSync(logPath, 'utf8').trim()).toBe('b');
+  });
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "scripts-orchestrator",
-  "version": "2.15.1",
+  "version": "3.0.0",
   "description": "A powerful script orchestrator for running parallel commands with dependency management, background processes, and health checks",
   "main": "lib/index.js",
   "type": "module",

package/scripts-orchestrator.config.js

@@ -1,4 +1,8 @@
 export default {
+  // Optional: prefix prepended to every command. Defaults to 'npm run'.
+  // Set to '' (or false/null) to run commands verbatim as regular shell commands,
+  // or to another runner like 'pnpm run'. Per-command `shell: true` / `prefix` override this.
+  // command_prefix: 'npm run',
   // Optional: metrics to report (time, memory). CLI --metrics overrides.
   // metrics: ['time'],
   // Optional: path for JSON results, or '-' for stdout. CLI --json-results overrides.