关闭搜索(ESC)
搜索标签:

如何用nodejs创建命令行工具

2016-05-18 浏览:550 标签: commander nodejs

创建项目:

新建一个文件夹,假设我们取名为tbjnode

cd tbjnode

然后初始化项目

npm init

现在,我们需要修改package.json文件

1:删除main入口
2:添加preferGlobal设为true:该选项会提示用户全局安装
3:添加bin对象,用于建立索引:比如执行tbjname相当于执行index.js

修改后的package.json如下:

{
    "name": "tbjnode",
      "version": "1.0.3",
      "description": "tbj node project cli",
      "preferGlobal": true,
      "keywords": [
        "file",
        "search"
      ],
      "bin": {
        "filesearch": "index.js"
      },
      "scripts": {
        "test": "echo \"Error: no test specified\" && exit 1"
      },
      "author": "zhishui",
      "license": "ISC"
}

bin下的filesearch用来指定filesearch命令执行的文件为index.js

使用npm link,绑定全局,不用重新安装。

好了,现在我们开始写一个功能,用来查询某个文件夹下是否有指定的文件。

我们新建一个 index.js

编写如下代码:

#!/usr/bin/env node

var exec = require('child_process').exec;

// 获取用户输入内容
var userArgv = process.argv.slice(2);
var searchPath = userArgv[0];
var searchFile = userArgv[1];
var commond = "find ";

// 判断用户输入是否错误
if(userArgv.length !=2) {
    console.log("input commond link this 'filesearch filepath filename'");
} else {
    commond += searchPath + ' -iname '+ searchFile;
    var child = exec(commond, function(err, stdout, stderr) {
        if(err) {
            throw err;
        }
        console.log(stdout);
    });
}

ok。现在开始测试一下: filesearch ./ package.json。就可以看到结果了。

filesearch

但是现在TJ大神也做了一个特别酷的工具。commander

API地址: commander API

举例一个example:

新建一个文件testCommander.js

然后在bin里,添加一个索引。

bin: {
    "filesearch": "index.js",
    "testC": "testCommander.js"
}

testCommander.js写入以下代码:

#!/usr/bin/env node

var program = require('commander');

program
    .version('0.0.1')
    .option('-C, --chdir <path>', 'change the working directory')
    .option('-c, --config <path>', 'set config path. defaults to ./deploy.conf')
    .option('-T, --no-tests', 'ignore test hook')

program
    .command('setup')
    .description('run remote setup commands')
    .action(function() {
        console.log("setup");
    });

program.parse(process.argv);

执行 testC -h,就可以看到命令行结果。

commander

commander这里主要用了五个接口:

1. version: 设定版本号
2. option: 对该命令介绍以及一些参数的执行
3. command: 新增一个子命令,执行``testC setup``
4. description: 对该命令的描述
5. action: 该子命令的要执行的操作。

其他的操作请查看该文档接口。

添加评论