专栏首页Young Dreamernode.js如何制作命令行工具(一)

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 条评论
登录 后参与评论

相关文章

  • 前端页面统计beacon调研

    注意xhr.open('post', '/log', false)的第三个参数, false为同步请求,也就是document unload之前必须等待请求发...

    用户1217459
  • webpack3新特性简介

    6月20号webpack推出了3.0版本,官方也发布了公告。根据公告介绍,webpack团队将未来版本的改动聚焦在社区提出的功能需求,同时将保持一个快速、稳定的...

    用户1217459
  • 基于Webkit的浏览器关键渲染路径介绍

    关键渲染路径概念 浏览器是如何将HTML、JS、CSS、image等资源渲染成可视化的页面的呢?本文简单介绍一下渲染过程中涉及到的关键步骤。 该过程分为四步:模...

    用户1217459
  • linux下安装nodejs及npm

    官网下载npm安装包,https://nodejs.org/en/,左边是稳定版右边是最新版。

    用户2038589
  • 当东方遭遇西方,机器人们都在谈什么?

    镁客网
  • 国内工业机器人领域的市场布局分析

    导读:《中国制造2025》全面启动实施,带动制造业转型升级步伐加速,工业机器人作为智能制造的重要实施基础,行业应用需求呈现爆发式增长,产业链上下游厂商纷纷加大...

    钱塘数据
  • 这个机器人不学数据集,“纯玩”get各类家务技能,LeCun觉得很赞

    伯克利的研究人员最近利用视觉模型强化学习训练了一个不一样的机器人,能够通过自己的探索,完成各种任务:整理玩具、叠衣服、收拾餐具……

    量子位
  • 让机器人抓取个衣服,为何如此难?

    加州伯克利机器人教授 Ken Goldberg 愁容满面,他不断摩挲着手中的咖啡杯,嘴里还念念有词的说道:“让机器人掌握这类数据怎么这么难啊。”如今,人工智能已...

    机器人网
  • 小兔Java教程 - 三分钟学会Java文件上传

    剽悍一小兔
  • 网红机器人公司波士顿动力被谷歌卖给日本软银,机器人世界版图变天?

    大数据文摘

扫码关注云+社区

领取腾讯云代金券