@impeccable/reviews 0.1.35 → 0.1.36

package/dist/host-questions.js

@@ -1,3 +1,4 @@
+import { basename } from 'node:path';
 /** The ids the model may name, each worded here whatever else it writes for that id. */
 export const HOST_QUESTIONS = {
     'vercel-setup': {
@@ -46,13 +47,23 @@ export const HOST_SIGNED_IN = {
     },
 };
 /**
- * The Vercel setup screen with its CLI signed in already as `user`: it names that account and where the new project goes,
- * the team the run takes (`team`), the one the person picks next (`pick`) or, with no team, the account itself, so the yes
- * is to that account and team (REN-1250).
+ * The Vercel setup screen with its CLI signed in already as `user`: it names that account, the new project (`project`,
+ * where its name is known) and where it goes, the team the run takes (`team`), the one the person picks next (`pick`) or,
+ * with no team, the account itself, so the yes is to that account, project and team (REN-1250).
  */
 export function vercelSignedIn(user, where) {
     const into = where.team ? `in the team ${where.team}` : where.pick ? 'in the team you pick next' : 'of that account';
-    return { ...HOST_SIGNED_IN['vercel-setup'], hint: `Impeccable reviews each pull request on a preview. Vercel can host those previews: the run sets them up with the Vercel CLI on this machine, signed in as ${user}, in a new project ${into}. What is live stays as it is.` };
+    const project = where.project ? `a new project, ${where.project}, ` : 'a new project ';
+    return { ...HOST_SIGNED_IN['vercel-setup'], hint: `Impeccable reviews each pull request on a preview. Vercel can host those previews: the run sets them up with the Vercel CLI on this machine, signed in as ${user}, in ${project}${into}. What is live stays as it is.` };
+}
+/**
+ * The project the Vercel setup makes, named as `vercel link --yes` finds it in the checkout's root (`root`): the folder's
+ * own name, which the playbook's `vercel project add` gives it. None where that name is not one Vercel takes as it is
+ * (lowercase letters, digits, `.`, `_` and `-`, at most 100, never `---`), since the CLI would change it (REN-1250).
+ */
+export function vercelProjectName(root) {
+    const name = basename(root);
+    return /^[a-z0-9._-]{1,100}$/.test(name) && !name.includes('---') ? name : undefined;
 }
 /**
  * A host's CLI that is not on this machine (#396), asked before anything installs it: the package, the version and the

package/dist/preflight.js

@@ -1,5 +1,5 @@
 import { execFileSync } from 'node:child_process';
-import { closeSync, constants, existsSync, fstatSync, openSync, readFileSync, statSync } from 'node:fs';
+import { closeSync, constants, existsSync, fstatSync, openSync, readFileSync, statSync, writeFileSync } from 'node:fs';
 import { join, resolve } from 'node:path';
 import { parseArgs } from 'node:util';
 import { folderOf } from './host-previews.js';
@@ -358,13 +358,43 @@ export function dropEmptyRunBranches(root, start, before) {
     }
     return lines;
 }
+/** What `vercel link` appends to the root .gitignore: each of its lines the file lacks, after a line break where the file ended without one. */
+const LINK_LINES = /^(?:\r?\n)?(?:(?:\.vercel|\.env\*)\r?\n)+$/;
+/**
+ * The root .gitignore taken back to the start branch's (`HEAD`, nothing staged) where all that changed is the lines
+ * `vercel link` appends, and only where git then shows no untracked file it hides now: a start branch that does not
+ * ignore the link's token file, .env.local, keeps the lines. Any other change is the person's, and stays (REN-1250).
+ * Whether it was taken back.
+ */
+function restoreLinkLines(root, git) {
+    const path = join(root, '.gitignore');
+    const now = readFileSync(path, 'utf8');
+    const before = git(['cat-file', 'blob', 'HEAD:.gitignore']);
+    if (git(['cat-file', 'blob', ':.gitignore']) !== before || !now.startsWith(before) || !LINK_LINES.test(now.slice(before.length)))
+        return false;
+    // File by file, so a file the lines hide inside a folder git shows already counts too.
+    const shown = () => git(['status', '--porcelain=v1', '-z', '--untracked-files=all']).split('\0').filter((line) => line.startsWith('?? '));
+    const visible = new Set(shown());
+    writeFileSync(path, before);
+    let restored = false;
+    try {
+        restored = shown().every((line) => visible.has(line));
+    }
+    finally {
+        // Whatever stopped the check, the link's lines go back, so nothing they hide is shown to git add.
+        if (!restored)
+            writeFileSync(path, now);
+    }
+    return restored;
+}
 /**
  * The run makes its pull requests on branches of its own, and git leaves the checkout on the last it made: the end goes back
  * to the branch the run started on (`start`), so what the person commits next does not land on the test drive. Only from one
  * of the run's branches, and only with no change to a tracked file, which would go along, but to a .gitignore the two
- * branches hold alike, which goes along named; git refuses where an untracked file would be overwritten. The run's own
- * files no commit carries are taken back before this (checkoutJournal). Null when the checkout is back with nothing
- * carried, or never left; else the line the done screen shows.
+ * branches hold alike, which goes along named, or goes back where it holds only `vercel link`'s lines (restoreLinkLines);
+ * git refuses where an untracked file would be overwritten. The run's own files no commit carries are taken back before
+ * this (checkoutJournal). Null when the checkout is back with nothing carried, or never left; else the line the done
+ * screen shows.
  */
 export function backToStartBranch(root, start) {
     const now = currentBranch(root);
@@ -389,7 +419,7 @@ export function backToStartBranch(root, start) {
             throw new Error('a content filter on the start branch');
         // Named, so the done screen says which files keep the checkout here (#421).
         const changed = git(['status', '--porcelain=v1', '-z', '--untracked-files=no', '--no-renames']).split('\0').filter(Boolean).map((line) => line.slice(3));
-        // A .gitignore both branches hold alike, which a host's link changed (vercel link adds .vercel and .env*, before the test drive's branch is made), goes along to the start branch as it is, named (REN-1250): taking those lines back would show the link's token file, .env.local, to git add. Any other change keeps the checkout here.
+        // A .gitignore both branches hold alike, which a host's link changed (vercel link adds .vercel and .env*, before the test drive's branch is made), goes along to the start branch, where the root's goes back as it was when the link's lines are all that changed and hide nothing the start branch's lines do not; else it stays as it is, named (REN-1250), since taking the lines back would show the link's token file, .env.local, to git add. Any other change keeps the checkout here.
         const carried = changed.filter((path) => (path === '.gitignore' || path.endsWith('/.gitignore')) && !differ.includes(path));
         const held = changed.filter((path) => !carried.includes(path));
         if (held.length)
@@ -397,7 +427,15 @@ export function backToStartBranch(root, start) {
         // The closing -- makes git read the name as the branch, never as a path.
         // An ignored file of the person's where the start branch tracks a file of that name stops the checkout, rather than being overwritten.
         git(['-c', 'submodule.recurse=false', 'checkout', '-q', '--no-overwrite-ignore', start, '--']);
-        return carried.length ? `${listPaths(carried)} changed during the setup, from a command it ran or from you, and ${carried.length === 1 ? 'stays' : 'stay'} uncommitted on ${start} as ${carried.length === 1 ? 'it is' : 'they are'}.` : null;
+        let restored = false;
+        try {
+            restored = carried.includes('.gitignore') && restoreLinkLines(root, git);
+        }
+        catch {
+            // Left as it is, and named.
+        }
+        const left = restored ? carried.filter((path) => path !== '.gitignore') : carried;
+        return left.length ? `${listPaths(left)} changed during the setup, from a command it ran or from you, and ${left.length === 1 ? 'stays' : 'stay'} uncommitted on ${start} as ${left.length === 1 ? 'it is' : 'they are'}.` : null;
     }
     catch {
         return `Your checkout is still on ${now}: git checkout ${start} takes it back to the branch you started on.`;

package/dist/tools.js

@@ -10,7 +10,7 @@ import { defineTool } from '@earendil-works/pi-coding-agent';
 import { agreeToCliInstall, agreeToHostSetup, bindPreviewPullRequest, chooseHostTeam, chosenHostTeam, classifyPreviewCommand, endAppSetup, endHostSetup, HOST_CLI_VERSIONS, hostCliInstallArgs, hostCliInstallCommand, hostSetupAgreed, isSecretFile, linkedByRun, observePreviewAttempts, parseCommand, previewRetryState, settleVercelFirstDeployment, vercelProjectsAdded } from './fence.js';
 import { requestJson } from './http.js';
 import { appsLeftOut, focusCheckup, focusInstructions, focusState, severalApps } from './focus.js';
-import { APPS_QUESTION, cliInstallScreen, cliManualScreen, cloudflareAccessConsent, cloudflareAccessPaste, cloudflareAccessReusable, HOST_QUESTIONS, HOST_SCREENS, HOST_SIGNED_IN, namedAppQuestion, NETLIFY_PASSWORD_WHERE, netlifyPasswordReplace, renderConfirm, sentTo, startedIn, vercelBypassConsent, vercelBypassPaste, vercelSignedIn } from './host-questions.js';
+import { APPS_QUESTION, cliInstallScreen, cliManualScreen, cloudflareAccessConsent, cloudflareAccessPaste, cloudflareAccessReusable, HOST_QUESTIONS, HOST_SCREENS, HOST_SIGNED_IN, namedAppQuestion, NETLIFY_PASSWORD_WHERE, netlifyPasswordReplace, renderConfirm, sentTo, startedIn, vercelBypassConsent, vercelBypassPaste, vercelProjectName, vercelSignedIn } from './host-questions.js';
 import { enableNetlifyPreviews, folderOf } from './host-previews.js';
 import { checkoutNames, liveShaped, netlifySiteOf, previewHostName, provePreview, readHostedPreviews, readmeNamesApp, renderSiteOf, vercelDeploymentOf } from './hosted.js';
 import { closedPulls, deploymentsOf, hostingApp, hostingRead, liveHostOf, renderSitesOf } from './hosting.js';
@@ -453,6 +453,9 @@ const ASKS_ADDRESS = /\b(urls?|domains?|(web|site|live|production|preview|app's)
 /** What schemaError cannot say about a question: options belong to single and multi, at least two, each value once, and each other field to its kinds. */
 function askError(q) {
     const values = (q.options ?? []).map((o) => o.value);
+    // A prompt the person cannot read as a question, such as "x", never reaches the screen, where Skip would read as their no (REN-1255).
+    if ((q.prompt.match(/\p{L}[\p{L}\p{N}'’-]*/gu) ?? []).length < 2)
+        return `input.prompt ${JSON.stringify(q.prompt.trim())} is not a question the person can answer, so nothing was shown. Ask only when the run needs the person's answer, with a prompt that says what they answer or agree to; with nothing to ask, go on`;
     if (q.sensitive && q.kind !== 'text')
         return 'input.sensitive is for text questions only';
     if (q.prefill !== undefined && !(q.kind === 'account' || (q.kind === 'text' && !q.sensitive)))
@@ -2160,11 +2163,11 @@ export function createTools(ctx) {
             return { skipped: true };
         let status = await cli.status();
         if (!hostSignIns.has(host)) {
-            // Signed in already, Vercel's screen names the account and the team the new project goes into, which the yes is to (REN-1250).
+            // Signed in already, Vercel's screen names the account, the new project and the team it goes into, which the yes is to (REN-1250).
             let words = status.cli === 'signed-in' ? HOST_SIGNED_IN[`${host}-setup`] : undefined;
             if (status.cli === 'signed-in' && host === 'vercel' && status.user) {
                 const { team, choices } = await (teamRead = cli.team());
-                words = vercelSignedIn(status.user, { team, pick: choices.length > 1 });
+                words = vercelSignedIn(status.user, { team, pick: choices.length > 1, project: vercelProjectName(pi.cwd) });
             }
             const answer = await ask({ id: `${host}-setup`, ...HOST_QUESTIONS[`${host}-setup`], ...words });
             if (answer.skipped) {
@@ -2967,7 +2970,7 @@ export function createTools(ctx) {
             // A test account never comes back to the model, even if the API echoed it.
             return testAccounts ? redact(answerText(response), typed.values()) : answerText(response);
         }),
-        tool('impeccable_ask', 'Ask the person', 'Ask the person one question in a dialog, and wait for the answer; the web page shows the run waiting meanwhile. Answers {"value": "…"} for text and single, {"values": […]} for multi, {"confirmed": true} for confirm, {"username": "…", "password": "secret:…"} for account, or {"skipped": true}. A host\'s setup question (id "vercel-setup", "vercel-team", "netlify-setup" or "netlify-team") is worded by this tool: give it that id and its kind. So is the apps question on a repository with several apps (id "apps", kind "multi"), which lists the state\'s apps itself, has no Skip, and answers {"values": […]} (at least one app) or {"values": [key], "named": true} when the command was started for that app (it shows one confirm screen naming the app instead of the list, and the list when the person asks for other apps there); where no answer comes, nothing is written and the run ends. netlify-setup and vercel-setup are the host\'s sign-in: it shows its screen only when that CLI is signed out, signs the person in through the browser with a retry, and answers {"confirmed": true, "signedIn": true}, with "team" (the one the project goes into) or "teams" to choose from when the person has several, {"confirmed": true, "cli": "missing"} when the CLI is to be installed first and this asked again, or {"skipped": true}.', ASK, async (p, pi, signal) => {
+        tool('impeccable_ask', 'Ask the person', 'Ask the person one question in a dialog, and wait for the answer; the web page shows the run waiting meanwhile. Ask only when the run needs their answer, with a prompt that says what they answer or agree to: it refuses one of fewer than two words. Answers {"value": "…"} for text and single, {"values": […]} for multi, {"confirmed": true} for confirm, {"username": "…", "password": "secret:…"} for account, or {"skipped": true}. A host\'s setup question (id "vercel-setup", "vercel-team", "netlify-setup" or "netlify-team") is worded by this tool: give it that id and its kind. So is the apps question on a repository with several apps (id "apps", kind "multi"), which lists the state\'s apps itself, has no Skip, and answers {"values": […]} (at least one app) or {"values": [key], "named": true} when the command was started for that app (it shows one confirm screen naming the app instead of the list, and the list when the person asks for other apps there); where no answer comes, nothing is written and the run ends. netlify-setup and vercel-setup are the host\'s sign-in: it shows its screen only when that CLI is signed out, signs the person in through the browser with a retry, and answers {"confirmed": true, "signedIn": true}, with "team" (the one the project goes into) or "teams" to choose from when the person has several, {"confirmed": true, "cli": "missing"} when the CLI is to be installed first and this asked again, or {"skipped": true}.', ASK, async (p, pi, signal) => {
             // A skip never stops the run, so every question offers one, but the apps question, which needs at least one app (#405).
             const { appKey: forApp, ...asked } = p;
             if (asked.id === APPS_QUESTION.id && appsRepo)

package/dist/ui/look.js

@@ -1,5 +1,5 @@
 import { truncateToWidth, visibleWidth, wrapTextWithAnsi } from '@earendil-works/pi-tui';
-import { fitsTask, taskInProgress, workStarted } from '../stages.js';
+import { fitsTask, stagesOf, taskInProgress, workStarted } from '../stages.js';
 /**
  * How the wizard's screens look, drawn as lines from what they show and the
  * terminal's size, with no terminal behind them: the smoke renders every
@@ -270,12 +270,17 @@ function runPage(scene, f, inner, st) {
                             : '○';
         const ink = t.status === 'in_progress' || t.status === 'failed' ? st.full : t.status === 'skipped' ? st.faint : st.soft;
         const row = (detail) => `${mark} ${t.title}${detail ? ` · ${detail}` : ''}`;
-        return { ink, row, line: t.status === 'skipped' || t.status === 'failed' ? row(t.status) : row() };
+        // Preview method back to pending while Test drive runs waits for the test drive's preview, which proves the method, as the playbook's Tasks rule says: its row says so, so its work never reads as undone (REN-1255).
+        const proving = t.started && t.status === 'pending' && running >= 0 && stagesOf(t.title).includes('Preview method') && stagesOf(scene.tasks[running].title).includes('Pull requests');
+        return { ink, row, line: t.status === 'skipped' || t.status === 'failed' ? row(t.status) : row(), proving };
     });
-    // The list's left edge is set by the rows without the wait's words, so it stays put while a wait comes and goes (#390).
+    // The list's left edge is set by the rows without the wait's words or the method's, so it stays put while they come and go (#390).
     const widest = Math.max(...rows.map(({ line }) => visibleWidth(line)));
     const room = inner - Math.max(0, Math.floor((inner - Math.min(widest, inner)) / 2));
-    const lines = rows.map(({ ink, row, line }, i) => {
+    const lines = rows.map(({ ink, row, line, proving }, i) => {
+        // The words that fit from the list's edge, shorter at a narrow width, and none where even those would be cut.
+        if (proving)
+            return ink(['finishes with the test drive', 'with the test drive'].map(row).find((words) => visibleWidth(words) <= room) ?? line);
         if (i !== running || !scene.wait)
             return ink(line);
         // The task in progress says what the run waits for and the time so far, never how long it may wait, so a screen

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@impeccable/reviews",
-  "version": "0.1.35",
+  "version": "0.1.36",
   "description": "Set up a repository for Impeccable for PRs from your terminal.",
   "license": "SEE LICENSE IN LICENSE",
   "private": false,