rman 1.3.0 → 2.0.0-beta.2

package/commands/build.command.d.ts

@@ -1,3 +1,177 @@
-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: "build";
+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 buildCommand: (app: import("../index.js").RmanApplication) => {
+    command: "build";
+    describe: string;
+    /**
+     * Read, not owned - and it owns nothing at all. `build` is `run build` under another name, so its
+     * settings live in `run.build`, which belongs to `run`. Two commands cannot contribute under one
+     * top-level key (interface merging is not a deep merge), and this is why they never needed to.
+     */
+    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 buildCommand;

package/commands/build.command.js

@@ -1,15 +1,25 @@
-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: 'build',
-        configKeys: ['run.build'],
+import { readRunOptions, runOptions } from '../utils/run-options.js';
+const COMMAND = 'build';
+const config = runOptions;
+const buildCommand = registerCommand(app => {
+    const repository = app.repository;
+    return {
+        command: COMMAND,
         describe: 'Alias for "run build"',
-        builder: cmd => applyRunOptions(cmd).example('$0 build', '# Builds packages'),
+        /**
+         * Read, not owned - and it owns nothing at all. `build` is `run build` under another name, so its
+         * settings live in `run.build`, which belongs to `run`. Two commands cannot contribute under one
+         * top-level key (interface merging is not a deep merge), and this is why they never needed to.
+         */
+        configKeys: ['run.build'],
+        config,
+        examples: [{ command: '$0 build', description: '# Builds packages' }],
         handler: async (args) => {
             await assertAllowedBranch(repository, readBranchGuardOptions(args));
-            await RunService.runScript(repository, 'build', { ...readRunOptions(args), commandName: 'build' });
+            await app.getService('run').runScript('build', { ...readRunOptions(args), commandName: 'build' });
         },
-    });
-}
+    };
+});
+export default buildCommand;

package/commands/changed.command.d.ts

@@ -1,3 +1,80 @@
-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: "changed";
+declare const config: {
+    json: {
+        target: "cli";
+        alias: string;
+        describe: string;
+        type: "boolean";
+    };
+    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>;
+/** Declares no `target: 'config'` option, so it contributes nothing to `RmanConfig` and writes no
+ *  augmentation - a command that owns no config key simply has none. */
+declare const changedCommand: (app: import("../index.js").RmanApplication) => {
+    command: "changed";
+    describe: string;
+    config: {
+        json: {
+            target: "cli";
+            alias: string;
+            describe: string;
+            type: "boolean";
+        };
+        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;
+    }[];
+    handler: (args: Args) => Promise<void>;
+};
+export default changedCommand;

package/commands/changed.command.js

@@ -1,17 +1,23 @@
 import colors from 'ansi-colors';
+import { registerCommand } from '../interfaces/rman-config.interface.js';
 import { VersionPlanService } from '../services/version-plan.service.js';
-import { applyPackageFilterOptions, readPackageFilterOptions } from '../utils/package-filter.js';
-export function initCli(repository, program) {
-    program.command({
-        command: 'changed',
+import { packageFilterOptions, readPackageFilterOptions } from '../utils/package-filter.js';
+const COMMAND = 'changed';
+const config = {
+    ...packageFilterOptions,
+    json: { target: 'cli', alias: 'j', describe: 'Print output as JSON', type: 'boolean' },
+};
+/** Declares no `target: 'config'` option, so it contributes nothing to `RmanConfig` and writes no
+ *  augmentation - a command that owns no config key simply has none. */
+const changedCommand = registerCommand(app => {
+    const repository = app.repository;
+    return {
+        command: COMMAND,
         describe: 'Shows which packages the next "version" run would bump, without changing anything',
-        builder: cmd => applyPackageFilterOptions(cmd).example('$0 changed', '').example('$0 changed --json', '').option('json', {
-            alias: 'j',
-            describe: 'Print output as JSON',
-            type: 'boolean',
-        }),
+        config,
+        examples: [{ command: '$0 changed' }, { command: '$0 changed --json' }],
         handler: async (args) => {
-            const plan = await VersionPlanService.getPlanner().getPlan(repository, readPackageFilterOptions(args));
+            const plan = await VersionPlanService.getPlanner(app).getPlan(repository, readPackageFilterOptions(args));
             const changed = plan.filter(e => e.status === 'bump');
             if (args.json) {
                 console.log(JSON.stringify(changed.map(e => ({ name: e.package.name, group: e.group, from: e.from, to: e.to, reason: e.reason })), undefined, 2));
@@ -25,5 +31,6 @@ export function initCli(repository, program) {
                 console.log(colors.green('changed'), colors.cyan(e.package.name), colors.gray(`(${e.group})`), e.from, '->', colors.yellow(e.to));
             }
         },
-    });
-}
+    };
+});
+export default changedCommand;

package/commands/changelog.command.d.ts

@@ -1,3 +1,192 @@
-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: "changelog";
+declare const config: {
+    from: {
+        target: "cli";
+        describe: string;
+        type: "string";
+    };
+    write: {
+        target: "cli";
+        describe: string;
+        type: "boolean";
+    };
+    /** The one option here that is also a config key - hence `'both'`, and hence this command
+     *  contributing `changelog.filePath` to `RmanConfig`. */
+    filePath: {
+        target: "both";
+        cliName: string;
+        describe: string;
+        type: "string";
+    };
+    includeSkipped: {
+        target: "cli";
+        cliName: string;
+        describe: string;
+        type: "boolean";
+    };
+    releaseVersion: {
+        target: "cli";
+        cliName: string;
+        describe: string;
+        type: "string";
+    };
+    /**
+     * Config-only, from here down - `.rmanrc "changelog.*"` keys with no reason to be a flag. All
+     * three are plain strings or a string list, so this command needs no `Extra` at all: its whole
+     * config block is derived from what is declared here.
+     */
+    ignoreTypes: {
+        target: "config";
+        describe: string;
+        type: "string";
+        array: true;
+    };
+    template: {
+        target: "config";
+        describe: string;
+        type: "string";
+    };
+    tagPattern: {
+        target: "config";
+        describe: string;
+        type: "string";
+    };
+    fromRoot: {
+        target: "cli";
+        cliName: string;
+        alias: string;
+        describe: string;
+        type: "boolean";
+    };
+    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 changelogCommand: (app: import("../index.js").RmanApplication) => {
+    command: "changelog";
+    describe: string;
+    /** Read, not owned: `publish.skip` is `publish`'s key, reused here on purpose - a package that is
+     *  never distributed gets no release notes either. */
+    configKeys: string[];
+    config: {
+        from: {
+            target: "cli";
+            describe: string;
+            type: "string";
+        };
+        write: {
+            target: "cli";
+            describe: string;
+            type: "boolean";
+        };
+        /** The one option here that is also a config key - hence `'both'`, and hence this command
+         *  contributing `changelog.filePath` to `RmanConfig`. */
+        filePath: {
+            target: "both";
+            cliName: string;
+            describe: string;
+            type: "string";
+        };
+        includeSkipped: {
+            target: "cli";
+            cliName: string;
+            describe: string;
+            type: "boolean";
+        };
+        releaseVersion: {
+            target: "cli";
+            cliName: string;
+            describe: string;
+            type: "string";
+        };
+        /**
+         * Config-only, from here down - `.rmanrc "changelog.*"` keys with no reason to be a flag. All
+         * three are plain strings or a string list, so this command needs no `Extra` at all: its whole
+         * config block is derived from what is declared here.
+         */
+        ignoreTypes: {
+            target: "config";
+            describe: string;
+            type: "string";
+            array: true;
+        };
+        template: {
+            target: "config";
+            describe: string;
+            type: "string";
+        };
+        tagPattern: {
+            target: "config";
+            describe: string;
+            type: "string";
+        };
+        fromRoot: {
+            target: "cli";
+            cliName: string;
+            alias: string;
+            describe: string;
+            type: "boolean";
+        };
+        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 changelogCommand;
+declare module '../interfaces/rman-config.interface.js' {
+    namespace RmanConfig {
+        interface CommandConfigs extends RmanConfig.CommandContribution<ReturnType<typeof changelogCommand>> {
+        }
+    }
+}