rman 1.2.5 → 2.0.0-beta.2

package/core/package.d.ts

@@ -1,15 +1,17 @@
-import type { RmanConfig } from '../interfaces/rman-config.interface.js';
+import type { RmanApplication } from './application.js';
+import type { ResolvedConfig } from './config.js';
 import { Manifest } from './manifest.js';
+import type { Platform } from './plugin.js';
 import type { Repository } from './repository.js';
 import { type VersionScheme } from './version-scheme.js';
 export declare class Package {
     readonly dirname: string;
     /**
-     * This package's identity, read through whichever `ManifestProvider` recognizes its directory.
+     * This package's identity, read through whichever `Plugin`'s manifest members recognizes its directory.
      *
      * There is no `json` here any more, and that is the point: `package.json` is npm's answer to
      * "where is a package's name and version written", not rman's. `manifest.raw` is still the whole
-     * document for a command that knows its own ecosystem - `rman-node` reads `scripts` and
+     * document for a command that knows its own ecosystem - the `node` built-in reads `scripts` and
      * `publishConfig` off it - but the core only ever touches `name`, `version` and `private`.
      */
     manifest: Manifest;
@@ -23,9 +25,16 @@ export declare class Package {
      * whatever the ecosystem, and comparing by identity removes a lookup from every consumer.
      */
     dependencies: Package[];
-    /** Effective rman config for this package, cascaded from the repository root, with every
-     *  `${{ ... }}` expression already evaluated. */
-    config: RmanConfig;
+    /**
+     * Effective rman config for this package, cascaded from the repository root, with every
+     * `${{ ... }}` expression already evaluated.
+     *
+     * **`ResolvedConfig`, not `RmanConfig`, and that is the whole two-view split in one line.**
+     * `RmanConfig` is what an *author* writes, where a value may be a function; this is what a
+     * *reader* gets, where it has already been called. Derived from the one the author writes, so
+     * there is no second type to keep in step - see `Resolved`.
+     */
+    config: ResolvedConfig;
     /**
      * The repository this package belongs to - so anything holding a package can reach the whole
      * picture (its siblings, the root's config, git) without being handed it separately.
@@ -33,14 +42,54 @@ export declare class Package {
      * Assigned by `Repository.create` rather than taken as a constructor argument, and it has to be:
      * `Repository extends Package`, so a repository constructing itself runs this constructor before
      * it exists to be passed in. A repository's own is itself.
+     *
+     * **Non-enumerable, and `declare` for the same reason `parent` is** - this is the *other* half of
+     * why a package could not be serialized, and the older half. A `Repository` holds every package,
+     * so one enumerable back-reference makes `JSON.stringify(anyPackage)` a cycle whatever the tree
+     * edges do: measured before `parent` was touched at all, and the error even named it
+     * (`property 'repository' closes the circle`). Making only `parent` non-enumerable would have
+     * delivered a tree that still cannot be dumped, which is the whole reason the asymmetry exists.
+     *
+     * It is the same rule `Repository.app`, `_repoScope` and `_git` already follow: a back-reference
+     * to something that holds everything has no business in a walk of one package.
      */
     repository: Repository;
     /**
      * The package whose directory contains this one - the repository root for an ordinary member, and
      * a genuine enclosing package for one nested inside another (which `Repository.currentPackage`
      * already has to reason about). `undefined` for the root itself, which nothing contains.
+     *
+     * **Non-enumerable, and `children` is not** - the two halves of one edge, and only one of them
+     * can be the one a walk follows. A tree is walked downwards, so `children` has to be visible and
+     * `parent` must not be, or a `toEqual` diff climbs back to the root and down again. Assigned
+     * through `defineProperty` by `Repository._linkPackages`, the same way `Repository.app` and
+     * `ORIGINS` travel.
+     *
+     * **`declare`, and that is load-bearing.** A plain `readonly parent?: Package` is a *class field*
+     * under this target, so TypeScript emits `parent;` and every package gets an **enumerable**
+     * `undefined` that the later `defineProperty` only replaces on the packages that have a parent.
+     * Measured: `Object.keys(rootPackage)` listed `parent` while `Object.keys(pkg-a)` did not, which
+     * is the exact opposite of what either name suggests. `declare` emits nothing, so the property
+     * exists only where it is defined.
+     *
+     * **It does not make a `Package` JSON-serializable, and nothing here claims it does** - see
+     * `repository`, which is enumerable and points back at an object holding every package.
+     */
+    readonly parent?: Package;
+    /**
+     * The packages whose directories sit directly inside this one - **the tree edge**, in the order
+     * the platform that claimed this directory gave them.
+     *
+     * This is the shape discovery actually has, and it used to be flattened away: a provider was
+     * asked once at the repository root and returned one list, so a package nested inside another was
+     * only reconstructible by comparing path prefixes (which `_linkPackages` and `currentPackage`
+     * both did, separately). `Workspace.walk` descends, so the containment is known as it is found -
+     * and `Repository.packages` is now this tree flattened rather than the other way round.
+     *
+     * Empty for a leaf, and for every package in an ordinary flat monorepo - where the root's
+     * `children` is the whole member list.
      */
-    parent?: Package;
+    readonly children: Package[];
     /**
      * How this package's versions are numbered - `pkg.versionScheme.next(pkg.version, 'minor')`.
      *
@@ -57,27 +106,106 @@ export declare class Package {
      *  changed (a commit's path list). Empty when no provider recognized this directory. */
     manifestFileName: string;
     /**
-     * **Which ecosystem this package belongs to** - `'node'` for one read by `rman-node`, from the
-     * `ManifestProvider.name` that claimed the directory. Empty when no provider did.
+     * **What addresses this package**: what a `.rmanrc "[glob]"` block and `--scope`/`--ignore` match
+     * against, and what must be unique within the repository.
+     *
+     * Three sources, first one that answers:
+     *
+     * 1. the package's own `.rmanrc "name"` - the repository assigning one;
+     * 2. its platform's `manifestProvider.selector`;
+     * 3. the manifest's own `name`, which is the default that answer falls back to.
+     *
+     * **Not `name`, and the split is the point.** `name` is what the package calls itself, read from
+     * its manifest, and it is an *ecosystem's* promise that such a thing exists and identifies the
+     * package - npm's promise, not rman's. Selectors matched `pkg.name` until this existed, so a
+     * repository whose technology has no name concept had packages it could not address at all, and
+     * one whose names are not unique (or are import paths) could only address them badly. They
+     * coincide for every Node repository, which is why nothing had to change for one.
+     *
+     * **The root's is nearly unused, deliberately.** A glob never matches the root and `"[/]"` needs
+     * no name - the root is addressed structurally, which is the whole reason it is `/`. It still has
+     * one so that nothing has to special-case it.
+     *
+     * Assigned by `Repository.create`, which is what has the config; a bare `new Package(dir, app)`
+     * gets the manifest's name, which is sources 2 and 3 with no config to consult.
+     */
+    selector: string;
+    /**
+     * **The technology this package belongs to** - the platform whose manifest provider claimed the
+     * directory, or `basePlatform` when none did.
+     *
+     * Per *package*, not per repository: the question is asked per directory, so a polyglot monorepo
+     * can hold a `node` package beside a `cargo` one and a command sweeping `getPackages()` can tell
+     * them apart. It is also what carries the rest of the technology's answers - where its binaries
+     * live, where its scripts come from, how its releases are planned - so anything that used to walk
+     * four separate registries asking "is this yours?" now asks the package it already has.
+     */
+    platform: Platform;
+    /**
+     * **Which ecosystem this package belongs to** - `'node'` for one the `node` built-in read. Empty when
+     * no stack claimed the directory.
      *
      * The escape hatch for code that legitimately knows one technology: `if (pkg.provider === 'node')`
-     * before reaching into `manifest.raw` for something only npm has. Per *package*, not per
-     * repository, because `Manifest.read` asks per directory - a polyglot monorepo can hold a `node`
-     * package beside a `cargo` one, and a command sweeping over `getPackages()` has to be able to
-     * tell.
+     * before reaching into `manifest.raw` for something only npm has.
      *
      * Not a union type on purpose: the set of ecosystems is whatever the repository's `plugins`
      * contribute, so narrowing it here would mean the core listing plugins it cannot know about.
      */
-    provider: string;
-    constructor(dirname: string);
+    get provider(): string;
+    /**
+     * **Takes the application but does not keep it.** A package needs it once, to find out which
+     * technology claims its directory; afterwards it holds only data, so nothing that has a package
+     * can reach a service through it. Data down, behaviour up - the work belongs to services, and a
+     * piece of code holding only a package is not doing any.
+     *
+     * It also keeps the package out of every spread and serialization the application would
+     * otherwise be dragged into: `{...pkg}` and `pkg.manifest.raw` are both real, and an `app` field
+     * here would carry the whole world into them.
+     */
+    constructor(dirname: string, app: RmanApplication, 
+    /**
+     * The technology that claimed this directory, when the caller already knows - which
+     * `Repository.create` does, because the walk that found the directory is what established it.
+     *
+     * Optional so a bare `new Package(dir, app)` still works: that is what the fixtures build, and
+     * it is also the honest fallback for anyone constructing a package outside a walk. It costs one
+     * search of the registry (`app.platformFor`), which is what *every* construction used to do.
+     */
+    platform?: Platform);
+    /** What this package's **platform** says addresses it, before any config is consulted - the
+     *  manifest's own name when the platform has no opinion, and the directory when it has no name
+     *  either (which is unique among siblings and is all there is to go on). */
+    platformSelector(): string;
     get basename(): string;
     get name(): string;
     get version(): string;
     get isPrivate(): boolean;
-    /** Re-reads from disk - for a command that has just written the manifest itself and wants the
-     *  package to agree with the file again. */
+    /**
+     * Whether this is the repository's **own root package** - what `--scope /` and `.rmanrc`'s
+     * `"[/]"` both select.
+     *
+     * **By directory, and deliberately not by name or by identity.** The documented rule is that the
+     * root package is the one whose directory *is* the repository root, because a name can be
+     * anything - and identity (`this === repository.rootPackage`) is not equivalent either:
+     * `Repository extends Package` while holding a separate `rootPackage` instance for the same
+     * directory, so a comparison by reference answers `false` for one of the two objects that are
+     * both, truthfully, the root.
+     *
+     * `false` before `Repository.create` has assigned `repository` - a bare `new Package(dir, app)`
+     * (which the test fixtures build) belongs to no repository yet, so there is no root for it to be.
+     */
+    get isRoot(): boolean;
+    /**
+     * Re-reads from disk - for a command that has just written the manifest itself and wants the
+     * package to agree with the file again.
+     *
+     * Through **its own** technology's provider, like the constructor: the package already knows
+     * which platform claimed it, and a second opinion on a re-read was never wanted.
+     */
     reloadManifest(): Manifest;
     /** Writes the current manifest back through its provider. */
     writeManifest(): void;
+    /** The three fields a manifest read sets, in one place - so construction and `reloadManifest`
+     *  cannot disagree about what "reading the manifest" means. */
+    private _readManifest;
 }

package/core/package.js

@@ -4,11 +4,11 @@ import { semverScheme } from './version-scheme.js';
 export class Package {
     dirname;
     /**
-     * This package's identity, read through whichever `ManifestProvider` recognizes its directory.
+     * This package's identity, read through whichever `Plugin`'s manifest members recognizes its directory.
      *
      * There is no `json` here any more, and that is the point: `package.json` is npm's answer to
      * "where is a package's name and version written", not rman's. `manifest.raw` is still the whole
-     * document for a command that knows its own ecosystem - `rman-node` reads `scripts` and
+     * document for a command that knows its own ecosystem - the `node` built-in reads `scripts` and
      * `publishConfig` off it - but the core only ever touches `name`, `version` and `private`.
      */
     manifest;
@@ -22,24 +22,30 @@ export class Package {
      * whatever the ecosystem, and comparing by identity removes a lookup from every consumer.
      */
     dependencies = [];
-    /** Effective rman config for this package, cascaded from the repository root, with every
-     *  `${{ ... }}` expression already evaluated. */
-    config = {};
     /**
-     * The repository this package belongs to - so anything holding a package can reach the whole
-     * picture (its siblings, the root's config, git) without being handed it separately.
+     * Effective rman config for this package, cascaded from the repository root, with every
+     * `${{ ... }}` expression already evaluated.
      *
-     * Assigned by `Repository.create` rather than taken as a constructor argument, and it has to be:
-     * `Repository extends Package`, so a repository constructing itself runs this constructor before
-     * it exists to be passed in. A repository's own is itself.
+     * **`ResolvedConfig`, not `RmanConfig`, and that is the whole two-view split in one line.**
+     * `RmanConfig` is what an *author* writes, where a value may be a function; this is what a
+     * *reader* gets, where it has already been called. Derived from the one the author writes, so
+     * there is no second type to keep in step - see `Resolved`.
      */
-    repository;
+    config = {};
     /**
-     * The package whose directory contains this one - the repository root for an ordinary member, and
-     * a genuine enclosing package for one nested inside another (which `Repository.currentPackage`
-     * already has to reason about). `undefined` for the root itself, which nothing contains.
+     * The packages whose directories sit directly inside this one - **the tree edge**, in the order
+     * the platform that claimed this directory gave them.
+     *
+     * This is the shape discovery actually has, and it used to be flattened away: a provider was
+     * asked once at the repository root and returned one list, so a package nested inside another was
+     * only reconstructible by comparing path prefixes (which `_linkPackages` and `currentPackage`
+     * both did, separately). `Workspace.walk` descends, so the containment is known as it is found -
+     * and `Repository.packages` is now this tree flattened rather than the other way round.
+     *
+     * Empty for a leaf, and for every package in an ordinary flat monorepo - where the root's
+     * `children` is the whole member list.
      */
-    parent;
+    children = [];
     /**
      * How this package's versions are numbered - `pkg.versionScheme.next(pkg.version, 'minor')`.
      *
@@ -56,26 +62,85 @@ export class Package {
      *  changed (a commit's path list). Empty when no provider recognized this directory. */
     manifestFileName;
     /**
-     * **Which ecosystem this package belongs to** - `'node'` for one read by `rman-node`, from the
-     * `ManifestProvider.name` that claimed the directory. Empty when no provider did.
+     * **What addresses this package**: what a `.rmanrc "[glob]"` block and `--scope`/`--ignore` match
+     * against, and what must be unique within the repository.
+     *
+     * Three sources, first one that answers:
+     *
+     * 1. the package's own `.rmanrc "name"` - the repository assigning one;
+     * 2. its platform's `manifestProvider.selector`;
+     * 3. the manifest's own `name`, which is the default that answer falls back to.
+     *
+     * **Not `name`, and the split is the point.** `name` is what the package calls itself, read from
+     * its manifest, and it is an *ecosystem's* promise that such a thing exists and identifies the
+     * package - npm's promise, not rman's. Selectors matched `pkg.name` until this existed, so a
+     * repository whose technology has no name concept had packages it could not address at all, and
+     * one whose names are not unique (or are import paths) could only address them badly. They
+     * coincide for every Node repository, which is why nothing had to change for one.
+     *
+     * **The root's is nearly unused, deliberately.** A glob never matches the root and `"[/]"` needs
+     * no name - the root is addressed structurally, which is the whole reason it is `/`. It still has
+     * one so that nothing has to special-case it.
+     *
+     * Assigned by `Repository.create`, which is what has the config; a bare `new Package(dir, app)`
+     * gets the manifest's name, which is sources 2 and 3 with no config to consult.
+     */
+    selector;
+    /**
+     * **The technology this package belongs to** - the platform whose manifest provider claimed the
+     * directory, or `basePlatform` when none did.
+     *
+     * Per *package*, not per repository: the question is asked per directory, so a polyglot monorepo
+     * can hold a `node` package beside a `cargo` one and a command sweeping `getPackages()` can tell
+     * them apart. It is also what carries the rest of the technology's answers - where its binaries
+     * live, where its scripts come from, how its releases are planned - so anything that used to walk
+     * four separate registries asking "is this yours?" now asks the package it already has.
+     */
+    platform;
+    /**
+     * **Which ecosystem this package belongs to** - `'node'` for one the `node` built-in read. Empty when
+     * no stack claimed the directory.
      *
      * The escape hatch for code that legitimately knows one technology: `if (pkg.provider === 'node')`
-     * before reaching into `manifest.raw` for something only npm has. Per *package*, not per
-     * repository, because `Manifest.read` asks per directory - a polyglot monorepo can hold a `node`
-     * package beside a `cargo` one, and a command sweeping over `getPackages()` has to be able to
-     * tell.
+     * before reaching into `manifest.raw` for something only npm has.
      *
      * Not a union type on purpose: the set of ecosystems is whatever the repository's `plugins`
      * contribute, so narrowing it here would mean the core listing plugins it cannot know about.
      */
-    provider;
-    constructor(dirname) {
+    get provider() {
+        return this.platform.name;
+    }
+    /**
+     * **Takes the application but does not keep it.** A package needs it once, to find out which
+     * technology claims its directory; afterwards it holds only data, so nothing that has a package
+     * can reach a service through it. Data down, behaviour up - the work belongs to services, and a
+     * piece of code holding only a package is not doing any.
+     *
+     * It also keeps the package out of every spread and serialization the application would
+     * otherwise be dragged into: `{...pkg}` and `pkg.manifest.raw` are both real, and an `app` field
+     * here would carry the whole world into them.
+     */
+    constructor(dirname, app, 
+    /**
+     * The technology that claimed this directory, when the caller already knows - which
+     * `Repository.create` does, because the walk that found the directory is what established it.
+     *
+     * Optional so a bare `new Package(dir, app)` still works: that is what the fixtures build, and
+     * it is also the honest fallback for anyone constructing a package outside a walk. It costs one
+     * search of the registry (`app.platformFor`), which is what *every* construction used to do.
+     */
+    platform) {
         this.dirname = dirname;
-        const { manifest, versionScheme, fileName, provider } = Manifest.read(dirname);
-        this.manifest = manifest;
-        this.versionScheme = versionScheme;
-        this.manifestFileName = fileName ? path.join(dirname, fileName) : '';
-        this.provider = provider;
+        this.platform = platform ?? app.platformFor(dirname);
+        this._readManifest();
+        this.selector = this.platformSelector();
+    }
+    /** What this package's **platform** says addresses it, before any config is consulted - the
+     *  manifest's own name when the platform has no opinion, and the directory when it has no name
+     *  either (which is unique among siblings and is all there is to go on). */
+    platformSelector() {
+        const asked = this.platform.manifestProvider.selector?.(this.manifest, this.dirname);
+        return asked || this.manifest.name || this.basename;
     }
     get basename() {
         return path.basename(this.dirname);
@@ -89,18 +154,45 @@ export class Package {
     get isPrivate() {
         return !!this.manifest.private;
     }
-    /** Re-reads from disk - for a command that has just written the manifest itself and wants the
-     *  package to agree with the file again. */
+    /**
+     * Whether this is the repository's **own root package** - what `--scope /` and `.rmanrc`'s
+     * `"[/]"` both select.
+     *
+     * **By directory, and deliberately not by name or by identity.** The documented rule is that the
+     * root package is the one whose directory *is* the repository root, because a name can be
+     * anything - and identity (`this === repository.rootPackage`) is not equivalent either:
+     * `Repository extends Package` while holding a separate `rootPackage` instance for the same
+     * directory, so a comparison by reference answers `false` for one of the two objects that are
+     * both, truthfully, the root.
+     *
+     * `false` before `Repository.create` has assigned `repository` - a bare `new Package(dir, app)`
+     * (which the test fixtures build) belongs to no repository yet, so there is no root for it to be.
+     */
+    get isRoot() {
+        const repository = this.repository;
+        return !!repository && path.resolve(this.dirname) === path.resolve(repository.dirname);
+    }
+    /**
+     * Re-reads from disk - for a command that has just written the manifest itself and wants the
+     * package to agree with the file again.
+     *
+     * Through **its own** technology's provider, like the constructor: the package already knows
+     * which platform claimed it, and a second opinion on a re-read was never wanted.
+     */
     reloadManifest() {
-        const { manifest, versionScheme, fileName, provider } = Manifest.read(this.dirname);
-        this.manifest = manifest;
-        this.versionScheme = versionScheme;
-        this.manifestFileName = fileName ? path.join(this.dirname, fileName) : '';
-        this.provider = provider;
+        this._readManifest();
         return this.manifest;
     }
     /** Writes the current manifest back through its provider. */
     writeManifest() {
-        Manifest.write(this.dirname, this.manifest);
+        this.platform.manifestProvider.write(this.dirname, this.manifest);
+    }
+    /** The three fields a manifest read sets, in one place - so construction and `reloadManifest`
+     *  cannot disagree about what "reading the manifest" means. */
+    _readManifest() {
+        const { manifest, versionScheme, fileName } = Manifest.read(this.platform, this.dirname);
+        this.manifest = manifest;
+        this.versionScheme = versionScheme;
+        this.manifestFileName = fileName ? path.join(this.dirname, fileName) : '';
     }
 }

package/core/plugin-loader.d.ts

@@ -0,0 +1,65 @@
+import type { RmanConfig } from '../interfaces/rman-config.interface.js';
+import type { RmanApplication } from './application.js';
+import { type Platform, type Plugin } from './plugin.js';
+/** The `.rmanrc` key naming plugin packages to load. */
+export declare const PLUGINS_KEY = "plugins";
+/**
+ * The repository's plugins and publish targets, registered onto `app`.
+ *
+ * **Three keys share one shape** - `plugins`, `publishTargets` and `commands` each take an
+ * instance or a **glob** naming `.js` modules that `export default` one, and each appends rather
+ * than replaces. Two of them are read here; `commands` is read by `cli.ts`, and the split is not
+ * arbitrary:
+ *
+ * - **`plugins` and `publishTargets` are root-level, because they have to be.** This runs inside
+ *   `Repository.create` *before* the packages are known, since a plugin's `getWorkspace` is what
+ *   finds them - so there are no package configs to read yet. A `plugins` entry in a package's own
+ *   `.rmanrc` is never seen, which has always been true and is now true for the same reason.
+ * - **`commands` is read at any level**, after the packages exist, which is why `cli.ts` owns it:
+ *   it already holds the whole command pipeline - the `.rman/` default, de-duplication by name,
+ *   and the built-in shadow check. Reading it here as well would register every config-declared
+ *   command twice, and yargs does not survive that.
+ *
+ * **Order within this function is load-bearing**: plugins first, then targets. rman's own
+ * `publish` builds its `--target` choices from `app.publishTargets` when its factory runs, and a
+ * target contributed by a plugin's `init` has to be there before the list is read.
+ *
+ * **A contribution that cannot be loaded throws**, unlike a broken `.rman/*.mjs`, which is warned
+ * about and skipped. The consequence differs: a skipped local command affects only itself, while a
+ * missing plugin silently removes commands the repository is built around - `rman publish` would
+ * simply not exist, and "not a known command" sends the reader looking in the wrong place.
+ */
+export declare function loadPlugins(app: RmanApplication, rootConfig: RmanConfig): Promise<void>;
+/**
+ * **Puts one plugin onto an application** - what `plugins` does with an entry once it has been
+ * found and vetted, and the only place that knows how.
+ *
+ * **A bare `Platform` is sugar**, which is what almost every entry is - a plugin that provides one
+ * technology and nothing else. Normalized here, so nothing downstream deals in two shapes.
+ *
+ * **Exported because a spec must not reimplement it.** The registration is two registries plus a
+ * planner assignment, and a fixture writing that out by hand is a second implementation that
+ * drifts - which is exactly how a fixture ends up proving the core works when it does not. A spec
+ * brings its own technology through this, the same door a config's does.
+ *
+ * **`init` is not called here, and that is why this returns the normalized plugin.** An `init` runs
+ * once, when a *config* brought the plugin in, and it may be asynchronous - so it belongs to the
+ * loader above rather than to a function a fixture calls synchronously while building an
+ * application.
+ */
+export declare function registerPlugin(app: RmanApplication, entry: Plugin | Platform): Plugin;
+/**
+ * A plugin's `CustomCommand`, checked the same way a `.rman/*.mjs` one is - the name it answers to
+ * comes from its own `command` string, since a plugin has no file name to fall back on.
+ *
+ * Exported because `cli.ts` runs the identical checks on what a *declarative* command's factory
+ * returns, and they must not drift: a plugin written in JavaScript reaches both forms with no type
+ * checker in the way.
+ */
+export declare function checkCustomCommand<T extends {
+    command?: string;
+    describe?: unknown;
+    handler?: unknown;
+}>(command: T, pluginName: string): T & {
+    command: string;
+};