CLI Wizard utility, with promises
Prophet helps you create CLI wizards for your application. A Wizard who makes promises : a prophet.
npm install --save prophet-cli
var prophet = require('prophet-cli')
prophet()
.then(firstStep)
.then(secondStep)
.then(lastStep)
.then(successCallback, errorCallback)Steps are just regular success handlers for promises which take a context object
as parameter and must return the same context object. They are allowed to mutate it
Prophet can help you define such steps.
var firstStep = prophet.value('name', {
prompt: "What's your name?",
accept: (name) => name.length < 24,
})
var secondStep = prophet.value('nickname', {
default: ({name}) => dasherize(name).toLowerCase()
prompt: 'What is your nickname?',
accept: [/^[a-z]+$/, isNicknameTaken] // isNicknameTaken can return either a value or a promise
})
var lastStep = prophet.action('created', {
action: ({name, nickname}) => users.create({name, nickname}).then(user => true)
})
prophet()
.then(firstStep) // ex. "Florent Jaby"
.then(secondStep) // ex. "floby"
.then(lastStep) // let's assume success
.then(values => {
console.log(values)
/*
{
name: 'Florent Jaby',
nickname: 'floby',
created: true
}
*/
})
.catch(error => {
console.error(error.message)
process.exit(1)
})Simple wizards can be as simple as
prophet()
.then(prophet.value('first name'))
.then(prophet.value('last name'))
.then(prophet.value('occupation'))
.then(success)You can run the tests with npm test. You will need to know mocha
Anyone is welcome to submit issues and pull requests
Copyright (c) 2016 Florent Jaby
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.