audrey-jaskit

Scion for audrey-two VCCLI (View-Control-->Command-Line-Interface) ^v2.0.0

What this scion does?

Use it to ask in CLI and write the user's answers into a file. More or less, as npm init command.

Specifications

Audrey-two version 2.0.0 change the way of control your CLI-views. The tags. Now taggies replaced by custom audrey-seeds. This seeds can be included or not in your projects.

Install

Example

$ npm install --save audrey-two
$ npm install --save audrey-jaskit

Usage

Bind/feed VCCLI (audrey-two) to audrey-jaskit scion.

audrey.feed("audrey-jaskit-x?");//tag must be "X"

Write on your audrey-object-view an array of questions or strings that will be displayed to the user.

Example

var arrayObject=["Does it have to be human?", "does it have to be mine?"];

var myTerminalDisplay={
    body:["x?askSome"],//tell audrey where you want to display it
    askSome: {header: "This is audrey-jaskit",
              prompt: "$ " ,  // if you want to add a prompt sign or string before every question
              data: arrayObject, //questions in one array
              to: "myFile.txt", //the path of a destination file
              confirmation:"Are everithing all rigth? \n y or n", //custom confirmation finally question
              format: arrayOfFormatObjects //look at the format actions
            }, //assign questions to audrey-view
    colors:{askSome: "green" // also chalkColors is supported}
};

var audrey2= require('audrey-two');
var audrey= audrey2('nameOfView', myTerminalDisplay);//pass the view to audrey

audrey.seed(["audrey-audrey-jaskit-x?"]);//tell audrey that there is a new seed
audrey.encore();//run audrey to display view

You will see something like this

Format actions

audrey-jaskit as jaskit module, give you the chance of preformat the answers before it'll be writted on the file. This could be usefull for making JSON files or other staff.

Every answer is writted on a different line so you can add things, before the user text, after or replace things on the user text.

Example

var arrayOfFormatObjects=[{
    question: 1, // number of question you want to format in stdrd array numeration
    before: "{", //add something before user answer
    after: " }", //"     "         after  "     "
    replace: /fine/, //regular expresion to find and replace with
    put: "Ok.." //the text inserted instead of regular expresion match
}]

Remember

Use the x as first character of the taggy.

License

MIT © Lucas_C/llucbrell