asks

2019-10-20 admin

asks是什么

什么是asks,An altered fork of inquirer.js, a collection of common interactive command line user interfaces.

asks使用教程帮助文档

asks npm tests dependencies

A collection of common interactive command line user interfaces.

This is an altered fork of inquirer.js. Thanks Simon Boudrias for the awesome package.

  • this.async() is now available for .default function.
  • fixes the bug that filter() will be executed more than once.

Goal and philosophy

We strive at providing easily embeddable and beautiful command line interface for Node.js; some hope in becoming the CLI Xanadu.

Inquirer should ease the process of asking end user questions, parsing, validating answers, managing hierarchical prompts and providing error feedback.

Inquirer provide the user interface, and the inquiry session flow. If you’re searching for a full blown command line program utility, then check out Commander.js (inspired by) or cli-color (used internally).

Documentation

Installation

npm install asks --save
var asks = require("asks");
asks.prompt([/* Pass your questions in here */], function( answers ) {
  // Use user feedback for... whatever!!
});

Examples (Run it and see it)

Checkout the examples/ folder for code and interface examples.

node examples/pizza.js
node examples/checkbox.js
# etc...

Methods

asks.prompt( questions, callback )

Launch the prompt interface (inquiry session)

  • questions (Array) containing Question Object
  • callback (Function) first parameter is the Answers Object

Objects

Question

A question object is a hash containing question related values:

  • type: (String) Type of the prompt. Defaults: input - Possible values: input, confirm, list, rawlist
  • name: (String) The name to use when storing the answer in the anwers hash.
  • message: (String) The question to print.
  • default: (String|Number|Array|Function) Default value(s) to use if nothing is entered, or a function that returns the default value(s). If defined as a function, the first parameter will be the current asks session answers.
  • choices: (Array|Function) Choices array or a function returning a choices array. If defined as a function, the first parameter will be the current asks session answers. Array values can be simple strings, or objects containing a name (to display) and a value properties (to save in the answers hash). Values can also be a Separator.
  • validate: (Function) Receive the user input and should return true if the value is valid, and an error message (String) otherwise. If false is returned, a default error message is provided.
  • filter: (Function) Receive the user input and return the filtered value to be used inside the program. The value returned will be added to the Answers hash.
  • when: (Function) Receive the current user answers hash and should return true or false depending on whether or not this question should be asked.

default(if defined as a function), validate, filter and when functions can be asynchronously using this.async(). You just have to pass the value you’d normally return to the callback option.

{
  default: function(answers){
    var done = this.async();
    getAsynchronously(function(value){
      done(value);
    });
  },
  validate: function(input) {

    // Declare function as asynchronous, and save the done callback
    var done = this.async();

    // Do async stuff
    setTimeout(function() {
      if (typeof input !== "number") {
        // Pass the return value in the done callback
        done("You need to provide a number");
        return;
      }
      // Pass the return value in the done callback
      done(null);
    }, 3000);
  }
}

Answers

A key/value hash containing the client answers in each prompt.

  • Key The name property of the question object
  • Value (Depends on the prompt)
    • confirm: (Boolean)
    • input : User input (filtered if filter is defined) (String)
    • rawlist, list : Selected choice value (or name if no value specified) (String)

Separator

A separator can be added to any choices array:

// In the question object
choices: [ "Choice A", new asks.Separator(), "choice B" ]

// Which'll be displayed this way
[?] What do you want to do?
 > Order a pizza
   Make a reservation
   --------
   Ask opening hours
   Talk to the receptionnist

The constructor takes a facultative String value that’ll be use as the separator. If omitted, the separator will be --------.

Separator instances have a property type equal to separator. This should allow tools façading Inquirer interface from detecting separator types in lists.

Prompts type

Note:: allowed options written inside square brackets ([]) are optional. Others are required.

List - { type: "list" }

Take type, name, message, choices[, default, filter] properties. (Note that default must be the choice index in the array or a choice value)

List prompt


Raw List - { type: "rawlist" }

Take type, name, message, choices[, default, filter] properties. (Note that default must the choice index in the array)

Raw list prompt


Expand - { type: "expand" }

Take type, name, message, choices[, default, filter] properties. (Note that default must be the choice index in the array)

Note that the choice object will take an extra parameter called key for the expand prompt. This parameter must be a single (lowercased) character. The h option is added by the prompt and shouldn’t be defined by the user.

See examples/expand.js for a running example.

Expand prompt closed Expand prompt expanded


Checkbox - { type: "checkbox" }

Take type, name, message, choices[, filter, validate, default] properties. default is expected to be an Array of the checked choices value.

Choices marked as { checked: true } will be checked by default.

Choices who’re property disabled is truthy will be unselectable. If disabled is a string, then the string will be outputed next to the disabled choice, otherwise it’ll default to "Disabled". The disabled property can also be a synchronous function receiving the current answers as argument and returning a boolean or a string.

Checkbox prompt


Confirm - { type: "confirm" }

Take type, name, message[, default] properties. default is expected to be a boolean if used.

Confirm prompt


Input - { type: "input" }

Take type, name, message[, default, filter, validate] properties.

Input prompt


Password - { type: "password" }

Take type, name, message[, default, filter, validate] properties.

Password prompt

User Interfaces and layouts

Along with the prompts, Inquirer offers some basic text UI.

Bottom Bar - asks.ui.BottomBar

This UI present a fixed text at the bottom of a free text zone. This is useful to keep a message to the bottom of the screen while outputting command outputs on the higher section.

var ui = new asks.ui.BottomBar();

// pipe a Stream to the log zone
outputStream.pipe( ui.log );

// Or simply write output
ui.log.write("something just happened.");
ui.log.write("Almost over, standby!");

// During processing, update the bottom bar content to display a loader
// or output a progress bar, etc
ui.updateBottomBar("new bottom bar content");

Prompt - asks.ui.Prompt

This is UI layout used to run prompt. This layout is returned by asks.prompt and you should probably always use asks.prompt to interface with this UI.

Support (OS Terminals)

You should expect mostly good support for the CLI below. This does not mean we won’t look at issues found on other command line - feel free to report any!

  • Mac OS:
    • Terminal.app
    • iTerm
  • Windows:
    • cmd.exe
    • Powershell
    • Cygwin
  • Ubuntu:
    • Terminal

News on the march (Release notes)

Please refer to the Github releases section for the changelog

Contributing

Style Guide Please brief yourself on Idiomatic.js style guide with two space indent

Unit test Unit test are written in Mocha. Please add a unit test for every new feature or bug fix. npm test to run the test suite.

Documentation Add documentation for every API change. Feel free to send corrections or better docs!

Pull Requests Send fixes PR on the master branch. Any new features should be send on the wipbranch.

We’re looking to offer good support for multiple prompts and environments. If you want to help, we’d like to keep a list of testers for each terminal/OS so we can contact you and get feedback before release. Let us know if you want to be added to the list (just tweet to @vaxilart) or just add your name to the wiki

License

Copyright © 2012 Simon Boudrias (twitter: @vaxilart) Altered by Kael (@kaelzhang) Licensed under the MIT license.

本站文章除注明转载外,均为本站原创或编译。欢迎任何形式的转载,但请务必注明出处。

转载请注明:文章转载自 JavaScript中文网 [https://www.javascriptcn.com]

本文地址:https://www.javascriptcn.com/read-77818.html

文章标题:asks

相关文章
rx-grunt-tasks
rx-grunt-tasks是什么 什么是rx-grunt-tasks,To start using corporate grunt tasks: rx-grunt-tasks官网:官网 rx-grunt-tasks源码仓库:源码仓库 r...
2019-07-28
gulp-evrythng-tasks
gulp-evrythng-tasks是什么 什么是gulp-evrythng-tasks,Common dev tasks framework using Gulp 4 for evrythng.js and plugins. gulp...
2019-06-16
gulp-import-tasks
gulp-import-tasks是什么 什么是gulp-import-tasks,Import tasks from a local directory, rather than from your gulpfile. gulp-imp...
2019-06-04
grunt-available-tasks
grunt-available-tasks是什么 什么是grunt-available-tasks,List available Grunt tasks & targets. grunt-available-tasks官网:官网 ...
2019-07-30
grunt-fenbi-tasks
grunt-fenbi-tasks是什么 什么是grunt-fenbi-tasks,Grunt tasks used by fenbi.com. grunt-fenbi-tasks官网:官网 grunt-fenbi-tasks源码仓库:源...
2019-10-13
ucd-theme-tasks
ucd-theme-tasks是什么 什么是ucd-theme-tasks,Base automation for compiling a UCD frontend. ucd-theme-tasks官网:官网 ucd-theme-task...
2019-11-14
回到顶部