Repository navigation
docs: describe the Chromium install helper in the directory READMEs - #373
Conversation
The renderer READMEs list the exports and side effects of browserPath.ts and the launch of the Chromium renderer. They did not name `resolveChromiumInstallCommand` and `withChromiumInstallHint`. docs/INSTALL.md also says that the warning box of Playwright, which the pinned install command prints outside a project, can be ignored. _Generated with [`xum`](https://github.com/coder/xum) • Model: `anthropic:claude-fable-5-2` • Thinking: `xhigh`_
|
@codex review |
|
@codex security review |
Codex Review Summary: ✅ CompletedThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
|
Codex Review: Didn't find any major issues. Hooray! Reviewed commit: ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
If Codex has suggestions, it will comment; otherwise it will react with 👍. Codex can also answer questions or update the PR. Try commenting "@codex address that feedback". |
🛡️ Codex Security ReviewSecurity review completed. No security issues were found in this pull request. Reviewed commit: Only the user who started this review can view the report in Codex. ℹ️ About Codex security reviews in GitHubThis is an experimental Codex feature. Security reviews are triggered when:
Once complete, Codex will leave suggestions, or a comment if no findings are found. |
The callers sentence named both helpers, but the renderer calls only `withChromiumInstallHint`. Playwright prints its warning box whenever npx runs it from its own cache, also in a project that lacks that Playwright version, so "outside a project" was too narrow. The commands README now names the file that `doctor` reads for the install command. _Generated with [`xum`](https://github.com/coder/xum) • Model: `anthropic:claude-fable-5-2` • Thinking: `xhigh`_
|
@codex review |
|
@codex security review |
|
Codex Review: Didn't find any major issues. Nice work! Reviewed commit: ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
If Codex has suggestions, it will comment; otherwise it will react with 👍. Codex can also answer questions or update the PR. Try commenting "@codex address that feedback". |
🛡️ Codex Security ReviewSecurity review completed. No security issues were found in this pull request. Reviewed commit: Only the user who started this review can view the report in Codex. ℹ️ About Codex security reviews in GitHubThis is an experimental Codex feature. Security reviews are triggered when:
Once complete, Codex will leave suggestions, or a comment if no findings are found. |
|
Delivery record
Generated with |
Why
#370 added two helpers to
src/renderer/browserPath.tsand made the Chromium renderer launch through one of them. The directory READMEs of the renderer list the exports and side effects of these files, and they did not name the helpers. The readiness review of #370 asked for this update.The same review noted that the install command prints a warning box of Playwright. Playwright prints the box when npx runs it from the npx cache. npx does that unless it finds that Playwright version already installed, as in a project that depends on it. The box suggests
npm installand a barenpx playwright install, which is the command that the Chromium section tells readers not to use there.What changed
src/renderer/README.md: the interface list namesresolveChromiumInstallCommandandwithChromiumInstallHintwith their callers. The invariants say which error the helper changes and that every other error and result passes through. The side effects say that the command lookup readsplaywright/package.json.src/renderer/ghosttyWeb/README.md: the launch entry says thatchromium.launchruns insidewithChromiumInstallHint.src/cli/commands/README.md: the side effects ofdoctorname the read ofplaywright/package.json, whichdoctordoes to name the install command.docs/INSTALL.md: two sentences after the Chromium command block say when Playwright prints its warning box, and that the box can be ignored.Scope
Docs only. No code, test, or CLI output changes.
Blast Radius
Four Markdown files.
Verification
browserPath.ts:resolveChromiumInstallCommand,browserPath.ts:withChromiumInstallHint,backend.ts:GhosttyWebBackend.bootInternalanddoctor.ts:runBrowserCacheAccessibleCheck. The two named callers,src/cli/commands/doctor.tsandsrc/renderer/ghosttyWeb/backend.ts, both callwithChromiumInstallHint, anddoctor.tshas one direct call ofresolveChromiumInstallCommand.npx playwright@1.60.0 install chromiumandnpx playwright@1.64.1 install chromium, each run in an empty folder, printed the box (WARNING: It looks like you are running 'npx playwright install' without first installing your project's dependencies) and then installed their Chromium build. On this Ubuntu 26.04 host, the 1.60.0 run needed the platform override thatdocs/TROUBLESHOOTING.mdnames.npx playwright@1.64.1 install --dry-run chromium. An empty folder, a project without Playwright and a project with another Playwright version (1.60.0, 1.63.0 or 1.64.0, one per verifier) printed the box for each verifier. A project withplaywright@1.64.1installed did not. Two of the verifiers also ran the command in a subfolder of that project, and it printed no box there.Generated with
xum• Model:anthropic:claude-fable-5-2• Thinking:xhigh