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的使用方法,将在下一篇文章中介绍。

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

发表于

我来说两句

0 条评论
登录 后参与评论

相关文章

来自专栏谢易成的专栏

动态构建的多页面vue-cli模版

vue官方提供了几个vue cli的模版,但都单页面模版,然而在真实的业务场景下还是有多页面模版的需求,百度和google上都能搜索到不少单页面模版改多页面模版...

19340
来自专栏python读书笔记

python 数据分析基础 day6-xlrd,xlwt读写单个excel

今天的内容为使用xlrd和xlwt这两个模块来读取单个excel文件, 思路和读取csv文件大致相同,分别设置输入和输出的excel文件对象,然后遍历输入对象...

36870
来自专栏逻辑熊猫带你玩Python

“聊一聊Linux的工作环境”

由于Linux采用了和Windows不同的文件系统,所以和Windows用户熟悉的文件管理模式不通,这里来简单说说Linux的根("/")目录下目录的用途

9220
来自专栏菜鸟程序员

MySQL 数据备份与还原

15480
来自专栏pangguoming

备份VMware虚拟磁盘文件 移植到其他虚拟机

原文:http://jingyan.baidu.com/article/a681b0de17b3173b1843468f.html

44420
来自专栏SpringBoot 核心技术

第十八章:SpringBoot项目中使用SpringSecurity整合OAuth2设计项目API安全接口服务

63540
来自专栏FreeBuf

利用Volatility查找系统中的恶意DLL

昨天看到@白河·愁 发了《Linux下内存取证工具Volatility的使用》,今天恰好看到一篇Volatility利用的文章,文章不长,就翻译了过来。 原文地...

21280
来自专栏SpringBoot 核心技术

第二十三章:SpringBoot项目多模块打包与部署

50330
来自专栏运维小白

7.8/7.9 源码包安装

源码包安装目录概要 cd /usr/local/src/ wget http://mirrors.cnnic.cn/apache/httpd/httpd-2.2...

19260
来自专栏白驹过隙

Samba - 文件共享服务器的搭建和配置

509140

扫码关注云+社区

领取腾讯云代金券