67 lines
3.5 KiB
Markdown
67 lines
3.5 KiB
Markdown
# @push.rocks/smartinteract
|
|
smart cli interaction
|
|
|
|
## Availabililty and Links
|
|
* [npmjs.org (npm package)](https://www.npmjs.com/package/@push.rocks/smartinteract)
|
|
* [gitlab.com (source)](https://gitlab.com/push.rocks/smartinteract)
|
|
* [github.com (source mirror)](https://github.com/push.rocks/smartinteract)
|
|
* [docs (typedoc)](https://push.rocks.gitlab.io/smartinteract/)
|
|
|
|
## Status for master
|
|
|
|
Status Category | Status Badge
|
|
-- | --
|
|
GitLab Pipelines | [](https://lossless.cloud)
|
|
GitLab Pipline Test Coverage | [](https://lossless.cloud)
|
|
npm | [](https://lossless.cloud)
|
|
Snyk | [](https://lossless.cloud)
|
|
TypeScript Support | [](https://lossless.cloud)
|
|
node Support | [](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
|
Code Style | [](https://lossless.cloud)
|
|
PackagePhobia (total standalone install weight) | [](https://lossless.cloud)
|
|
PackagePhobia (package size on registry) | [](https://lossless.cloud)
|
|
BundlePhobia (total size when bundled) | [](https://lossless.cloud)
|
|
|
|
## Usage
|
|
|
|
Use TypeScript for best in class instellisense.
|
|
|
|
```javascript
|
|
import { SmartInteract } from 'smartinteract'
|
|
|
|
let myInteract = new SmartInteract([{ // note: its an array. You can specify multiple questions
|
|
name: 'question1',
|
|
type: 'input',
|
|
message: 'Who are you?',
|
|
default: 'Somebody',
|
|
validate: (inputString) => { return true } // implement your own validation
|
|
}])
|
|
myInteract.addQuestions([ ... ]) // add more questions
|
|
myInteract.runQueue()
|
|
.then(answerBucket => { // the bucket has all the answers of the completed queue
|
|
let answerQuestion1 = answerBucket.getAnswerFor('question1')
|
|
// do something with the answers
|
|
})
|
|
|
|
// alternatively use .askQuestion() for more direct control
|
|
myInteract.askQuestion{ // note: its an array. You can specify multiple questions
|
|
name: 'question2',
|
|
type: 'confirm',
|
|
message: 'Do you speak English?',
|
|
default: true,
|
|
validate: (inputString) => { return true } // implement your own validation
|
|
}().then(answerObject => {
|
|
// answerObject looks like { name: 'question2', value: true }
|
|
})
|
|
```
|
|
|
|
## Contribution
|
|
|
|
We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
|
|
|
|
For further information read the linked docs at the top of this readme.
|
|
|
|
## Legal
|
|
> MIT licensed | **©** [Task Venture Capital GmbH](https://task.vc)
|
|
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
|