@bobfrankston/npmglobalize 1.0.197 → 1.0.198

package/README.md

@@ -532,6 +532,45 @@ not yet change its behavior based on it. Behavior wiring (e.g. resolving
 `file:` deps to the latest published npm version instead of walking siblings)
 is planned.
 
+### `upstream` — who consumes this package
+
+Bookkeeping, not a setting. When a package with `file:` deps publishes,
+npmglobalize appends an entry to each **dependency's** `.globalize.json5`:
+
+```json5
+{
+  "install": true,
+
+  // FYI: packages that depend on this one (immediate consumers,
+  //      recorded when each of them publishes). Nothing is updated
+  //      automatically; follow each path's own .globalize.json5 to
+  //      walk further out.
+  "upstream": [
+    {"path":"Y:\\dev\\utils\\winpos","version":"2.0.51","updated":"2026-08-09"},
+  ],
+}
+```
+
+So publishing `winpos` (which has `"@bobfrankston/msger": "file:../msgx/msger"`)
+records winpos in **msger's** config. Each entry carries the consumer's
+checkout path, its version at the time, and the date.
+
+Only **immediate** consumers are recorded. A full consumer tree is a walk, not
+a copy: follow each entry's path and read that package's own `upstream` list.
+
+The list is **FYI for now** — it is recorded, preserved across publishes, and
+printed in the Release Summary of the package that owns it. Nothing is
+rebuilt, republished, or reinstalled on its behalf. An entry is added the
+first time a consumer publishes after this feature landed, and refreshed in
+place on every publish after that.
+
+The entry is written into the dependency's own checkout, then committed there
+(`Record upstream <consumer>@<version>`) and pushed if that repo has a remote.
+Only `.globalize.json5` is staged and committed, by pathspec — anything else
+the dependency had staged or modified is left exactly as it was. If the
+dependency isn't a git repo, or ignores `.globalize.json5`, the file is still
+written and the commit is skipped.
+
 ## Common Workflows
 
 ### Standard Release

package/lib.d.ts

@@ -25,6 +25,16 @@ export declare function clearBuildIssues(): void;
 /** Extract the first TypeScript error line from build output for the summary.
  *  Returns a short string like "file.ts(42,5): error TS2339: Property 'foo' ..." */
 export declare function extractFirstTscError(output: string): string | null;
+/** One package that depends on this one, recorded in this package's
+ *  .globalize.json5 when that package publishes. */
+export interface UpstreamEntry {
+    /** Absolute path of the consumer's checkout */
+    path: string;
+    /** Consumer's version at the time it was recorded */
+    version: string;
+    /** Date the entry was last written (YYYY-MM-DD) */
+    updated: string;
+}
 /** Options for the globalize operation */
 export interface GlobalizeOptions {
     /** Bump type: patch (default), minor, major */
@@ -132,6 +142,12 @@ export interface GlobalizeOptions {
      *  that rely on workspace cross-refs / -public-deps cascade. Opt in when
      *  the assumption holds. */
     importCheck?: boolean;
+    /** Bookkeeping, not a CLI option: the packages that depend on this one,
+     *  written into this package's .globalize.json5 when each of them
+     *  publishes. Immediate consumers only - a full consumer tree is walked by
+     *  following each entry's own .globalize.json5. FYI for now: recorded and
+     *  displayed, nothing is updated automatically. */
+    upstream?: UpstreamEntry[];
     /** Internal: signals this call is from workspace orchestrator */
     /** Skip the upfront dep-graph prescan */
     noPrescan?: boolean;
@@ -289,6 +305,16 @@ export declare function prescanDepGraph(baseDir: string, visited?: Set<string>,
 export declare function restoreDeps(pkg: any, verbose?: boolean): boolean;
 /** Check if .dependencies exist (already transformed) */
 export declare function hasBackup(pkg: any): boolean;
+/** Record this package in the `upstream` list of each package it depends on
+ *  via file:, so a library knows who consumes it.
+ *
+ *  Immediate consumers only — each entry's own .globalize.json5 carries its
+ *  consumers, so the full tree is a walk rather than a copy. Nothing acts on
+ *  the list yet; it's FYI for a future "update my consumers" pass.
+ *
+ *  Best-effort: a dep whose config can't be written is reported and skipped,
+ *  never fatal - this runs after a successful publish. */
+export declare function recordUpstream(cwd: string, dryRun?: boolean, verbose?: boolean): Promise<void>;
 /** Get the latest git tag (if any) */
 export declare function getLatestGitTag(cwd: string): string | null;
 /** Check if a git tag exists */

package/lib.js

@@ -240,6 +240,12 @@ export function writeConfig(dir, config, explicitKeys) {
     const existing = readConfig(dir);
     // Filter out temporary flags and default values (unless explicitly set)
     const filtered = {};
+    // upstream is bookkeeping written by recordUpstream, never a CLI option, so
+    // it isn't in the options object a normal publish passes here. Carry it
+    // across or this package's own next publish would erase its consumer list.
+    if (config.upstream === undefined && existing.upstream !== undefined) {
+        config = { ...config, upstream: existing.upstream };
+    }
     const omitKeys = new Set(['cleanup', 'init', 'dryRun', 'message', 'conform', 'asis', 'help', 'error', 'updateDeps', 'updateMajor', 'publishDeps', 'publicDeps', 'forcePublish', 'once', 'cleanNestedModules']);
     for (const [key, value] of Object.entries(config)) {
         if (omitKeys.has(key))
@@ -263,6 +269,19 @@ export function writeConfig(dir, config, explicitKeys) {
     const entries = Object.entries(filtered);
     if (entries.length > 0) {
         entries.forEach(([key, value]) => {
+            // upstream is a list of records - one per line beats one long line
+            if (key === 'upstream' && Array.isArray(value)) {
+                lines.push('  // FYI: packages that depend on this one (immediate consumers,');
+                lines.push('  //      recorded when each of them publishes). Nothing is updated');
+                lines.push('  //      automatically; follow each path\'s own .globalize.json5 to');
+                lines.push('  //      walk further out.');
+                lines.push('  "upstream": [');
+                for (const entry of value) {
+                    lines.push(`    ${JSON.stringify(entry)},`);
+                }
+                lines.push('  ],');
+                return;
+            }
             const jsonValue = typeof value === 'string' ? `"${value}"` : JSON.stringify(value);
             const comma = ','; // JSON5 allows trailing commas
             // Add inline comment for clarity
@@ -1541,6 +1560,117 @@ export function restoreDeps(pkg, verbose = false) {
 export function hasBackup(pkg) {
     return DEP_KEYS.some(key => pkg['.' + key]);
 }
+/** Every file: dep target of a package, by absolute path.
+ *  Looks in the .dependencies backup too, so it finds them whether or not the
+ *  file: paths have been restored yet (--nofiles leaves ^versions in place). */
+function fileDepTargets(pkg, baseDir) {
+    const targets = new Set();
+    for (const key of DEP_KEYS) {
+        for (const source of [pkg[key], pkg['.' + key]]) {
+            if (!source)
+                continue;
+            for (const value of Object.values(source)) {
+                if (isFileRef(value)) {
+                    targets.add(resolveFilePath(value, baseDir));
+                }
+            }
+        }
+    }
+    return [...targets];
+}
+/** Commit (and push) the .globalize.json5 we just wrote in a dependency's repo,
+ *  so the consumer list doesn't sit as an uncommitted change in someone else's
+ *  checkout until their next publish.
+ *
+ *  Stages and commits that one pathspec, never `git add -A`: whatever else the
+ *  dependency's owner had staged or modified stays untouched, so a publish here
+ *  can't sweep up someone else's work in progress. */
+async function commitUpstreamEntry(target, consumer, verbose) {
+    if (!runCommand('git', ['rev-parse', '--git-dir'], { cwd: target, silent: true }).success) {
+        return; // Not a git repo - the file is written, there's nothing to commit
+    }
+    // Stage it first: a config file the dependency has never had before is
+    // untracked, and `git commit -- <path>` rejects a pathspec git doesn't know.
+    const add = runCommand('git', ['add', '--', '.globalize.json5'], { cwd: target, silent: true });
+    if (!add.success) {
+        // Deliberately ignored in that repo - respect it, the file is still written
+        if (/ignored by/i.test(add.stderr + add.output)) {
+            if (verbose)
+                console.log(colors.dim(`  .globalize.json5 is git-ignored in ${target} - not committing`));
+            return;
+        }
+        console.error(colors.yellow(`  Warning: could not stage upstream entry in ${target}: ${add.stderr.trim() || add.output.trim()}`));
+        return;
+    }
+    const commit = runCommand('git', ['commit', '-m', `Record upstream ${consumer}`, '--', '.globalize.json5'], { cwd: target, silent: true });
+    if (!commit.success) {
+        // Re-recording an unchanged entry leaves nothing to commit - not a problem
+        const combined = (commit.output + ' ' + commit.stderr).toLowerCase();
+        if (combined.includes('nothing to commit') || combined.includes('no changes added'))
+            return;
+        console.error(colors.yellow(`  Warning: could not commit upstream entry in ${target}: ${commit.stderr.trim() || commit.output.trim()}`));
+        return;
+    }
+    if (verbose)
+        console.log(colors.dim(`  Committed upstream entry in ${target}`));
+    const hasRemote = runCommand('git', ['remote'], { cwd: target, silent: true }).output.trim().length > 0;
+    if (hasRemote)
+        await pushWithProtection(target, verbose);
+}
+/** Record this package in the `upstream` list of each package it depends on
+ *  via file:, so a library knows who consumes it.
+ *
+ *  Immediate consumers only — each entry's own .globalize.json5 carries its
+ *  consumers, so the full tree is a walk rather than a copy. Nothing acts on
+ *  the list yet; it's FYI for a future "update my consumers" pass.
+ *
+ *  Best-effort: a dep whose config can't be written is reported and skipped,
+ *  never fatal - this runs after a successful publish. */
+export async function recordUpstream(cwd, dryRun = false, verbose = false) {
+    let pkg;
+    try {
+        pkg = readPackageJson(cwd);
+    }
+    catch {
+        return;
+    }
+    const targets = fileDepTargets(pkg, cwd);
+    if (targets.length === 0)
+        return;
+    const entry = {
+        path: path.resolve(cwd),
+        version: pkg.version,
+        updated: new Date().toISOString().slice(0, 10)
+    };
+    for (const target of targets) {
+        try {
+            if (!fs.existsSync(path.join(target, 'package.json')))
+                continue;
+            const targetConfig = readConfig(target);
+            const upstream = [...(targetConfig.upstream ?? [])];
+            // Path identity, case-insensitive: the same checkout reached twice
+            // updates its entry rather than adding a second one.
+            const same = (p) => path.resolve(p).toLowerCase() === entry.path.toLowerCase();
+            const idx = upstream.findIndex(u => same(u.path));
+            if (idx >= 0)
+                upstream[idx] = entry;
+            else
+                upstream.push(entry);
+            if (dryRun) {
+                console.log(`  [dry-run] Would record ${pkg.name}@${entry.version} upstream of ${path.basename(target)}`);
+                continue;
+            }
+            writeConfig(target, { ...targetConfig, upstream });
+            if (verbose) {
+                console.log(colors.dim(`  Recorded upstream ${pkg.name}@${entry.version} in ${target}`));
+            }
+            await commitUpstreamEntry(target, `${pkg.name}@${entry.version}`, verbose);
+        }
+        catch (error) {
+            console.error(colors.yellow(`  Warning: could not record upstream in ${target}: ${error.message}`));
+        }
+    }
+}
 /** Get the latest git tag (if any) */
 export function getLatestGitTag(cwd) {
     try {
@@ -7455,6 +7585,9 @@ export async function globalize(cwd, options = {}, configOptions = {}) {
     else if (!files) {
         console.log('Keeping npm versions (--nofiles mode).');
     }
+    // Tell each file: dependency that this package consumes it. Runs after the
+    // publish so the version recorded is the one that actually shipped.
+    await recordUpstream(cwd, dryRun, verbose);
     console.log(`${timestamp()} Done!`);
     // Run final audit report if not already run
     const auditAlreadyRun = (fix || updateDeps) && (transformResult.transformed || alreadyTransformed || updateDeps);
@@ -7491,6 +7624,17 @@ export async function globalize(cwd, options = {}, configOptions = {}) {
     if (files && transformResult.transformed) {
         console.log(`  Restored file: deps: ${colors.green('✓')}`);
     }
+    // Who consumes what was just published. FYI only - nothing was updated for
+    // them; this is the list you'd walk if you wanted to.
+    {
+        const consumers = readConfig(cwd).upstream ?? [];
+        if (consumers.length > 0) {
+            console.log(`  Upstream consumers (not updated): ${consumers.length}`);
+            for (const c of consumers) {
+                console.log(`    ${colors.dim('·')} ${path.basename(c.path)} v${c.version} ${colors.dim(`(${c.updated}, ${c.path})`)}`);
+            }
+        }
+    }
     // Surface non-default settings the user may have forgotten about
     {
         const surprises = [];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bobfrankston/npmglobalize",
-  "version": "1.0.197",
+  "version": "1.0.198",
   "description": "Transform file: dependencies to npm versions for publishing",
   "main": "index.js",
   "type": "module",