@pnpm/cli.default-reporter 1100.3.17 → 1100.3.19

package/CHANGELOG.md

@@ -1,5 +1,26 @@
 # @pnpm/default-reporter
 
+## 1100.3.19
+
+### Patch Changes
+
+- Updated dependencies:
+  - @pnpm/error@1100.1.4
+
+## 1100.3.18
+
+### Patch Changes
+
+- The progress output no longer overwrites the lines above it once it grows taller than the terminal window [#14270](https://github.com/pnpm/pnpm/issues/14270).
+
+- The update notification now suggests `pnpm self-update` when `PNPM_HOME` manages the pnpm in use, and the [standalone install script](https://pnpm.io/installation) otherwise — under Corepack, or when another package manager installed pnpm. `pnpm self-update` under Corepack names the standalone install script too.
+
+- Updated dependencies:
+  - @pnpm/cli.meta@1100.1.0
+  - @pnpm/core-loggers@1100.3.4
+  - @pnpm/deps.inspection.peers-issues-renderer@1100.0.14
+  - @pnpm/types@1102.1.0
+
 ## 1100.3.17
 
 ### Patch Changes

package/lib/index.js

@@ -1,6 +1,7 @@
 import createDiffer from 'ansi-diff';
 import * as Rx from 'rxjs';
 import { filter, map, mergeAll } from 'rxjs/operators';
+import stringLength from 'string-length';
 import { EOL } from './constants.js';
 import { mergeOutputs } from './mergeOutputs.js';
 import { reporterForClient } from './reporterForClient/index.js';
@@ -12,7 +13,10 @@ export { formatWarn };
 const ERASE_TO_END_OF_DISPLAY = '\x1b[0J';
 export function initDefaultReporter(opts) {
     const proc = opts.context.process ?? process;
-    const outputMaxWidth = opts.reportingOptions?.outputMaxWidth ?? (proc.stdout.columns && proc.stdout.columns - 2) ?? 80;
+    // At least one column: `columns - 2` is zero on a two-column terminal, and a
+    // caller may pass zero outright. A zero width would make every wrap
+    // calculation — the differ's and `renderedRows`' — meaningless.
+    const outputMaxWidth = Math.max(1, opts.reportingOptions?.outputMaxWidth ?? (proc.stdout.columns && proc.stdout.columns - 2) ?? 80);
     const output$ = toOutput$({
         ...opts,
         reportingOptions: {
@@ -38,11 +42,20 @@ export function initDefaultReporter(opts) {
     }
     const stream = opts.useStderr ? proc.stderr : proc.stdout;
     const write = stream.write.bind(stream);
-    const newDiffer = () => createDiffer({
-        height: stream.rows,
-        width: stream.columns ?? outputMaxWidth,
-    });
+    // The width the live differ wraps its frame at, so a resize can be noticed.
+    let differWidth = 0;
+    const newDiffer = () => {
+        differWidth = Math.max(1, stream.columns ?? outputMaxWidth);
+        return createDiffer({ height: stream.rows, width: differWidth });
+    };
     let diff = newDiffer();
+    // How many leading lines of the view have scrolled out of the differ's frame
+    // and been committed to the scrollback, how many rows the frame the differ is
+    // holding takes up, and whether it already outgrew the terminal it was drawn
+    // on. See `commitOverflow`.
+    let committedLines = 0;
+    let renderedFrameRows = 0;
+    let renderedFrameOutgrewTerminal = false;
     // Hold redraws while an interactive prompt owns the terminal (see PromptMessage).
     let promptActive = false;
     const onLog = (log) => {
@@ -74,6 +87,11 @@ export function initDefaultReporter(opts) {
         // An example of such prompt may be seen by running: pnpm update --interactive
         if (!view.endsWith(EOL))
             view += EOL;
+        const lines = view.slice(0, -EOL.length).split(EOL);
+        const committed = commitOverflow(lines);
+        // The lines from `committedLines` on are already laid out contiguously in
+        // the view, so the visible frame is a slice of it rather than a second copy.
+        const frame = view.slice(viewOffsetOfLine(view, lines, committedLines));
         // `\r` resets the column to 0 in case an external process (e.g. an SSH
         // passphrase prompt) left the cursor mid-line. `ansi-diff` then writes
         // only the differential — the characters that actually changed between
@@ -82,13 +100,104 @@ export function initDefaultReporter(opts) {
         // tick. `\x1b[K` erases trailing characters on the current line;
         // `\x1b[0J` erases anything an external process wrote below the
         // rendered frame.
-        write(`\r${diff.update(view)}\x1b[K${ERASE_TO_END_OF_DISPLAY}`);
+        write(`\r${committed}${diff.update(frame)}\x1b[K${ERASE_TO_END_OF_DISPLAY}`);
+    }
+    /**
+     * Hands the lines that no longer fit on screen over to the scrollback and
+     * restarts the differ below them, returning the differential that performs
+     * the handover.
+     *
+     * `ansi-diff` redraws by moving the cursor up from the end of its frame, so
+     * it can only reach lines that are still on screen. A frame taller than the
+     * terminal has scrolled its top away, and every later redraw then lands that
+     * many rows too low — overwriting output above the frame instead of updating
+     * it (pnpm/pnpm#14270). Committing the overflow keeps the frame within the
+     * terminal, at the cost of no longer being able to revise what was committed.
+     */
+    function commitOverflow(lines) {
+        if (Math.max(1, stream.columns ?? outputMaxWidth) !== differWidth) {
+            // The terminal was resized. The frame on screen has reflowed at the new
+            // width, so every position the differ tracked against the old one is
+            // wrong: start over below what is already there.
+            diff = newDiffer();
+        }
+        if (lines.length <= committedLines) {
+            // The view no longer reaches past what was committed — an error frame
+            // replaces it rather than extending it. Render it whole, below.
+            committedLines = 0;
+            diff = newDiffer();
+            return '';
+        }
+        const rows = stream.rows;
+        if (!rows)
+            return '';
+        const width = differWidth;
+        // One row is left over for the cursor line that the trailing EOL puts
+        // below the frame.
+        const maxRows = Math.max(rows - 1, 1);
+        let uncommittedRows = 0;
+        for (let i = committedLines; i < lines.length; i++) {
+            uncommittedRows += renderedRows(lines[i], width);
+        }
+        // The last line always stays in the frame — there would be nothing left to
+        // redraw otherwise — so the walk upwards starts one line above it.
+        let firstVisible = lines.length - 1;
+        let frameRows = renderedRows(lines[firstVisible], width);
+        for (let i = firstVisible - 1; i >= committedLines; i--) {
+            const lineRows = renderedRows(lines[i], width);
+            if (frameRows + lineRows > maxRows)
+                break;
+            frameRows += lineRows;
+            firstVisible = i;
+        }
+        // A frame taller than the terminal has scrolled its own top away — whether
+        // because a line outgrew the screen or because the window shrank under it —
+        // so no cursor move reaches back into it, and growing the window again does
+        // not bring it back. Start afresh below instead, reprinting rather than
+        // revising, and leave the commit for the next frame, whose layout is one
+        // this differ laid out itself.
+        const cannotRevise = renderedFrameOutgrewTerminal || renderedFrameRows > maxRows;
+        if (cannotRevise || firstVisible === committedLines) {
+            renderedFrameRows = uncommittedRows;
+            renderedFrameOutgrewTerminal = uncommittedRows > maxRows;
+            if (cannotRevise || renderedFrameOutgrewTerminal)
+                diff = newDiffer();
+            return '';
+        }
+        renderedFrameRows = frameRows;
+        renderedFrameOutgrewTerminal = false;
+        // Shrinking the frame to just the overflow leaves those lines untouched
+        // where they already are, erases the rest of the frame below them, and
+        // parks the cursor on the next line — where the fresh differ starts.
+        const handover = diff.update(`${lines.slice(committedLines, firstVisible).join(EOL)}${EOL}`).toString();
+        diff = newDiffer();
+        committedLines = firstVisible;
+        return handover;
     }
     return () => {
         subscription.unsubscribe();
         opts.streamParser.removeListener('data', onLog);
     };
 }
+/**
+ * Where the `index`-th of `lines` starts in the `view` they were split from.
+ * Measured from the end, so a long committed prefix costs nothing.
+ */
+function viewOffsetOfLine(view, lines, index) {
+    let trailing = 0;
+    for (let i = lines.length - 1; i >= index; i--) {
+        trailing += lines[i].length + EOL.length;
+    }
+    return view.length - trailing;
+}
+/**
+ * How many terminal rows `line` occupies once wrapped at `width`, counting the
+ * escape sequences in it as zero-width. Never zero: an empty line still takes a
+ * row. `width` is the terminal's own column count, clamped to at least one.
+ */
+function renderedRows(line, width) {
+    return Math.max(1, Math.ceil(stringLength(line) / width));
+}
 export function toOutput$(opts) {
     opts = opts || {};
     const contextPushStream = new Rx.Subject();

package/lib/reporterForClient/reportUpdateCheck.js

@@ -1,4 +1,4 @@
-import { detectIfCurrentPkgIsExecutable, isExecutedByCorepack } from '@pnpm/cli.meta';
+import { isExecutedByCorepack, standaloneInstallCommand } from '@pnpm/cli.meta';
 import boxen from 'boxen';
 import chalk from 'chalk';
 import * as Rx from 'rxjs';
@@ -7,9 +7,8 @@ import semver from 'semver';
 export function reportUpdateCheck(log$, opts) {
     return log$.pipe(take(1), filter((log) => semver.gt(log.latestVersion, log.currentVersion)), map((log) => {
         const updateMessage = renderUpdateMessage({
-            currentPkgIsExecutable: detectIfCurrentPkgIsExecutable(opts.process),
-            latestVersion: log.latestVersion,
             env: opts.env,
+            platform: opts.process.platform,
         });
         return Rx.of({
             msg: boxen(`\
@@ -30,13 +29,14 @@ function renderUpdateMessage(opts) {
     return `To update, run: ${chalk.magenta(updateCommand)}`;
 }
 function renderUpdateCommand(opts) {
-    if (isExecutedByCorepack(opts.env)) {
-        return `corepack use pnpm@${opts.latestVersion}`;
+    // `pnpm self-update` replaces the pnpm that PNPM_HOME manages. Corepack
+    // refuses it outright, and an install another package manager owns is
+    // resolved from that manager's bin directory rather than pnpm's home, so a
+    // self-update would land beside the executable in use instead of replacing
+    // it. The installer is the command that updates either one.
+    if (isExecutedByCorepack(opts.env) || !opts.env.PNPM_HOME) {
+        return standaloneInstallCommand(opts.platform);
     }
-    if (opts.env.PNPM_HOME) {
-        return 'pnpm self-update';
-    }
-    const pkgName = opts.currentPkgIsExecutable ? '@pnpm/exe' : 'pnpm';
-    return `pnpm add -g ${pkgName}`;
+    return 'pnpm self-update';
 }
 //# sourceMappingURL=reportUpdateCheck.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pnpm/cli.default-reporter",
-  "version": "1100.3.17",
+  "version": "1100.3.19",
   "description": "The default reporter of pnpm",
   "keywords": [
     "pnpm",
@@ -32,21 +32,21 @@
     "pnpm-render": "bin/pnpm-render.mjs"
   },
   "dependencies": {
-    "@pnpm/cli.meta": "1100.0.15",
-    "@pnpm/core-loggers": "1100.3.3",
-    "@pnpm/deps.inspection.peers-issues-renderer": "1100.0.13",
-    "@pnpm/error": "1100.1.3",
+    "@pnpm/cli.meta": "1100.1.0",
+    "@pnpm/core-loggers": "1100.3.4",
+    "@pnpm/deps.inspection.peers-issues-renderer": "1100.0.14",
+    "@pnpm/error": "1100.1.4",
     "@pnpm/installing.dedupe.issues-renderer": "1100.0.3",
     "@pnpm/installing.dedupe.types": "1100.0.2",
     "@pnpm/text.ordinal-comparator": "1100.0.0",
-    "@pnpm/types": "1102.0.0",
+    "@pnpm/types": "1102.1.0",
     "ansi-diff": "^1.2.0",
     "boxen": "npm:@zkochan/boxen@5.1.2",
     "chalk": "^6.0.0",
     "cli-truncate": "^6.1.1",
     "normalize-path": "^3.0.0",
-    "pretty-bytes": "^7.1.1",
-    "pretty-ms": "^9.3.0",
+    "pretty-bytes": "^7.1.3",
+    "pretty-ms": "^9.3.1",
     "ramda": "npm:@pnpm/ramda@0.28.1",
     "rxjs": "^7.8.2",
     "semver": "^7.8.5",
@@ -58,7 +58,7 @@
   },
   "devDependencies": {
     "@jest/globals": "30.4.1",
-    "@pnpm/cli.default-reporter": "1100.3.17",
+    "@pnpm/cli.default-reporter": "1100.3.19",
     "@pnpm/logger": "1100.0.0",
     "@types/normalize-path": "^3.0.2",
     "@types/ramda": "0.32.0",