# promptosaurus

> simple command line prompt tool

Latest version **1.1.0** (published 2015-05-21) · MIT license · 0 weekly downloads

## Install

```sh
npm install promptosaurus
pnpm add promptosaurus
yarn add promptosaurus
bun add promptosaurus
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2015-05-21 |
| First published | 2015-03-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.10.0 <=0.12.x |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Otter the Cat |
| Maintainers | otterthecat |
| Keywords | cli, prompt, dinosaurs, otc |

## Links

- npm: https://www.npmjs.com/package/promptosaurus
- Repository: https://github.com/otterthecat/promptosaurus
- Issues: https://github.com/otterthecat/promptosaurus/issues
- npm.io page: https://npm.io/package/promptosaurus

## Dependencies (1)

- [chalk](https://npm.io/package/chalk.md) ^0.5.1

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 1.1.0 (latest) — 2015-05-21
- 1.0.1 — 2015-03-22
- 0.1.0 — 2015-03-05

## README

__
                   / _)
          _.----._/ /
         /         /     PROMPTOSAURUS
      __/ (  | (  |      you bet jurassic works.
    /__.-''|_|--|_|



# Promptosaurus
NodeJS command line tool for handling prompted user input

## Usage
Promptosaurus is a constructor. Require it normally and create an instance:

```javascript
#!/usr/bin/env node
var Promptosaurus = require('promptosaurus');
var rawr = new Promptosaurus();

rawr.add('Would you like to play a game of chess (y | n)?', function(answer){

    this.hasValidResponse = (answer === 'y' || answer === 'n');
    this.log('You have responded with: ' + answer);
    this.setError('You did not answer with a "y" or "n" - try again');
})
.done(function(){
    this.log('You were asked: ' + this.queries[0].prompt);
    this.log('You responded with: ' + this.queries[0].response);
})
.ask();
```
The instance API is as follows:

### `.add(str, func)`
Adds question & callback for each prompt to display the user.
Multiple questions will require multiple calls to `add()`
The callback function is optional, and if passed, will get the user's response passed in as an argument.
If the callback is not set, then the user input will be stored in Promptosaurus and accessible from within the `.done()` function.

### `.ask()`
Used as a semantic means to kick off the queued prompts.
Will also include the "Dino Greeting" to the user to help indicate they're about to be on a rollercoaster ride to Funtown.

### `.done(func)`
Allows user to pre-define a callback once all set prompts have run.

### `.setError(string)`
Set an error message to display if the `.hasValidResponse` test fails.
If no test for `.hasValidResponse` exists for current prompt, no error message
will be shown.

### `.log(string)`
Basically just a wrapper for `process.stdout.write()`, but includes coloring of output to match other colors and whitespace of default Promptosaurus output. Accessible within callbacks via `this.log(string)`.
[See examples for more information](https://github.com/otterthecat/promptosaurus/tree/master/examples).

### `.hasValidResponse [boolean]`
Defaults to `true`. This is a flag that is used to determine if the current prompt needs to be asked again - say if the user's response is not what you were expecting. Setting this to `false` will notify the user their response wasn't acceptable, and will then ask them again for a proper response. If set to `true` (which is also the default), the user will be presented the next prompt in queue after they give a response.
[See examples for more information](https://github.com/otterthecat/promptosaurus/tree/master/examples).

#### Examples
The provided [examples](https://github.com/otterthecat/promptosaurus/tree/master/examples) should already be executable.
If not, then make them so by using `chmod`. Then, just call it normally to see it in action:

`./example/basic.js`

#### Tests
```javascript
npm install
npm test
````
#### Changelog
1.1.0
 * added `.setError()` function to display error messages.
 * extracted 'private' functions to their own file.
 * fixed watch task issue.
 * fixed lint issues.

1.0.0
 * added ability to repeat question if response is not considered valid.
 * Callback for `.done()` is no longer passed an argument in favor of direct access to `.queries` property.
 * `.queries` property has been changed from object to array.

0.1.0
 * initial release

---
_Source: https://npm.io/package/promptosaurus · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._