node.js如何制做命令行工具（一）

以前使用过一些全局安装的NPM包，安装完以后，能够经过其提供的命令，完成一些任务。好比Fis3，能够经过fis3 server start 开启fis的静态文件服务，经过fis3 release开启文件编译与发布；还有vue-cli，能够经过vue init webpack my-project来初始化vue+webpack的项目基础配置。最近有一个需求，须要写一个相似vue-cli的NPM包，经过命令行操做实现项目初始配置，因此就查看了相关资料，学习了一下如何使用node来生成本身的命令。

编写命令行

命令的目标：在当前目录下开启一个静态文件服务,端口号为8085

1.建立目录

构成命令的基础是须要一个命令文件web.js和package.json配置文件，执行如下命令：

$ mkdir node-commander #建立一个文件夹
$ cd node-commander && mkdir bin
$ npm init #初始化package.json文件
$ cd bin && touch web.js  #建立命令文件

2.命令文件

#!/usr/bin/env node

var express = require('express');
var path = process.cwd();

function run(argv) {
    if (argv[0] === '-v' || argv[0] === '--version') {
        console.log('version is 1.0.0');
    }
    else if (argv[0] === '-h' || argv[0] === '--help') {
        console.log('usage:\n');
        console.log('-v --version [show version]')
    }
    else if (argv[0] === '-s' || argv[0] === '--start') {
        var app = new express();
        app.use('/static', express.static(path));
        app.listen(8085, function () {
            console.log('server start at port 8085');
        });
    }
}

run(process.argv.slice(2));　　

 

文件的头部务必加入#!/usr/bin/env node这行代码，这里表示使用node做为脚本的解释程序，node的路径经过env来查找，能够避免node安装路径不一带来的问题。

其中process为node进程中的全局变量，process.argv为一数组，数组内存储着命令行的各个部分，argv[0]为node的安装路径，argv[1]为主模块文件路劲，剩下为子命令或参数，以下：

node ./bin/web.js a b c
# process.argv的值为[ '/usr/local/bin/node', '/PATH/web.js', 'a', 'b', 'c' ]

　　

3.命令配置

在package.json文件中添加bin字段：

"bin": { 
    "web": "./bin/web.js"
  },　　

 

bin字段的做用：当安装npm包时，npm将添加一条命令/usr/local/bin/web，web命令软链接到web.js文件。

 

调试命令行

（1）采用install方法

进入npm包目录下，执行全局install，根据package.json中bin的配置，为全局命令建立软连。

 #  sudo npm install . -g
/usr/local/bin/web -> /usr/local/lib/node_modules/cli-demo/bin/web.js

/usr/local/lib

`-- cli-demo@1.0.0
...

查看web命令

#  which web                
/usr/local/bin/web　　

 

执行web命令

#  web --start
server start at port 8085

 

（2）采用npm link方法

npm link方法建立了两个软连，命令与命令文件的软连，全局包与实际包文件的软连。

# sudo npm link

/usr/local/bin/web -> /usr/local/lib/node_modules/cli-demo/bin/web.js
/usr/local/lib/node_modules/cli-demo -> /Users/baidu/hwm/home/demos/node/node-commander　　

 

接下来能够按照方法（1）进行操做了。

发布命令包

经过npm publish进行发布，前提是有npm账号。如何操做能够查看npm 官方文档。

 

本文是经过原生node.js来开发命令工具，而vue-cli是采用commander.js来简化命令工具开发，关于commander.js的使用方法，将在下一篇文章中介绍。