fix: handle verifyDepsBeforeRun prompt in non-TTY environments (#10903)

* fix: handle verifyDepsBeforeRun prompt in non-TTY environments

In non-interactive environments like CI, verifyDepsBeforeRun: 'prompt' would
silently exit with code 0 even when node_modules were out of sync. This could
cause tests to pass when they should fail.

Now, pnpm throws an error in non-TTY environments, alerting users that they
need to run 'pnpm install' first.

Also handles Ctrl+C gracefully during the prompt - exits cleanly without
showing a stack trace.

Fixes #10889
Fixes #10888

* fix: improve Ctrl+C handling and fix prompt TTY guard

- Replace brittle ERR_USE_AFTER_CLOSE check with generic catch for prompt
  cancellation (enquirer rejects with empty string on Ctrl+C, not that error)
- Fix prompt test to mock isTTY=true since Jest runs in non-TTY environment
- Fix test description "noTTY" → "non-TTY"

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

* fix: narrow try/catch to only wrap enquirer.prompt

Avoid catching errors from install() which should propagate normally.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

---------

Co-authored-by: zubeyralmaho <zubeyralmaho@users.noreply.github.com>
Co-authored-by: Zoltan Kochan <z@kochan.io>
Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
zybo
2026-03-13 15:00:12 +03:00
committed by GitHub
parent 5d5818e44f
commit 61f94906ea
3 changed files with 63 additions and 7 deletions

View File

@@ -0,0 +1,14 @@
---
"@pnpm/plugin-commands-script-runners": patch
"pnpm": patch
---
Handle non-TTY environments correctly when using `verifyDepsBeforeRun: prompt`.
Previously, in non-interactive environments like CI, using `verifyDepsBeforeRun: prompt` would silently exit with code 0 even when node_modules were out of sync. This could cause tests to pass even when they should fail.
Now, pnpm will throw an error in non-TTY environments, alerting users that they need to run `pnpm install` first.
Also handles Ctrl+C gracefully during the prompt - exits cleanly without showing a stack trace.
Fixes #10889, #10888

View File

@@ -27,14 +27,28 @@ export async function runDepsStatusCheck (opts: RunDepsStatusCheckOptions): Prom
install()
break
case 'prompt': {
const confirmed = await enquirer.prompt<{ runInstall: boolean }>({
type: 'confirm',
name: 'runInstall',
message: `Your "node_modules" directory is out of sync with the "pnpm-lock.yaml" file. This can lead to issues during scripts execution.
// In non-TTY environments (like CI), we can't prompt the user
// Exit with error to alert users that node_modules are out of sync
if (!process.stdin.isTTY) {
throw new PnpmError('VERIFY_DEPS_BEFORE_RUN', issue ?? 'Your node_modules are out of sync with your lockfile', {
hint: 'Run "pnpm install" before running scripts. The "verifyDepsBeforeRun: prompt" setting cannot prompt for confirmation in non-interactive environments.',
})
}
let confirmed: { runInstall: boolean }
try {
confirmed = await enquirer.prompt<{ runInstall: boolean }>({
type: 'confirm',
name: 'runInstall',
message: `Your "node_modules" directory is out of sync with the "pnpm-lock.yaml" file. This can lead to issues during scripts execution.
Would you like to run "pnpm ${command.join(' ')}" to update your "node_modules"?`,
initial: true,
})
initial: true,
})
} catch {
// User cancelled the prompt (e.g. Ctrl+C) — exit immediately
// so the caller doesn't proceed to run the script.
process.exit(1)
}
if (confirmed.runInstall) {
install()
}

View File

@@ -88,7 +88,14 @@ test('prompt the user if verifyDepsBeforeRun is set to prompt', async () => {
// Mock the user confirming the prompt
jest.mocked(enquirer.prompt).mockResolvedValue({ runInstall: true })
await runTest('prompt')
const originalIsTTY = process.stdin.isTTY
Object.defineProperty(process.stdin, 'isTTY', { value: true, configurable: true })
try {
await runTest('prompt')
} finally {
Object.defineProperty(process.stdin, 'isTTY', { value: originalIsTTY, configurable: true })
}
expect(enquirer.prompt).toHaveBeenCalledWith({
type: 'confirm',
@@ -101,3 +108,24 @@ test('prompt the user if verifyDepsBeforeRun is set to prompt', async () => {
expect(fs.existsSync(path.resolve('node_modules'))).toBeTruthy()
})
test('throw an error if verifyDepsBeforeRun is set to prompt in non-TTY environment', async () => {
prepare(rootProjectManifest)
// Mock non-TTY environment
const originalIsTTY = process.stdin.isTTY
Object.defineProperty(process.stdin, 'isTTY', { value: false, configurable: true })
let err!: Error
try {
await runTest('prompt')
} catch (_err) {
err = _err as Error
} finally {
// Restore original value
Object.defineProperty(process.stdin, 'isTTY', { value: originalIsTTY, configurable: true })
}
expect(err.message).toContain('Cannot check whether dependencies are outdated')
expect(fs.existsSync(path.resolve('node_modules'))).toBeFalsy()
})