@_linked/cli 1.46.2 → 1.47.0

package/lib/esm/localize/prune.d.ts

@@ -1,182 +0,0 @@
-import type { ProvidedSkip } from './provided.js';
-import type { ManifestEntry } from './manifest.js';
-import type { Deps } from './run.js';
-/** What pruning reads from a command's options. */
-export interface PruneOptions {
-    /** On unless explicitly false. */
-    prune?: boolean;
-}
-/** Limit a prune to some checkouts and/or some dependency names. */
-export interface PruneScope {
-    /** Only these localized packages' checkouts. */
-    owners?: string[];
-    /** Only these dependency names (the first pass; later passes take every candidate of `owners`). */
-    deps?: string[];
-}
-/** The rule's names (every localized sibling among them) and what the rule skipped. */
-export interface Candidates {
-    names: Set<string>;
-    skipped: Map<string, ProvidedSkip>;
-}
-/** The rule (`providedPackages`, provided.ts) over `entries`, plus every entry (sibling). */
-export declare function candidatesFor(entries: Record<string, ManifestEntry>, deps: Pick<Deps, 'appRoot'>): Candidates;
-/**
- * Does the app's installed `version` satisfy `range`? `null` means "cannot
- * tell" -- a dist-tag, `file:`, `npm:`, `workspace:`, a git URL, or a version
- * that is not one -- and every caller then keeps the copy. The failure mode is
- * therefore always the safe one: a copy kept that could have gone, never a
- * copy removed that was needed.
- *
- * npm's own `semver` decides, so prereleases follow npm's rule: `1.3.0-beta.1`
- * satisfies a range only when one of its comparators names a prerelease on
- * the same `major.minor.patch`.
- */
-export declare function satisfies(version: string, range: string): boolean | null;
-/** Pruning is on unless a caller says `{prune: false}`. */
-export declare function shouldPrune(opts?: PruneOptions): boolean;
-/** Is pruning on for this recorded checkout? `--no-prune` at localize/adopt records `prune: false`. */
-export declare function prunesEntry(entry: Pick<ManifestEntry, 'prune'>): boolean;
-/** prune repeats until a pass removes nothing, at most this many passes. */
-export declare const MAX_PRUNE_PASSES = 5;
-/** A range that resolves to a copy: who asks, and what. */
-interface Ask {
-    from: string;
-    range: string;
-}
-/** One copy in a checkout's `node_modules`, and what pruning decides about it. */
-export interface PruneDecision {
-    /** The localized package whose checkout holds the copy. */
-    ownerName: string;
-    /** Its checkout, relative to the app root. */
-    owner: string;
-    dep: string;
-    /** `<nm>/<dep>`, absolute. */
-    dir: string;
-    /** `dir` relative to the app root. */
-    where: string;
-    nm: string;
-    version: string;
-    /** The app's version. */
-    app: string;
-    sibling: boolean;
-    action: 'remove' | 'keep';
-    /**
-     * Why a copy stays: `range` -- a range that loads it is one the app's
-     * version misses (or one that cannot be read); `context` -- removing it
-     * would change what its own dependencies resolve to; `types` -- the copy
-     * ships its own types and removing it would hand TypeScript the checkout's
-     * `@types/` stub for it instead (`staleTypes`).
-     */
-    reason?: 'range' | 'context' | 'types';
-    /** The ranges the app's version does not satisfy (`range`), or a sibling's drift (`remove`). */
-    unmet: Ask[];
-    /** `context`: the dependency that would resolve elsewhere, and both versions. */
-    context?: {
-        dep: string;
-        here: string;
-        app: string | null;
-    };
-    /** `types`: the `@types/` stub TypeScript would take instead, and its version. */
-    types?: {
-        name: string;
-        version: string;
-    };
-}
-/** What a plan found, without touching anything. */
-export interface PrunePlan {
-    remove: PruneDecision[];
-    keep: PruneDecision[];
-    /** Checkouts left alone because they are not under the app root. */
-    outside: {
-        name: string;
-        path: string;
-    }[];
-}
-/**
- * Per-call caches: a requirement index per `node_modules` (built once, see
- * `RequirementIndex`) and the package.json files read along the way.
- */
-export interface PruneCache {
-    indexes: Map<string, RequirementIndex>;
-    /** How many indexes were built -- each is one read of a whole tree. */
-    builds: number;
-}
-export declare function newPruneCache(): PruneCache;
-/**
- * Decide, for every recorded checkout and every candidate copy in its
- * `node_modules`, whether pruning removes it -- without removing anything.
- * `pruneProvided` applies it; the run-time check (`checkOneCopy`) and
- * `--list` call it on its own, which is why it has to be cheap: a copy whose
- * checkout's own range rules it out is decided from that `package.json`
- * alone, and every other range comes from one requirement index per
- * `node_modules`, built at most once per call.
- *
- * Candidates are PER OWNER: a copy is a candidate in checkout O when the rule
- * provides it AND it is a localized sibling, `react`/`react-dom`, or one of
- * O's own runtime dependencies (`dependencies`, `peerDependencies`,
- * `optionalDependencies`). O's devDependencies are O's tooling, whatever
- * another checkout declares at runtime.
- */
-export declare function planPrune(entries: Record<string, ManifestEntry>, deps: Pick<Deps, 'appRoot'>, scope?: PruneScope, cache?: PruneCache, candidates?: Candidates): PrunePlan;
-/**
- * @param entries  the localized packages: every one counts as a sibling
- * @param opts  unused beyond `prune`, which callers check with `shouldPrune`
- * @param deps  `{appRoot, log, warn}`
- * @param scope  prune only some checkouts / names (the run-time check)
- *
- * A removal can make another copy removable -- the copy that went was the one
- * asking a range the app misses, or the one a sibling copy's dependency
- * resolved to -- so it plans and removes again until a pass removes nothing
- * (at most `MAX_PRUNE_PASSES`): one call converges. A checkout recorded with
- * `prune: false` is never touched.
- */
-export declare function pruneProvided(entries: Record<string, ManifestEntry>, opts: PruneOptions, deps: Pick<Deps, 'appRoot' | 'log' | 'warn'>, scope?: PruneScope, cache?: PruneCache): {
-    removed: PruneDecision[];
-    kept: PruneDecision[];
-};
-/**
- * Is `dep` -- declared by a checkout at `range` -- something the app provides,
- * so that its absence from the checkout's own `node_modules` is not a
- * dependency gone missing? `--relink` asks this before reinstalling a
- * checkout, so a copy pruned on purpose does not trigger a reinstall on every
- * postinstall. `pkg` is the checkout's `package.json`: only what would be a
- * candidate in THAT checkout counts. With `checkout`, a copy the prune would
- * keep for a stub `@types/` package there (`staleTypes`) is not provided: its
- * absence is a dependency gone missing, and the reinstall puts it back.
- */
-export declare function isProvidedByApp(dep: string, range: string | undefined, entries: Record<string, ManifestEntry>, candidates: Candidates, deps: Pick<Deps, 'appRoot'>, pkg?: any, checkout?: {
-    dir: string;
-}): boolean;
-/**
- * Does the package at `dir` carry its own type declarations? `types` /
- * `typings`, `typesVersions`, a `types` condition anywhere in `exports`, or an
- * `index.d.ts` next to its `package.json` -- where TypeScript looks for them.
- */
-export declare function shipsOwnTypes(dir: string, pkg: any): boolean;
-/**
- * Every range that would load a copy at the top of one `node_modules`: the
- * requirements (`dependencies`, `peerDependencies`, `optionalDependencies`) of
- * every installed package under it, read ONCE per `node_modules`, then asked
- * per name. A package counts for `<nm>/<dep>` when nothing between it and
- * `nm` holds its own `dep` -- Node would load the top-level copy.
- *
- * Read from npm's hidden lockfile (`node_modules/.package-lock.json`, which
- * npm rewrites on every install in that tree) when there is one: measured
- * over 21 checkouts, parsing all of them took ~45 ms where walking the same
- * 16,800 package.json files took 0.8 s warm and 3.4 s cold. Without one (a
- * tree npm did not write) the tree is walked, once. Either way a requirer is
- * checked against the disk when asked about -- what an earlier prune removed
- * asks nothing, and a copy is shadowed only by a directory that exists.
- */
-export interface RequirementIndex {
-    asks(dep: string): Ask[];
-}
-/** `react@18.3.1 (app 19.2.0), prism-react-renderer@2.4.1 (its react would change), … and 4 more` */
-export declare function summarizeKept(list: PruneDecision[]): string;
-/** The full reason a copy stays, for `--list`. */
-export declare function explainKept(k: PruneDecision): string;
-/** The package dir's `node_modules`, and the clone root's when the package is a monorepo subdir. */
-export declare function nodeModulesRoots(pkgDir: any, entry: any): string[];
-export declare function realOrSelf(p: string): string;
-export {};
-//# sourceMappingURL=prune.d.ts.map

package/lib/esm/localize/prune.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"prune.d.ts","sourceRoot":"","sources":["../../../src/localize/prune.ts"],"names":[],"mappings":"AAmFA,OAAO,KAAK,EAAC,YAAY,EAAC,MAAM,eAAe,CAAC;AAEhD,OAAO,KAAK,EAAC,aAAa,EAAC,MAAM,eAAe,CAAC;AACjD,OAAO,KAAK,EAAC,IAAI,EAAC,MAAM,UAAU,CAAC;AAEnC,mDAAmD;AACnD,MAAM,WAAW,YAAY;IAC3B,kCAAkC;IAClC,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED,oEAAoE;AACpE,MAAM,WAAW,UAAU;IACzB,gDAAgD;IAChD,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,mGAAmG;IACnG,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;CACjB;AAED,uFAAuF;AACvF,MAAM,WAAW,UAAU;IACzB,KAAK,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IACnB,OAAO,EAAE,GAAG,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;CACpC;AAED,6FAA6F;AAC7F,wBAAgB,aAAa,CAC3B,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,EACtC,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,SAAS,CAAC,GAC1B,UAAU,CAMZ;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,SAAS,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,GAAG,IAAI,CAKxE;AAED,2DAA2D;AAC3D,wBAAgB,WAAW,CAAC,IAAI,GAAE,YAAiB,GAAG,OAAO,CAE5D;AAED,uGAAuG;AACvG,wBAAgB,WAAW,CAAC,KAAK,EAAE,IAAI,CAAC,aAAa,EAAE,OAAO,CAAC,GAAG,OAAO,CAExE;AAeD,4EAA4E;AAC5E,eAAO,MAAM,gBAAgB,IAAI,CAAC;AAElC,2DAA2D;AAC3D,UAAU,GAAG;IACX,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;CACf;AAED,kFAAkF;AAClF,MAAM,WAAW,aAAa;IAC5B,2DAA2D;IAC3D,SAAS,EAAE,MAAM,CAAC;IAClB,8CAA8C;IAC9C,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,EAAE,MAAM,CAAC;IACZ,8BAA8B;IAC9B,GAAG,EAAE,MAAM,CAAC;IACZ,sCAAsC;IACtC,KAAK,EAAE,MAAM,CAAC;IACd,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,MAAM,CAAC;IAChB,yBAAyB;IACzB,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE,OAAO,CAAC;IACjB,MAAM,EAAE,QAAQ,GAAG,MAAM,CAAC;IAC1B;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,OAAO,GAAG,SAAS,GAAG,OAAO,CAAC;IACvC,gGAAgG;IAChG,KAAK,EAAE,GAAG,EAAE,CAAC;IACb,iFAAiF;IACjF,OAAO,CAAC,EAAE;QAAC,GAAG,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAAA;KAAC,CAAC;IAC1D,kFAAkF;IAClF,KAAK,CAAC,EAAE;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAC,CAAC;CACzC;AAED,oDAAoD;AACpD,MAAM,WAAW,SAAS;IACxB,MAAM,EAAE,aAAa,EAAE,CAAC;IACxB,IAAI,EAAE,aAAa,EAAE,CAAC;IACtB,oEAAoE;IACpE,OAAO,EAAE;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAC,EAAE,CAAC;CACzC;AAED;;;GAGG;AACH,MAAM,WAAW,UAAU;IACzB,OAAO,EAAE,GAAG,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;IACvC,uEAAuE;IACvE,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,wBAAgB,aAAa,IAAI,UAAU,CAE1C;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,SAAS,CACvB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,EACtC,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,SAAS,CAAC,EAC3B,KAAK,GAAE,UAAe,EACtB,KAAK,GAAE,UAA4B,EACnC,UAAU,GAAE,UAAyC,GACpD,SAAS,CAsCX;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,aAAa,CAC3B,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,EACtC,IAAI,EAAE,YAAY,EAClB,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,SAAS,GAAG,KAAK,GAAG,MAAM,CAAC,EAC5C,KAAK,GAAE,UAAe,EACtB,KAAK,GAAE,UAA4B,GAClC;IAAC,OAAO,EAAE,aAAa,EAAE,CAAC;IAAC,IAAI,EAAE,aAAa,EAAE,CAAA;CAAC,CA4BnD;AAED;;;;;;;;;GASG;AACH,wBAAgB,eAAe,CAC7B,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,MAAM,GAAG,SAAS,EACzB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,EACtC,UAAU,EAAE,UAAU,EACtB,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,SAAS,CAAC,EAC3B,GAAG,CAAC,EAAE,GAAG,EACT,QAAQ,CAAC,EAAE;IAAC,GAAG,EAAE,MAAM,CAAA;CAAC,GACvB,OAAO,CAuBT;AAoKD;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,GAAG,OAAO,CAK5D;AAkCD;;;;;;;;;;;;;;GAcG;AACH,MAAM,WAAW,gBAAgB;IAC/B,IAAI,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,EAAE,CAAC;CAC1B;AAkJD,qGAAqG;AACrG,wBAAgB,aAAa,CAAC,IAAI,EAAE,aAAa,EAAE,GAAG,MAAM,CAI3D;AAUD,kDAAkD;AAClD,wBAAgB,WAAW,CAAC,CAAC,EAAE,aAAa,GAAG,MAAM,CAuBpD;AAeD,oGAAoG;AACpG,wBAAgB,gBAAgB,CAAC,MAAM,KAAA,EAAE,KAAK,KAAA,YAQ7C;AAwDD,wBAAgB,UAAU,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,CAM5C"}