https://github.com/yibn2008/mock-inquirer
mock anwsers for inquirer prompt questions
https://github.com/yibn2008/mock-inquirer
inquirer mock mock-anwsers
Last synced: 7 months ago
JSON representation
mock anwsers for inquirer prompt questions
- Host: GitHub
- URL: https://github.com/yibn2008/mock-inquirer
- Owner: yibn2008
- Created: 2017-03-02T02:27:34.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2021-09-10T07:07:24.000Z (almost 4 years ago)
- Last Synced: 2024-11-04T00:51:58.217Z (7 months ago)
- Topics: inquirer, mock, mock-anwsers
- Language: JavaScript
- Size: 9.77 KB
- Stars: 5
- Watchers: 2
- Forks: 5
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: HISTORY.md
Awesome Lists containing this project
README
# mock-inquirer
mock anwsers for inquirer prompt questions
## features
- mock all inqurier instances which already loaded in current process
- mock `require('inquirer')` and return mocked inquirer instance
- work well with `npm link` which may cause `require('inqurier')` load different inquirers
*Notice: mock-inquirer only mock `inquirer.prompt` method, any advanced usage may not work*
## install
```bash
npm install mock-inquirer --save
```
## Usage
Just call `mockInquirer` and pass anwsers at anywhere.
```js
const mockInquirer = require('mock-inquirer')
const inquirer = require('inquirer')
const co = require('co')
// start mock
co(function * () {
let reset = mockInquirer([{
hello: 'world' // will auto fill 'world'
}, {
// if anwsers is empty, mockInquirer will fill with default value
}])
// prompt 2 questions
let anwsers1 = yield inquirer.prompt([{
type: 'input',
message: 'I say hello, you say:',
name: 'hello'
}])
let anwsers2 = yield inquirer.prompt([{
type: 'confirm',
message: 'mock inquirer is awesome:',
name: 'like',
default: true
}])
// print anwsers:
// { hello: 'world' }
// { like: true }
console.log(anwsers1)
console.log(anwsers2)
// reset mock
reset()
}).catch(err => {
console.error(err)
})
```
## API
### `mockInquirer(anwsersList)`
- `anwsersList`, *{Array}* anwsers list for every mocked `inquirer.prompt`
The item of `anwsersList` is a key-value anwsers object which key is `name` of questions field.
If `anwsersList` is empty, then the anwsers will be filled with default value in `inquirer.prompt` questions.
## LICENSE
MIT