Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/damonoehlman/climate

EXPERIMENTAL: Eve magic for console / prompt interaction
https://github.com/damonoehlman/climate

Last synced: 7 days ago
JSON representation

EXPERIMENTAL: Eve magic for console / prompt interaction

Awesome Lists containing this project

README 

        
# climate



Created because (rightly *or* wrongly) I'm frustrated with number of

dependencies that existing prompt, cli, etc libraries have.  There's

some great ideas out there, but I'm not really up for having a page

of dependencies install for a library that could be included as part

of a cli script.



This is very alpha, experimental, etc, and parts of it will almost

certainly change.



[![NPM](https://nodei.co/npm/climate.png)](https://nodei.co/npm/climate/)



## Example Usage



```js

var climate = require('climate');



climate

  .prompt('How are you?')

  .receive('great', function() {

    console.log('That\'s great!!');

  })

  .prompt('How old are you?')

  .receive('*', function(input) {

    console.log(input + ' eh?');

  })

  .end(process.exit);



```



The above example will also work quite happily if provided the input

as STDIN:



```

node examples/multiquestion.js < examples/multiquestion.in.txt

```



## Design Goals



- Should work with streams other than ``process.stdin``

- Should expect only the stdin stream, not necessarily a tty (but adapt well for a tty)

- Should be able to pipe and redirect stdin using both ``|`` and ``<``

- You choose to color your world, not me



## Getting Started



This guide will walk you through the process of creating a simple interactive command line script using climate.



### Prompting for Data



If you are writing an interactive console script or application, then it's likely you will be asking your users for data at some point in time. In climate this is done using the ``prompt`` function, e.g.:



<<< examples/getting-started/01-prompting.js



Running this example, would simply display the prompt "How are you?", wait for your response (a single line entry, ending with a carriage return) and then exit.  Not particularly useful, but it's a start.



### Receiving Responses



To do something with a response returned from a user, you simply start adding receive handlers:



<<< examples/getting-started/02-simple-receive.js



Additionally, because climate uses `eve` eventing under the hood, simple wildcard matching is also supported:



<<< examples/getting-started/03-wildcard-receive.js



### Using Fallback Response Handlers



While you can use wildcard response handlers to deal with unexpected response conditions, fallback response handlers are a more effective way to do this:



<<< examples/getting-started/04-fallback-handlers.js



So in the example above, if you respond with "well" then receive the response for that specific condition.  Any other response will receive the fallback response.



These three concepts of prompting, handling expected responses and using fallback handlers cover the core functionality of climate.



## License(s)



### MIT



Copyright (c) 2014 Damon Oehlman 



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.