rman 1.3.0 → 2.0.0-beta.3

package/commands/run.command.d.ts

@@ -1,6 +1,186 @@
-import type { Argv } from 'yargs';
-import type { Repository } from '../core/repository.js';
-import { RunService } from '../services/run.service.js';
-export declare function applyRunOptions<T>(cmd: Argv<T>): Argv<T>;
-export declare function readRunOptions(args: any): RunService.Options;
-export declare function initCli(repository: Repository, program: Argv): void;
+import { type RmanConfig } from '../interfaces/rman-config.interface.js';
+declare const COMMAND: "run <script>";
+declare const config: {
+    parallel: {
+        target: "cli";
+        describe: string;
+        coerce: (v: unknown) => boolean | number | undefined;
+    };
+    bail: {
+        target: "cli";
+        describe: string;
+        type: "boolean";
+    };
+    topo: {
+        target: "cli";
+        describe: string;
+        type: "boolean";
+    };
+    progress: {
+        target: "cli";
+        describe: string;
+        type: "boolean";
+    };
+    changed: {
+        target: "cli";
+        alias: string;
+        describe: string;
+        type: "boolean";
+    };
+    changedSince: {
+        target: "cli";
+        cliName: string;
+        describe: string;
+        type: "string";
+        conflicts: string;
+    };
+    fromRoot: {
+        target: "cli";
+        cliName: string;
+        alias: string;
+        describe: string;
+        type: "boolean";
+    };
+    allowBranch: {
+        target: "cli";
+        cliName: string;
+        describe: string;
+        type: "string";
+    };
+    ignoreBranch: {
+        target: "cli";
+        cliName: string;
+        describe: string;
+        type: "string";
+    };
+    scope: {
+        target: "cli";
+        describe: string;
+        type: "string";
+    };
+    ignore: {
+        target: "cli";
+        describe: string;
+        type: "string";
+    };
+    platform: {
+        target: "cli";
+        describe: string;
+        type: "string";
+    };
+    deps: {
+        target: "cli";
+        describe: string;
+        type: "boolean";
+    };
+    dependents: {
+        target: "cli";
+        describe: string;
+        type: "boolean";
+    };
+};
+type Args = RmanConfig.ArgsOf<typeof config, typeof COMMAND>;
+declare const runCommand: (app: import("../index.js").RmanApplication) => {
+    command: "run <script>";
+    describe: string;
+    /**
+     * The one command whose `--config` keys depend on argv: the script's own block, whichever script
+     * was asked for. Read, not owned - `run.<script>.*` is keyed by script name, so it is the one
+     * config shape a flat option map cannot describe and it stays hand-written in `RmanConfig`.
+     */
+    configKeys: (args: any) => string[];
+    config: {
+        parallel: {
+            target: "cli";
+            describe: string;
+            coerce: (v: unknown) => boolean | number | undefined;
+        };
+        bail: {
+            target: "cli";
+            describe: string;
+            type: "boolean";
+        };
+        topo: {
+            target: "cli";
+            describe: string;
+            type: "boolean";
+        };
+        progress: {
+            target: "cli";
+            describe: string;
+            type: "boolean";
+        };
+        changed: {
+            target: "cli";
+            alias: string;
+            describe: string;
+            type: "boolean";
+        };
+        changedSince: {
+            target: "cli";
+            cliName: string;
+            describe: string;
+            type: "string";
+            conflicts: string;
+        };
+        fromRoot: {
+            target: "cli";
+            cliName: string;
+            alias: string;
+            describe: string;
+            type: "boolean";
+        };
+        allowBranch: {
+            target: "cli";
+            cliName: string;
+            describe: string;
+            type: "string";
+        };
+        ignoreBranch: {
+            target: "cli";
+            cliName: string;
+            describe: string;
+            type: "string";
+        };
+        scope: {
+            target: "cli";
+            describe: string;
+            type: "string";
+        };
+        ignore: {
+            target: "cli";
+            describe: string;
+            type: "string";
+        };
+        platform: {
+            target: "cli";
+            describe: string;
+            type: "string";
+        };
+        deps: {
+            target: "cli";
+            describe: string;
+            type: "boolean";
+        };
+        dependents: {
+            target: "cli";
+            describe: string;
+            type: "boolean";
+        };
+    };
+    positionals: {
+        script: {
+            describe: string;
+            type: "string";
+        };
+    };
+    examples: ({
+        command: string;
+        description?: undefined;
+    } | {
+        command: string;
+        description: string;
+    })[];
+    handler: (args: Args) => Promise<void>;
+};
+export default runCommand;

package/commands/run.command.js

@@ -1,77 +1,31 @@
-import { RunService } from '../services/run.service.js';
-import { applyBranchGuardOptions, assertAllowedBranch, readBranchGuardOptions } from '../utils/branch-guard.js';
-import { applyPackageFilterOptions, applyRootOption, readPackageFilterOptions } from '../utils/package-filter.js';
-export function applyRunOptions(cmd) {
-    return applyRootOption(applyBranchGuardOptions(applyPackageFilterOptions(cmd)), 'Run')
-        .option('parallel', {
-        describe: 'Max packages to build at once: omit/true for CPU count (or .rmanrc run.<script>.concurrency), ' +
-            'a number for that many, false to run serially. Packages always build in dependency order.',
-        coerce: (v) => {
-            if (v === undefined)
-                return undefined;
-            if (v === 'false' || v === false)
-                return false;
-            if (v === 'true' || v === true)
-                return true;
-            const n = Number(v);
-            return Number.isFinite(n) ? n : true;
-        },
-    })
-        .option('bail', {
-        describe: 'Stop on first failure (default: true, overridable per-package via .rmanrc run.<script>.bail)',
-        type: 'boolean',
-    })
-        .option('topo', {
-        describe: 'Respect package dependency order: a package waits for its dependencies and is skipped if one ' +
-            'fails. Set false for independent scripts (e.g. lint/test) - order becomes alphabetical and ' +
-            'failures never skip other packages. Default: true, overridable per-package via .rmanrc run.<script>.topo.',
-        type: 'boolean',
-    })
-        .option('progress', {
-        describe: 'Show a live progress panel (default: true; auto-disabled when not a TTY; .rmanrc run.<script>.progress)',
-        type: 'boolean',
-    })
-        .option('changed', {
-        alias: 'c',
-        describe: 'Only run in packages that have changed since the last publish',
-        type: 'boolean',
-    })
-        .option('changed-since', {
-        describe: 'Only run in packages that have changed since the given git commit/hash',
-        type: 'string',
-    })
-        .conflicts('changed', 'changed-since');
-}
-export function readRunOptions(args) {
+import { registerCommand } from '../interfaces/rman-config.interface.js';
+import { assertAllowedBranch, readBranchGuardOptions } from '../utils/branch-guard.js';
+import { readRunOptions, runOptions } from '../utils/run-options.js';
+const COMMAND = 'run <script>';
+const config = runOptions;
+const runCommand = registerCommand(app => {
+    const repository = app.repository;
     return {
-        ...readPackageFilterOptions(args),
-        parallel: args.parallel,
-        topo: args.topo,
-        bail: args.bail,
-        progress: args.progress,
-        changed: args.changed,
-        changedSince: args.changedSince,
-        logLevel: args.logLevel,
-        root: args.root,
-    };
-}
-export function initCli(repository, program) {
-    program.command({
-        command: 'run <script>',
-        /** Which `.rmanrc` `--config` shows for this command: the script's own block, whichever
-         *  script was asked for. */
-        configKeys: (args) => ['run.' + args.script],
+        command: COMMAND,
         describe: 'Run an npm script in each package',
-        builder: cmd => applyRunOptions(cmd)
-            .example('$0 run build', '')
-            .example('$0 run build --changed', '# Only in packages changed since the last publish')
-            .positional('script', {
-            describe: 'The script to run',
-            type: 'string',
-        }),
+        /**
+         * The one command whose `--config` keys depend on argv: the script's own block, whichever script
+         * was asked for. Read, not owned - `run.<script>.*` is keyed by script name, so it is the one
+         * config shape a flat option map cannot describe and it stays hand-written in `RmanConfig`.
+         */
+        configKeys: (args) => ['run.' + args.script],
+        config,
+        positionals: {
+            script: { describe: 'The script to run', type: 'string' },
+        },
+        examples: [
+            { command: '$0 run build' },
+            { command: '$0 run build --changed', description: '# Only in packages you have touched but not pushed' },
+        ],
         handler: async (args) => {
             await assertAllowedBranch(repository, readBranchGuardOptions(args));
-            await RunService.runScript(repository, args.script, { ...readRunOptions(args), commandName: 'run' });
+            await app.getService('run').runScript(args.script, { ...readRunOptions(args), commandName: 'run' });
         },
-    });
-}
+    };
+});
+export default runCommand;

package/commands/test.command.d.ts

@@ -1,3 +1,173 @@
-import type { Argv } from 'yargs';
-import type { Repository } from '../core/repository.js';
-export declare function initCli(repository: Repository, program: Argv): void;
+import { type RmanConfig } from '../interfaces/rman-config.interface.js';
+declare const COMMAND: "test";
+declare const config: {
+    parallel: {
+        target: "cli";
+        describe: string;
+        coerce: (v: unknown) => boolean | number | undefined;
+    };
+    bail: {
+        target: "cli";
+        describe: string;
+        type: "boolean";
+    };
+    topo: {
+        target: "cli";
+        describe: string;
+        type: "boolean";
+    };
+    progress: {
+        target: "cli";
+        describe: string;
+        type: "boolean";
+    };
+    changed: {
+        target: "cli";
+        alias: string;
+        describe: string;
+        type: "boolean";
+    };
+    changedSince: {
+        target: "cli";
+        cliName: string;
+        describe: string;
+        type: "string";
+        conflicts: string;
+    };
+    fromRoot: {
+        target: "cli";
+        cliName: string;
+        alias: string;
+        describe: string;
+        type: "boolean";
+    };
+    allowBranch: {
+        target: "cli";
+        cliName: string;
+        describe: string;
+        type: "string";
+    };
+    ignoreBranch: {
+        target: "cli";
+        cliName: string;
+        describe: string;
+        type: "string";
+    };
+    scope: {
+        target: "cli";
+        describe: string;
+        type: "string";
+    };
+    ignore: {
+        target: "cli";
+        describe: string;
+        type: "string";
+    };
+    platform: {
+        target: "cli";
+        describe: string;
+        type: "string";
+    };
+    deps: {
+        target: "cli";
+        describe: string;
+        type: "boolean";
+    };
+    dependents: {
+        target: "cli";
+        describe: string;
+        type: "boolean";
+    };
+};
+type Args = RmanConfig.ArgsOf<typeof config, typeof COMMAND>;
+declare const testCommand: (app: import("../index.js").RmanApplication) => {
+    command: "test";
+    describe: string;
+    /** Owns nothing, for the same reason `build` does not - see there. */
+    configKeys: string[];
+    config: {
+        parallel: {
+            target: "cli";
+            describe: string;
+            coerce: (v: unknown) => boolean | number | undefined;
+        };
+        bail: {
+            target: "cli";
+            describe: string;
+            type: "boolean";
+        };
+        topo: {
+            target: "cli";
+            describe: string;
+            type: "boolean";
+        };
+        progress: {
+            target: "cli";
+            describe: string;
+            type: "boolean";
+        };
+        changed: {
+            target: "cli";
+            alias: string;
+            describe: string;
+            type: "boolean";
+        };
+        changedSince: {
+            target: "cli";
+            cliName: string;
+            describe: string;
+            type: "string";
+            conflicts: string;
+        };
+        fromRoot: {
+            target: "cli";
+            cliName: string;
+            alias: string;
+            describe: string;
+            type: "boolean";
+        };
+        allowBranch: {
+            target: "cli";
+            cliName: string;
+            describe: string;
+            type: "string";
+        };
+        ignoreBranch: {
+            target: "cli";
+            cliName: string;
+            describe: string;
+            type: "string";
+        };
+        scope: {
+            target: "cli";
+            describe: string;
+            type: "string";
+        };
+        ignore: {
+            target: "cli";
+            describe: string;
+            type: "string";
+        };
+        platform: {
+            target: "cli";
+            describe: string;
+            type: "string";
+        };
+        deps: {
+            target: "cli";
+            describe: string;
+            type: "boolean";
+        };
+        dependents: {
+            target: "cli";
+            describe: string;
+            type: "boolean";
+        };
+    };
+    examples: {
+        command: string;
+        description: string;
+    }[];
+    handler: (args: Args) => Promise<void>;
+};
+export default testCommand;

package/commands/test.command.js

@@ -1,15 +1,21 @@
-import { RunService } from '../services/run.service.js';
+import { registerCommand } from '../interfaces/rman-config.interface.js';
 import { assertAllowedBranch, readBranchGuardOptions } from '../utils/branch-guard.js';
-import { applyRunOptions, readRunOptions } from './run.command.js';
-export function initCli(repository, program) {
-    program.command({
-        command: 'test',
-        configKeys: ['run.test'],
+import { readRunOptions, runOptions } from '../utils/run-options.js';
+const COMMAND = 'test';
+const config = runOptions;
+const testCommand = registerCommand(app => {
+    const repository = app.repository;
+    return {
+        command: COMMAND,
         describe: 'Alias for "run test"',
-        builder: cmd => applyRunOptions(cmd).example('$0 test', '# Tests packages'),
+        /** Owns nothing, for the same reason `build` does not - see there. */
+        configKeys: ['run.test'],
+        config,
+        examples: [{ command: '$0 test', description: '# Tests packages' }],
         handler: async (args) => {
             await assertAllowedBranch(repository, readBranchGuardOptions(args));
-            await RunService.runScript(repository, 'test', { ...readRunOptions(args), commandName: 'test' });
+            await app.getService('run').runScript('test', { ...readRunOptions(args), commandName: 'test' });
         },
-    });
-}
+    };
+});
+export default testCommand;