rman 2.6.1 → 2.7.0

package/builtins/platforms/node/services/ci.service.js

@@ -72,6 +72,7 @@ export var CiService;
         const progress = options.progress ?? true;
         const panel = new ProgressPanel('CI', !!process.stdout.isTTY && progress);
         const runStartedAt = Date.now();
+        panel.detail = repository.name;
         panel.start(repository.app.statusRegion);
         const items = [];
         let failed = false;
@@ -122,6 +123,9 @@ const LOCK_FILES = ['package-lock.json', 'yarn.lock', 'pnpm-lock.yaml', 'bun.loc
  *  log uses. `logLine` is expected to go through a `Logger` (so it respects `--log-level`), not a
  *  raw `console.log`. */
 async function runStep(app, item, panelEnabled, cwd, command, logLine) {
+    /** **Set here rather than at each of the three call sites**, which is also what keeps `wipe` out
+     *  of it: a wipe runs no command, and this is the one place a `ci` step has one. */
+    item.currentCommand = command;
     if (panelEnabled) {
         await exec(command, {
             app,

package/builtins/platforms/node/services/clean.service.js

@@ -53,6 +53,7 @@ export var CleanService;
         const progress = options.progress ?? true;
         const logger = new Logger(options.logLevel ?? resolveRootLogLevel(repository));
         const panel = new ProgressPanel(dryRun ? 'CLEAN (dry-run)' : 'CLEAN', !!process.stdout.isTTY && progress);
+        panel.detail = repository.name;
         panel.start(repository.app.statusRegion);
         let failed = false;
         try {

package/commands/changelog.command.js

@@ -225,6 +225,7 @@ const changelogCommand = registerCommand(app => {
                 progress: panelReporter(panel),
             };
             const changelog = app.getService('changelog');
+            panel.detail = repository.name;
             panel.start(app.statusRegion);
             let entries;
             try {

package/constants.js

@@ -1 +1 @@
-export const version = '2.6.1';
+export const version = '2.7.0';

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "rman",
   "description": "Repository manager",
-  "version": "2.6.1",
+  "version": "2.7.0",
   "author": "Panates",
   "license": "MIT",
   "dependencies": {

package/services/exec.service.js

@@ -52,9 +52,14 @@ export class ExecService extends Service {
         const names = new Set(packages.map(p => p.name));
         const children = packages.map(pkg => {
             const ctx = panel.addItem(pkg.name);
+            /** One command for every package and it never changes, so it is set once here rather than
+             *  threaded into `execForPackage` - the row is the only thing that was not saying what `exec`
+             *  is actually running. */
+            ctx.currentCommand = command;
             const dependencies = topo ? pkg.dependencies.filter(d => names.has(d.name)).map(d => d.name) : [];
             return new Task(() => execForPackage(this.app, ctx, panel.enabled, pkg.dirname, command, logger, bail ? () => rootTask?.abort() : () => { }), { name: pkg.name, dependencies });
         });
+        panel.detail = repository.name;
         panel.start(repository.app.statusRegion);
         let failed = false;
         try {

package/services/run.service.d.ts

@@ -168,7 +168,11 @@ export declare namespace RunService {
      * differently, which is how `version.<slot>` came to join its array with `' && '`.
      */
     export function normalizeScriptValue(value: unknown, at: string): RunStepValue[];
-    export function createStepContext(pkg: Package, cwd: string): RunStepContext;
+    /**
+     * `onCommand` is told what the step is spawning, for as long as it runs - the argv while a child
+     * is up, `undefined` when it returns.
+     */
+    export function createStepContext(pkg: Package, cwd: string, onCommand?: (command: string | undefined) => void): RunStepContext;
     /**
      * `.rmanrc` conditional execution, GitHub Actions-`if`-flavored but a small closed grammar
      * instead of a full expression language (less to get wrong, still covers what's asked for) -

package/services/run.service.js

@@ -66,7 +66,13 @@ export class RunService extends Service {
                      *  does not distinguish a JS step from a shell one. `step.label` is not used directly
                      *  because for a function it already folds the slot in (`before (js)`), which the row
                      *  prints two characters to its left. */
-                    ctx.currentCommand = step.command ?? (step.run?.name ? `${step.run.name}()` : '(js function)');
+                    const stepLabel = step.command ?? (step.run?.name ? `${step.run.name}()` : '(js function)');
+                    ctx.currentCommand = stepLabel;
+                    /** A function step names itself until it spawns something, and takes its name back when
+                     *  that returns - so the row says `tsc -b tsconfig.json` for as long as tsc is up. */
+                    const onCommand = (command) => {
+                        ctx.currentCommand = command ?? stepLabel;
+                    };
                     ctx.stepIndex = i;
                     if (panel.enabled) {
                         const onLine = (line) => {
@@ -74,7 +80,7 @@ export class RunService extends Service {
                             ctx.lastLine = line;
                         };
                         if (step.run)
-                            await runFunctionStep(step.run, pkg, cwd, onLine);
+                            await runFunctionStep(step.run, pkg, cwd, onLine, onCommand);
                         else
                             await exec(step.command, { cwd, stdio: 'pipe', onLine, app: pkg.repository.app });
                     }
@@ -88,7 +94,7 @@ export class RunService extends Service {
                             /** No capture with the panel off: the step owns the terminal, exactly as a shell
                              *  step's `stdio: 'inherit'` does. */
                             if (step.run)
-                                await runFunctionStep(step.run, pkg, cwd);
+                                await runFunctionStep(step.run, pkg, cwd, undefined, onCommand);
                             else
                                 await exec(step.command, { cwd, stdio: 'inherit', app: pkg.repository.app });
                         }
@@ -228,6 +234,7 @@ export class RunService extends Service {
             err.logged = true;
             throw err;
         }
+        panel.detail = repository.name;
         panel.start(repository.app.statusRegion);
         try {
             /** bail:false here - each package's own resolved bail setting decides whether to call
@@ -361,13 +368,31 @@ export class RunService extends Service {
         return steps;
     }
     RunService.normalizeScriptValue = normalizeScriptValue;
-    function createStepContext(pkg, cwd) {
+    /**
+     * `onCommand` is told what the step is spawning, for as long as it runs - the argv while a child
+     * is up, `undefined` when it returns.
+     */
+    /* **Without it a function step can only name itself.** The row showed `buildWithTsc()` for the
+     * whole of a build, because that is all the slot knows; what a reader wants is the `tsc -b
+     * <tsconfig>` it is sitting in. A function step is the shape every shared config uses, so this is
+     * the common case rather than an edge one. */
+    function createStepContext(pkg, cwd, onCommand) {
         const logLevel = resolveRootLogLevel(pkg.repository);
         return {
             pkg,
             repository: pkg.repository,
             cwd,
-            runBin: (bin, argv, opts) => runBin(bin, argv, { cwd, logLevel, app: pkg.repository.app, ...opts }),
+            runBin: async (bin, argv, opts) => {
+                onCommand?.([bin, ...argv].join(' '));
+                try {
+                    return await runBin(bin, argv, { cwd, logLevel, app: pkg.repository.app, ...opts });
+                }
+                finally {
+                    /** Back to whatever the caller had, or a step that spawns once would wear that command
+                     *  for the rest of its run. */
+                    onCommand?.(undefined);
+                }
+            },
             logger: new Logger(logLevel),
         };
     }
@@ -510,8 +535,8 @@ function toStep(slot, value) {
  * the panel on (the step's own log, which is what the panel shows for a failed item), and to
  * stderr with it off, ahead of the `failed` line - the order a shell step already produces.
  */
-async function runFunctionStep(run, pkg, cwd, onLine) {
-    const context = RunService.createStepContext(pkg, cwd);
+async function runFunctionStep(run, pkg, cwd, onLine, onCommand) {
+    const context = RunService.createStepContext(pkg, cwd, onCommand);
     if (!onLine) {
         try {
             await run(context);

package/utils/progress-panel.d.ts

@@ -49,6 +49,12 @@ export declare class ProgressPanel implements TerminalRegion {
     private renderLoop?;
     /** The region this panel took the terminal from, handed back in `stop`. */
     private statusRegion?;
+    /**
+     * What the run is about - the repository name, shown beside the title. Assigned rather than
+     * constructed with, the way a `ProgressItem`'s fields are: it keeps `stream` from needing an
+     * `undefined` placeholder at four of the five call sites.
+     */
+    detail?: string;
     private spinnerFrame;
     private startedAt;
     /**

package/utils/progress-panel.js

@@ -21,6 +21,12 @@ export class ProgressPanel {
     renderLoop;
     /** The region this panel took the terminal from, handed back in `stop`. */
     statusRegion;
+    /**
+     * What the run is about - the repository name, shown beside the title. Assigned rather than
+     * constructed with, the way a `ProgressItem`'s fields are: it keeps `stream` from needing an
+     * `undefined` placeholder at four of the five call sites.
+     */
+    detail;
     spinnerFrame = 0;
     startedAt = 0;
     /**
@@ -111,8 +117,21 @@ export class ProgressPanel {
         const bar = renderProgressBar(filled, total);
         const totalElapsed = formatDuration(Date.now() - this.startedAt);
         const failedText = failedSoFar > 0 ? colors.red.bold(`${failedSoFar} failed`) : colors.gray(`${failedSoFar} failed`);
+        /**
+         * **The header says what is running, because nothing else does any more.** The status line used
+         * to carry `ci opra` beside this panel; it is suspended now so the two stop redrawing over each
+         * other, and suppressing it without moving its content here took the command and the repository
+         * off the screen entirely. The badge already names the command, so what had to move is the
+         * repository.
+         *
+         * **At the right end, where the line has room.** Between the badge and the bar it would push
+         * every column right by the length of a repository name - so the bar, the counts and the clock
+         * would sit at a different place in each repository, and the bar would shift the moment a
+         * panel's detail were set. The tail is empty space in every terminal this fits in.
+         */
+        const detail = this.detail ? `   ${colors.gray(this.detail)}` : '';
         const lines = [
-            `${header} ${bar} ${colors.bold(`${done}/${total}`)}  ${colors.cyan(`${running} running`)}  ${failedText}  ${colors.yellow(totalElapsed)}`,
+            `${header} ${bar} ${colors.bold(`${done}/${total}`)}  ${colors.cyan(`${running} running`)}  ${failedText}  ${colors.yellow(totalElapsed)}${detail}`,
         ];
         const runningList = [...this.items.values()].filter(i => i.status === 'running');
         /** Leave room for the header, a safety margin, and a possible "N more running" line - a
@@ -128,12 +147,19 @@ export class ProgressPanel {
                 : item.currentStep || '';
             /** Measured against the *plain* text: every piece below is wrapped in escape sequences, and
              *  `String.length` counts those, so budgeting on the rendered string wraps a row that fits. */
-            const fixed = `  ${item.name}  ${step}  ${elapsed}`.length;
+            const fixed = `  ${item.name}  ${step}  ${elapsed} | `.length;
             const command = truncate(item.currentCommand ?? '', (process.stdout.columns || 80) - fixed - 2);
+            /**
+             * **The command last, after a `|`, and that is not only layout.** It is the one field with no
+             * bound on its length - a `tsc -b` line carries a path, a `run` step carries whatever the
+             * author wrote - so between the step and the clock it pushed the elapsed time to a different
+             * column on every row, and off the end entirely once a command was long. Everything fixed-width
+             * now reads down a straight edge and the variable part runs off to the right, where `truncate`
+             * cuts it.
+             */
             const group = [
-                `${spinner} ${colors.bold(item.name)}  ${colors.gray(step)}` +
-                    (command ? `  ${colors.cyan(command)}` : '') +
-                    `  ${colors.yellow(elapsed)}`,
+                `${spinner} ${colors.bold(item.name)}  ${colors.gray(step)}  ${colors.yellow(elapsed)}` +
+                    (command ? `  ${colors.gray('|')} ${colors.cyan(command)}` : ''),
             ];
             if (item.lastLine)
                 group.push(`    ${colors.dim(item.lastLine)}`);

package/utils/status-region.d.ts

@@ -55,7 +55,15 @@ export declare class StatusRegion implements TerminalRegion {
      * screen. The answer to *which* region is the forwarding above.
      */
     suspend(takeover?: TerminalRegion): void;
-    /** Takes the terminal back and starts drawing again - a no-op when it was never suspended. */
+    /**
+     * Takes the terminal back - a no-op when it was never suspended.
+     *
+     * **The first frame waits for the timer rather than being drawn now**, which `start` does. A
+     * command is usually seconds from finishing when its panel comes down, and drawing immediately
+     * put one spinner frame on screen between the panel's recap and the result line that replaces it
+     * - a single flash, which is the thing this whole mechanism exists to remove. Anything still
+     * working is drawn 80ms later and nobody waits for it.
+     */
     resume(): void;
     /** Writes `text` without corrupting the block: erase, write, redraw underneath. */
     passThrough(text: string): void;

package/utils/status-region.js

@@ -57,12 +57,26 @@ export class StatusRegion {
         this.timer = undefined;
         this.region.clear();
     }
-    /** Takes the terminal back and starts drawing again - a no-op when it was never suspended. */
+    /**
+     * Takes the terminal back - a no-op when it was never suspended.
+     *
+     * **The first frame waits for the timer rather than being drawn now**, which `start` does. A
+     * command is usually seconds from finishing when its panel comes down, and drawing immediately
+     * put one spinner frame on screen between the panel's recap and the result line that replaces it
+     * - a single flash, which is the thing this whole mechanism exists to remove. Anything still
+     * working is drawn 80ms later and nobody waits for it.
+     */
     resume() {
         if (!this.takeover && this.timer)
             return;
         this.takeover = undefined;
-        this.start();
+        if (!this.region.enabled || this.timer)
+            return;
+        this.timer = setInterval(() => {
+            this.frame++;
+            this.draw();
+        }, FRAME_MS);
+        this.timer.unref();
     }
     /** Writes `text` without corrupting the block: erase, write, redraw underneath. */
     passThrough(text) {