Node.js编写CLI的实例详解


Posted in Javascript onMay 17, 2017

Why Node.js?

常用的用来编写CLI的语言有 python, ruby, perl, Node.js等等。 为什么选取Node.js作为CLI的语言编写工具呢?有三个理由:

  1. 对Javascript语言更加熟悉
  2. npm 完善的生态系统
  3. npm OS无关的包管理机制

主要原因还是归咎于npm 完善的生态,目前npm官方有47.5万个三方包可供使用,你可以很方便的使用一些已经编写的很不错的轮子去帮你快速开发。另一方面,你不需要考虑跨平台的安装问题,比如OSX上的homebrew、Debian的aptitude、CentOS 上的yum。如果使用shell或者其它语言来编写CLI,需要针对各个主流OS来做兼容并且发布到不同的平台。

看个demo

Node.js编写CLI的实例详解

注: 此处的Logo使用的是figlet这个npm包来帮助生成

npm关联CLI的基本原理

如何让Node.js编写的包可执行?其实很简单,只需要在package.json里面增加一个bin字段。模块发布到npm上后,开发者安装这个包的时候会检查是否有bin字段,如果有bin字段则会使用软链接的方式创建可以全局使用的命令。

如果模块采用全局安装的方式,对于类unix系统,会在/usr/local/bin目录创建软链接,对于windows系统,在C:\Users\username\AppData\Roaming\npm目录创建软链接。

如果模块采用局部安装的方式,则会在项目内的./node_modules/.bin目录创建软链接。

配置好的package.json如下:

…
 "description": "A command line tool aims to improve front-end engineer workflow.",
 "main": "lib/index.js",
 "bin" : {
  "feflow" : "./bin/feflow"
 }
…

CLI基本命令设计

$ feflow --help

 A command line tool aims to improve front-end engineer workflow

 Usage: feflow [options] [command]

 Commands:
   init           Choose a scaffold to initialize project.
   scan   --receiver    Scan a group and mail to receiver
   install <plugin>     Install a plugin or a yeoman generator.

 Options:
   --version, -[vV]     Print version and exit successful
   --help,          Print this help and exit successf

Feflow的技术架构

Feflow总体分为3个模块,包括parser命令行参数解析、核心命令以及插件机制。设计插件主要是为了保持整体功能的稳定,避免频繁升级;同时开放能力,支持开发者接入,完善整体的生态。

Node.js编写CLI的实例详解

扫描器的实现

在一个工程项目中,有各种各样的规范,比如项目命名规范、描述规范、目录结构规范、README.md规范,是否增加基本监控等等。编写扫描器scanner,对某个Group里面的所有业务项目进行扫描,将不符合规范的仓库和不符合规范的地方列举出来,并且捞出责任人。最后通过邮件及定时任务发送给相关同学,并且敦促修改。扫描器流程图如下:

Node.js编写CLI的实例详解

首先,需要一个任务队列,队列里面存放不同的扫描任务。每个扫描任务依赖相关的文件信息或者Commit信息,这个时候需要调用Git code提供的三方API进行文件信息拉取。之后,需要编写一个规则引擎,这个规则引擎里面有多个规范相关的检查工具,解析完成后会将结果生成HTML格式的字符串。最后调用邮件服务和定时任务服务去通知相关开发者。

插件机制设计

$ feflow install <plugin>      # 安装一个插件, --force则会强制安装
$ feflow remove <plugin>      # 卸载一个插件
$ feflow list            # 列举出所有插件信息
$ feflow list <plugin>       # 列举某个插件信息

插件机制实现

插件机制的实现包括两个部分:插件注册机制和插件发现机制。feflow要求插件必须以feflow-plugin-开头或者 generator-开头,generator作为一种特殊的插件,插件代码以npm包的形式存储和管理。运行feflow install plugin命令时,会通过npm 的 regsitry检查是否存在插件,如果存在,会检查当前插件是否是最新版本。如果不是最新版本,则提示用户是否需要更新。然后将插件下载到Home目录下的.feflow目录(Windows系统为"C:\Users\username\.feflow" 目录)下的node_modules里面,并且写入到配置文件里面。

本地模块注册机制

Node.js编写CLI的实例详解

本地模块发现机制

Node.js编写CLI的实例详解

npm 的 registry服务

  1.  npm的查询服务网址:http://registry.npmjs.org/
  2. registry网址后面跟上模块名、版本好可以查询模块详细信息,包括最新版本,以此来判断模块是否需要更新。比如:React的最新版本可以通过http://registry.npmjs.org/react/latest 来获得
  3. 返回的JSON对象里面有个dist.tarball属性,是某个版本的压缩包地址

常用三方包分享

  1. osenv 方便的获取不同系统的环境和目录配置
  2. figlet 命令行炫酷的Logo生成器
  3. meow 命令行帮助命令封装
  4. inquire 强大的用户交互
  5. chalk 让命令行的output带有颜色
  6. easytable 表格信息展示,用于升级包的提示
  7. minimlist 用户输入的参数解析
  8. shelljs Node.js执行shell命令
  9. clui 进度条

遇到的问题

1,windows下用户未设置HOME环境变量导致报错

解决办法: 由于windows下HOME环境变量并非默认存在,因此不能直接使用。判断process.platform === ‘win32',优先使用HOME变量,否则使用USERPROFILE变量;建议使用osenv这个包。

2,OSX平台运行feflow报错: env: node\r: No such file or directory

解决办法: 由于类unix系统的换行符号为\n,而windows系统为\n\r。修复换行问题。可以在工程根目录下加.gitattributes文件,设置* text eol=lf,这样git提交时就不会讲LF转换成CRLF

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持三水点靠木。

Javascript 相关文章推荐
Dojo之路:如何利用Dojo实现Drag and Drop效果
Apr 10 Javascript
js对table的td进行相同内容合并示例详解
Dec 27 Javascript
自定义jquery模态窗口插件无法在顶层窗口显示问题
May 29 Javascript
根据当前时间在jsp页面上显示上午或下午
Aug 18 Javascript
jQuery点击按钮弹出遮罩层且内容居中特效
Dec 14 Javascript
利用Vue.js框架实现火车票查询系统(附源码)
Feb 27 Javascript
jQuery实现的简单在线计算器功能
May 11 jQuery
JS使用ActiveXObject实现用户提交表单时屏蔽敏感词功能
Jun 20 Javascript
vue-router 导航钩子的具体使用方法
Aug 31 Javascript
Javascript获取某个月的天数
May 30 Javascript
ES6中Set和Map数据结构,Map与其它数据结构互相转换操作实例详解
Feb 28 Javascript
vue 监听 Treeselect 选择项的改变操作
Aug 31 Javascript
ES6入门教程之Class和Module详解
May 17 #Javascript
AngularJS实现动态添加Option的方法
May 17 #Javascript
AngularJS+bootstrap实现动态选择商品功能示例
May 17 #Javascript
Vue声明式渲染详解
May 17 #Javascript
node.js调用Chrome浏览器打开链接地址的方法
May 17 #Javascript
用纯Node.JS弹出Windows系统消息提示框实例(MessageBox)
May 17 #Javascript
AngularJS实现的回到顶部指令功能实例
May 17 #Javascript
You might like
php中strstr、strrchr、substr、stristr四个函数的区别总结
2014/09/22 PHP
PHP遍历文件夹与文件类及处理类用法实例
2014/09/23 PHP
php清除和销毁session的方法分析
2015/03/19 PHP
PHP判断JSON对象是否存在的方法(推荐)
2016/07/06 PHP
基于JQuery的类似新浪微博展示信息效果的代码
2012/07/23 Javascript
jQuery写fadeTo示例代码
2014/02/21 Javascript
JavaScript加入收藏夹功能(兼容IE、firefox、chrome)
2014/05/05 Javascript
Nodejs实现的一个简单udp广播服务器、客户端
2014/09/25 NodeJs
JS实现鼠标滑过折叠与展开菜单效果代码
2015/09/06 Javascript
javascript实现加载xml文件的方法
2015/11/24 Javascript
jQuery查找节点并获取节点属性的方法
2016/09/09 Javascript
微信小程序 本地存储及登录页面处理实例详解
2017/01/11 Javascript
vue2.0父子组件间通信的实现方法
2017/04/19 Javascript
JavaScript闭包与作用域链实例分析
2019/01/21 Javascript
微信小程序 授权登录详解(附完整源码)
2019/08/23 Javascript
JavaScript创建表格的方法
2020/04/13 Javascript
JSONP 的原理、理解 与 实例分析
2020/05/16 Javascript
mapboxgl实现带箭头轨迹线的代码
2021/01/04 Javascript
[04:59]DOTA2-DPC中国联赛 正赛 Ehome vs iG 选手采访
2021/03/11 DOTA
Python 学习笔记
2008/12/27 Python
python实现问号表达式(?)的方法
2013/11/27 Python
Python二维码生成库qrcode安装和使用示例
2014/12/16 Python
简单介绍Python下自己编写web框架的一些要点
2015/04/29 Python
python如何使用unittest测试接口
2018/04/04 Python
python3.x实现发送邮件功能
2018/05/22 Python
Python3数据库操作包pymysql的操作方法
2018/07/16 Python
pygame实现俄罗斯方块游戏(AI篇1)
2019/10/29 Python
python+OpenCV实现车牌号码识别
2019/11/08 Python
什么时候用assert
2015/05/08 面试题
个人自荐信
2013/12/05 职场文书
学习委员自我鉴定
2014/01/13 职场文书
物理系毕业生自荐书范文
2014/02/22 职场文书
解除劳动合同协议书
2014/04/14 职场文书
营销团队口号
2014/06/06 职场文书
学校标语口号大全
2015/12/26 职场文书
如何给HttpServletRequest增加消息头
2021/06/30 Java/Android