hemsl

v1.2.7

Published

2 years ago

A lightweight Node.js command line argv parser and command executor

Downloads

1,125

0High
0Medium
0Low

hemsl

hemsl is a lightweight Node.js command line argv parser and command executor

White flowers Komatsu, scientific name: Villadia batesii (Hemsl.) Baehni & Macbride, Sedum, Tulian perennial multi-meat plants, flowering generally 4 to 5 months. White flowers Komatsu leaves more beautiful, there is a certain ornamental value; potted plants can be placed on the TV, the computer can absorb radiation, can also be planted in the room to absorb formaldehyde and other substances, purify the air.

Install

Use `npm`

$ npm install hemsl --save

Use `yarn`

$ yarn add hemsl

Usages

Create an instance

var Args = require('hemsl');
var args = new Args();

Set app version and bin name

args
  .version('1.1.0')
  .bin('example');

Add global option

args
  .option(, {
    option: 'debug',
    default: true,
    describe: 'Print debug log (global option)',
    alias: 'd'
  })
  .option({
    option: 'grep <expression>',
    default: true,
    describe: 'Debug log filter (global option)',
    alias: 'g'
  });

Add command

args.command({
  command: 'start <port> [ip]',
  describe: 'Start a local server',
  usage: 'example start <port> [ip] [options]',
  /**
    * The `start` command handle
    * Start a local server
    */
  fn: function(port, ip){
    console.log('Server started at', 'http://' + ip + ':' + port);

    var http = require('http');

    var server = http.createServer(function(req, res){
        console.log(req.method.bold.gray, req.url);
        res.end(req.url);
    })

    server.listen(port, ip);
  }
})

Add option to command

There are two ways to add an option to a command:

Method 1: Call the args.command() method and set the configuration field options
Method 2: Call the args.command().option() method

Method 1

args.command({
  command: 'start <port> [ip]',
  describe: '...',
  usage: '...',
  fn: function(port, ip){
      //...
  },
  options: {
    'p': {
      default: '',
      describe: 'service port',
      alias: 'port',
      usage: ''
    },
    'hot-reload': {
      alias: 'H',
      describe: 'enable hot reload'
    }
  }
});

Method 2

args.command({
  command: 'start <port> [ip]', 
  // ...
})
.option({
  option: 'date-format', 
  default: 'yyyy-MM-dd',
  alias: 'R',
  describe: 'date format string'
})
.option({
  option: 'time-format',  
  alias: 'm',
  default: 'HH:mm:ss',
  describe: 'time format string'
})

Other Example

API

Classes

Args

Kind: global class

Args
- new Args(config)
- .parse([argv], [execute]) ⇒ Object
- .execute() ⇒ Args
- .option(key, config) ⇒ Args
- .command(cmd, config) ⇒ Command
- .help([cmdName]) ⇒ Args
- .version(ver) ⇒ Args
- .bin(binName) ⇒ Args

new Args(config)

参数解析

| Param | Type | Default | Description | | --- | --- | --- | --- | | config | Object | | 配置对象 | | [config.__] | Boolean | false | 是否停止解析--后面的内容 | | [config.colors] | Object | | 文本颜色配置 | | [config.colors.title] | String | 'white' | 标题文本颜色 | | [config.colors.command] | String | 'white' | 命令名称文本颜色 | | [config.colors.option] | String | 'white' | Option文本颜色 | | [config.colors.paragraph] | String | 'gray' | 段落文本颜色 | | [config.colors.parameter] | String | 'gray' | 参数文本颜色 |

args.parse([argv], [execute]) ⇒ Object

解析参数，返回解析后的参数对象。如果参数execute为true，自动执行argv中的命令

Kind: instance method of Args
Returns: Object - 解析后的对象
Access: public

| Param | Type | Default | Description | | --- | --- | --- | --- | | [argv] | Array | process.argv.slice(2) | 要解析的参数数组 | | [execute] | Boolean | false | 是否自动执行参数中的命令 |