-
Notifications
You must be signed in to change notification settings - Fork 73
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #968 from oclif/mdonnalley/revert-prompt
fix: revert to original prompt implementation
- Loading branch information
Showing
3 changed files
with
79 additions
and
93 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,76 +1,73 @@ | ||
| import {expect} from 'chai' | ||
| import readline from 'node:readline' | ||
| import {SinonSandbox, createSandbox} from 'sinon' | ||
| import * as chai from 'chai' | ||
|
|
||
| const {expect} = chai | ||
|
|
||
| import {ux} from '../../src/cli-ux' | ||
| import {fancy} from './fancy' | ||
|
|
||
| describe('prompt', () => { | ||
| let sandbox: SinonSandbox | ||
|
|
||
| function stubReadline(answers: string[]) { | ||
| let callCount = 0 | ||
| sandbox.stub(readline, 'createInterface').returns({ | ||
| // @ts-expect-error because we're stubbing | ||
| async question(_message, opts, cb) { | ||
| callCount += 1 | ||
| cb(answers[callCount - 1]) | ||
| }, | ||
| close() {}, | ||
| fancy | ||
| .stdout() | ||
| .stderr() | ||
| .end('requires input', async () => { | ||
| const promptPromise = ux.prompt('Require input?') | ||
| process.stdin.emit('data', '') | ||
| process.stdin.emit('data', 'answer') | ||
| const answer = await promptPromise | ||
| await ux.done() | ||
| expect(answer).to.equal('answer') | ||
| }) | ||
| } | ||
|
|
||
| beforeEach(() => { | ||
| sandbox = createSandbox() | ||
| }) | ||
|
|
||
| afterEach(() => { | ||
| sandbox.restore() | ||
| }) | ||
|
|
||
| it('should require input', async () => { | ||
| stubReadline(['', '', 'answer']) | ||
| const answer = await ux.prompt('Require input?') | ||
| expect(answer).to.equal('answer') | ||
| }) | ||
|
|
||
| it('should not require input if required = false', async () => { | ||
| stubReadline(['']) | ||
| const answer = await ux.prompt('Require input?', {required: false}) | ||
| expect(answer).to.equal('') | ||
| }) | ||
|
|
||
| it('should use default input', async () => { | ||
| stubReadline(['']) | ||
| const answer = await ux.prompt('Require input?', {default: 'default'}) | ||
| expect(answer).to.equal('default') | ||
| }) | ||
| fancy | ||
| .stdout() | ||
| .stderr() | ||
| .stdin('y') | ||
| .end('confirm', async () => { | ||
| const promptPromise = ux.confirm('yes/no?') | ||
| const answer = await promptPromise | ||
| await ux.done() | ||
| expect(answer).to.equal(true) | ||
| }) | ||
|
|
||
| it('should timeout after provided timeout', async () => { | ||
| stubReadline(['']) | ||
| sandbox.stub(process, 'stdin').value({isTTY: true}) | ||
| try { | ||
| await ux.prompt('Require input?', {timeout: 10}) | ||
| expect.fail('should have thrown') | ||
| } catch (error: any) { | ||
| expect(error.message).to.equal('Prompt timeout') | ||
| } | ||
| }) | ||
| fancy | ||
| .stdout() | ||
| .stderr() | ||
| .stdin('n') | ||
| .end('confirm', async () => { | ||
| const promptPromise = ux.confirm('yes/no?') | ||
| const answer = await promptPromise | ||
| await ux.done() | ||
| expect(answer).to.equal(false) | ||
| }) | ||
|
|
||
| it('should confirm with y', async () => { | ||
| stubReadline(['y']) | ||
| const answer = await ux.confirm('yes/no?') | ||
| expect(answer).to.equal(true) | ||
| }) | ||
| fancy | ||
| .stdout() | ||
| .stderr() | ||
| .stdin('x') | ||
| .end('gets anykey', async () => { | ||
| const promptPromise = ux.anykey() | ||
| const answer = await promptPromise | ||
| await ux.done() | ||
| expect(answer).to.equal('x') | ||
| }) | ||
|
|
||
| it('should confirm with n', async () => { | ||
| stubReadline(['n']) | ||
| const answer = await ux.confirm('yes/no?') | ||
| expect(answer).to.equal(false) | ||
| }) | ||
| fancy | ||
| .stdout() | ||
| .stderr() | ||
| .end('does not require input', async () => { | ||
| const promptPromise = ux.prompt('Require input?', { | ||
| required: false, | ||
| }) | ||
| process.stdin.emit('data', '') | ||
| const answer = await promptPromise | ||
| await ux.done() | ||
| expect(answer).to.equal('') | ||
| }) | ||
|
|
||
| it('should get anykey', async () => { | ||
| stubReadline(['x']) | ||
| const answer = await ux.anykey() | ||
| expect(answer).to.equal('x') | ||
| }) | ||
| fancy | ||
| .stdout() | ||
| .stderr() | ||
| .it('timeouts with no input', async () => { | ||
| await expect(ux.prompt('Require input?', {timeout: 1})).to.eventually.be.rejectedWith('Prompt timeout') | ||
| }) | ||
| }) |