rman 1.3.0 → 2.0.0-beta.3

package/services/run.service.d.ts

@@ -1,8 +1,23 @@
-import type { Package } from '../core/package.js';
-import type { Repository } from '../core/repository.js';
-import type { RunStepContext, RunStepFn, RunStepValue } from '../core/run-step.js';
+import type { Package } from '../core/classes/package.js';
+import type { Repository } from '../core/classes/repository.js';
+import { Service } from '../core/classes/service.js';
+import type { RunStepContext, RunStepFn, RunStepValue } from '../core/interfaces/run-step.js';
 import { type LogLevel } from '../utils/logger.js';
 import { type PackageFilterOptions } from '../utils/package-filter.js';
+/**
+ * A service class - see `ListService` for the shape and `Service` for the three measured
+ * consequences a namespace had.
+ *
+ * **Only `runScript` became a method**, because only it takes a repository. `getConfig`,
+ * `parseIfExpr`, `normalizeScriptValue` and the rest take a `Package` or a raw value and stay
+ * functions on the namespace below - the same rule that leaves `ChangeHashService` a namespace
+ * entirely. Declared before the namespace, which TypeScript requires for the merge.
+ */
+export declare class RunService extends Service {
+    runScript(script: string, options?: RunService.Options & {
+        commandName?: string;
+    }): Promise<void>;
+}
 export declare namespace RunService {
     export interface Options extends PackageFilterOptions {
         /** Max packages built at once: `true`/omitted = CPU count, a number = that many, `false` = serial (1). */
@@ -24,7 +39,7 @@ export declare namespace RunService {
          *  (which otherwise scopes the run to just that package, and skips the root's own pre/post
          *  bookend - see `Repository.currentPackage`). Has no effect when already at the repository
          *  root, or outside any known package. */
-        root?: boolean;
+        fromRoot?: boolean;
     }
     /**
      * A package's `.rmanrc` (cascaded) can configure `run.<script>.*` - e.g.
@@ -89,21 +104,13 @@ export declare namespace RunService {
      *
      * The core knows one source: the config. **`package.json#scripts` is not a source the core has**,
      * because "a script lives in package.json" is true of a Node repository and of nothing else -
-     * `rman-node` contributes that one (with npm's `pre<script>`/`post<script>` convention and its
+     * the `node` built-in contributes that one (with npm's `pre<script>`/`post<script>` convention and its
      * `&&` splitting), and a plugin for another ecosystem would contribute its own.
      *
      * Returns `undefined` for "this package declares nothing", not empty slots - the difference
      * decides whether the config's value applies.
      */
     export type StepSource = (pkg: Package, script: string) => ScriptSlots | undefined;
-    /**
-     * Registers a source. Called by `loadPlugins` for each plugin's `runSteps`, in `plugins`
-     * declaration order - never as an import side effect, so what is registered is exactly what the
-     * repository's `.rmanrc` asked for.
-     */
-    export function addStepSource(source: StepSource): void;
-    /** For tests, which would otherwise leak a source into every later case in the process. */
-    export function clearStepSources(): void;
     /**
      * What the *package itself* declares for the lifecycle `script`, from the contributed sources
      * alone - no `.rmanrc` involved. `undefined` when it declares nothing.
@@ -120,11 +127,15 @@ export declare namespace RunService {
      * Runs one slot of a lifecycle belonging to some operation other than `run` itself - `version`'s
      * hooks around the version write are the only one so far.
      *
-     * **Here rather than in `VersionService`, because the rule it applies is this service's**: the
-     * package's own declaration for `script` wins over the caller's `fallback`, slot by slot, exactly
-     * as `getScriptSteps` decides it for `run`. Kept in two places that rule would drift, and one of
-     * the copies would sit in the file that writes versions - which now runs no command of its own at
-     * all.
+     * **Here rather than in `VersionService`, because the rule it applies is this service's**: how a
+     * package's own declaration for `script` and the caller's `fallback` combine, slot by slot -
+     * `slotValues`, the same function `getScriptSteps` decides it with. Kept in two places that rule
+     * would drift, and one of the copies would sit in the file that writes versions, which now runs
+     * no command of its own at all.
+     *
+     * So npm's `preversion` does **not** replace a repository's `.rmanrc version.before` any more;
+     * both run, the config's first. Only `version.exec` is a single answer, and there the package's
+     * own still wins.
      *
      * `fallback` is the caller's own configured step(s), **already evaluated**: `version`'s three
      * paths are in `DEFERRED_PATHS` precisely because only the caller can bind
@@ -165,7 +176,7 @@ export declare namespace RunService {
      *
      *   run:
      *     build:
-     *       if: changed                                    # changed since the last publish
+     *       if: changed                                    # touched but not pushed
      *     test:
      *       if: changed = a1b2c3d                           # changed since a specific commit
      *       if: changed = {CHANGE_HASH}                     # {NAME} -> process.env.NAME first
@@ -193,9 +204,6 @@ export declare namespace RunService {
     /** Evaluates a parsed `if` expression for one package. `statusCache` avoids repeat `git` calls
      *  for the same reference hash across packages/scripts in a single run. */
     export function evaluateIf(repository: Repository, pkg: Package, node: IfNode, statusCache: Map<string, Record<string, Repository.PackageStatus>>): Promise<boolean>;
-    export function runScript(repository: Repository, script: string, options?: Options & {
-        commandName?: string;
-    }): Promise<void>;
     export {};
 }
 /** Resolution order: explicit CLI flag > the package's resolved `.rmanrc` > `fallback`. */
@@ -208,3 +216,8 @@ export declare function resolveBool(cliValue: boolean | undefined, pkg: Package,
 export declare function resolveBail(cliValue: boolean | undefined, pkg: Package, script: string, fallback: boolean): boolean;
 export declare function resolveNumber(cliValue: number | undefined, pkg: Package, script: string, key: string, fallback: number): number;
 export declare function resolveLogLevel(cliValue: LogLevel | undefined, pkg: Package, script: string, fallback: LogLevel): LogLevel;
+declare module '../core/classes/service.js' {
+    interface ServiceMap {
+        run: RunService;
+    }
+}