rman 1.2.5 → 2.0.0-beta.2

package/utils/run-options.js

@@ -0,0 +1,81 @@
+import { branchGuardOptions } from './branch-guard.js';
+import { fromRootOption, packageFilterOptions, readPackageFilterOptions } from './package-filter.js';
+/**
+ * Everything `run`, `build` and `test` accept - the package filter, the branch guard, `--from-root`, and
+ * the scheduling flags on top.
+ *
+ * **In `utils/` rather than in `run.command.ts`, which is where the `Argv` version lived.** `build`
+ * and `test` had to import it from a sibling command, which reads as a dependency between commands
+ * and is not one: they share a declaration, the way they already share `packageFilterOptions`.
+ *
+ * Every option is `target: 'cli'`. The `.rmanrc` half of these lives at `run.<script>.concurrency`,
+ * `.bail`, `.topo`, `.progress` - keyed by script name, so it is the one config shape that cannot be
+ * derived from a flat option map and stays hand-written in `RmanConfig`.
+ */
+export const runOptions = {
+    ...packageFilterOptions,
+    ...branchGuardOptions,
+    ...fromRootOption('Run'),
+    parallel: {
+        target: 'cli',
+        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.',
+        /** No `type`: the flag takes a boolean *or* a number, and `coerce` is what says so - which is
+         *  also where `OptionValue` reads this option's type from. */
+        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;
+        },
+    },
+    bail: {
+        target: 'cli',
+        describe: 'Stop on first failure (default: true, overridable per-package via .rmanrc run.<script>.bail)',
+        type: 'boolean',
+    },
+    topo: {
+        target: 'cli',
+        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',
+    },
+    progress: {
+        target: 'cli',
+        describe: 'Show a live progress panel (default: true; auto-disabled when not a TTY; .rmanrc run.<script>.progress)',
+        type: 'boolean',
+    },
+    changed: {
+        target: 'cli',
+        alias: 'c',
+        describe: 'Only run in packages that have changed since the last publish',
+        type: 'boolean',
+    },
+    changedSince: {
+        target: 'cli',
+        cliName: 'changed-since',
+        describe: 'Only run in packages that have changed since the given git commit/hash',
+        type: 'string',
+        /** Declared on the option rather than as a separate `.conflicts()` call - one place says what
+         *  this flag is and what it cannot be combined with. */
+        conflicts: 'changed',
+    },
+};
+export function readRunOptions(args) {
+    return {
+        ...readPackageFilterOptions(args),
+        parallel: args.parallel,
+        topo: args.topo,
+        bail: args.bail,
+        progress: args.progress,
+        changed: args.changed,
+        changedSince: args.changedSince,
+        logLevel: args.logLevel,
+        fromRoot: args.fromRoot,
+    };
+}

package/utils/version-stamp.d.ts

@@ -29,7 +29,7 @@ export declare function stampVersionLabel(content: string, version: string): str
  * ```
  *
  * **A helper, not a policy**: which shape a language declares a version in is
- * `ManifestProvider.stampVersion`'s answer, and this is the one most of them share, exported so
+ * `Plugin.stampVersion`'s answer, and this is the one most of them share, exported so
  * every provider need not re-derive the same regex. Measured, it reaches a Go `const version =
  * "…"`, a Gradle/TOML `version = "…"` and a JS/TS `const version = '…'`.
  *

package/utils/version-stamp.js

@@ -51,7 +51,7 @@ export function stampVersionLabel(content, version) {
  * ```
  *
  * **A helper, not a policy**: which shape a language declares a version in is
- * `ManifestProvider.stampVersion`'s answer, and this is the one most of them share, exported so
+ * `Plugin.stampVersion`'s answer, and this is the one most of them share, exported so
  * every provider need not re-derive the same regex. Measured, it reaches a Go `const version =
  * "…"`, a Gradle/TOML `version = "…"` and a JS/TS `const version = '…'`.
  *