详解用node编写自己的cli工具


Posted in Javascript onMay 23, 2017

工作中接到新项目,开发前都需要先规划项目目录,然后一个个创建文件,搭建sass编译环境,下载jquery,Swiper等类库... 这些准备工作都要花上不少时间。每做一个项目,都会遇到同样的问题,再重复一遍吗?
是时候做点改变了:编写自己的cli工具,一行命令,3秒钟进入coding状态!

本文以自己的my-cli为例,将开发到发布过程完整记录下来,看完本文,你将学会如何从零开发一个cli项目,如何上传到github库,以及如何使用npm发布自己的包。

准备

开发一个cli工具前首先要想好它能做什么。以我自己为例,我需要一个工具,让我能只输入一行命令就帮我快速搭建好项目结构,就像这样:

详解用node编写自己的cli工具

是不是很炫酷?放心,很简单。

开始

首先创建你的cli项目,并使用npm init创建一个package.json。

$ mkdir my-cli && cd my-cli
$ npm init

根据提示一步步创建好package.json。name属性就是你发布到npm上的名字,这个是不能与npm上现有项目重名的,一个小技巧是使用npm install下载你想要起的包名字,如果报错404,那么你的包名是可用的。最后创建好的package.json文件像这样子:

{
 "name": "my-cli",
 "version": "0.0.1",
 "description": "Auto generate project template",
 "main": "index.js",
 "bin": {
  "my-cli": "./index.js"
 },
 "repository": {
  "type": "git",
  "url": "git+https://github.com/hlme/my-cli.git"
 },
 "keywords": [
  "cli"
 ],
 "author": "798400626@qq.com",
 "license": "MIT",
 "bugs": {
  "url": "https://github.com/hlme/my-cli/issues"
 },
 "homepage": "https://github.com/hlme/my-cli#readme"
}

编写可执行文件

package.json中有一个"bin"字段,配置后才可以在控制台使用你的命令。

"bin": {
 "my-cli": "./index.js"
}

我们配置了"my-cli"命令来执行index.js文件。用你喜欢的编辑器,在项目主目录下创建一个index.js文件。

详解用node编写自己的cli工具

注意第一行的"#! node"很重要,表示用node来执行这个文件。如果没有这句声明,就会在记事本中打开index.js文件。

全局安装你的包

使用 npm install -g 将你当前的项目安装到全局环境,现在你可以在命令行使用"my-cli"命令了。

详解用node编写自己的cli工具

用fs模块快速生成项目模板

我们自定义的指令可以执行了,接下来编写代码实现功能。my-cli的主要功能就是生成项目模板,一个思路是用一个templates文件夹保存项目模板,然后通过fs.mkdir()来创建项目目录,最后把文件从templates文件夹拷贝到项目中去。

var fs = require('fs');
var path = require('path');

function copyTemplate (from, to) {
 from = path.join(__dirname, 'templates', from);
 write(to, fs.readFileSync(from, 'utf-8'))
}
function write (path, str, mode) {
 fs.writeFileSync(path, str)
}
function mkdir (path, fn) {
 fs.mkdir(path, function (err) {
  fn && fn()
 })
}

核心代码就这么点,是不是非常简单?

整个项目文件结构差不多就这个样子,把你需要的文件放到templates文件夹,然后用copyTemplate方法将文件拷贝到项目目录下。

详解用node编写自己的cli工具

创建文件目录和拷贝文件的过程,代码看着比较丑陋

详解用node编写自己的cli工具

接收命令行参数

平常我们使用命令行工具时都会用到参数,如 webpack -p, express -e 等,现在我们来为自己的cli添加接收命令行参数的功能。为my-cli设计四个参数,用来向项目中添加类库。

$ my-cli -j -s -v -b
//-j :添加jQuery
//-s :添加Swiper
//-v :添加Vue
//-b :添加Bootstrap

使用commander包可以简化解析参数过程,但是本项目比较简单,我也不想额外引入其他的包了,处理一些简单的参数其实并不难。

node中我们可以使用process.argv来获取命令行参数,process.argv是一个参数数组,第一项为node.exe的绝对路径,第二项为执行该js的绝对路径,使用process.argv.slice(2)即可获取输入的参数数组。

详解用node编写自己的cli工具

通过遍历参数数组来检查命令中输入了哪些参数。如果输入了预设的参数,就为config对象添加对应的属性,在生成文件时根据onfig判断是否将模板文件拷贝到项目中。继续丑陋的代码:

详解用node编写自己的cli工具

本地运行

至此我们的项目已经基本完成了,使用 npm install -g 将项目安装到全局环境,然后新建一个项目文件夹,使用my-cli命令来生成项目模板。

详解用node编写自己的cli工具

发布到npm仓库

要想将自己的包发布到npm上,首先得有一个npm账号,创建账号非常简单,输入npm adduser,简单三步即可完成创建。

详解用node编写自己的cli工具

创建好user后,使用npm publish即可将当前项目发布到npm上了,以后就可以使用npm install -g my-cli 来安装你的cli工具。

详解用node编写自己的cli工具

结束语

相信大家看完本文后知道如何根据自己的需求制作cli工具了。本文中的my-cli比较简单,权当做抛砖引玉。如果想查看完整源码或者使用这个工具,可以戳这里:github地址。

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

Javascript 相关文章推荐
jQuery初学:find()方法及children方法的区别分析
Jan 31 Javascript
9行javascript代码获取QQ群成员具体实现
Oct 16 Javascript
jquery 插件实现多行文本框[textarea]自动高度
Mar 04 Javascript
使用RequireJS优化JavaScript引用代码的方法
Jul 01 Javascript
jQuery Html控件基本操作(日常收集整理)
Mar 11 Javascript
Vue.js每天必学之方法与事件处理器
Sep 06 Javascript
详解VueJs异步动态加载块
Mar 09 Javascript
JS实现的四级密码强度检测功能示例
May 11 Javascript
使用nvm管理不同版本的node与npm的方法
Oct 31 Javascript
Ionic学习日记实现验证码倒计时
Feb 08 Javascript
js实现百度淘宝搜索功能
Feb 17 Javascript
在Vue中获取自定义属性方法:data-id的实例
Sep 09 Javascript
JavaScript 巧学巧用
May 23 #Javascript
JS获取短信验证码倒计时的实现代码
May 22 #Javascript
原生JS实现不断变化的标签
May 22 #Javascript
jQuery实现简单的滑动导航代码(移动端)
May 22 #jQuery
vue2.0 与 bootstrap datetimepicker的结合使用实例
May 22 #Javascript
Vue实现动态显示textarea剩余字数
May 22 #Javascript
bootstrap栅格系统示例代码分享
May 22 #Javascript
You might like
利用PHP和AJAX创建RSS聚合器的代码
2007/03/13 PHP
微信支付开发教程(一)微信支付URL配置
2014/05/28 PHP
php使用CURL模拟GET与POST向微信接口提交及获取数据的方法
2016/09/23 PHP
JavaScript中反正弦函数Math.asin()的使用简介
2015/06/14 Javascript
js带前后翻页的图片切换效果代码分享
2015/09/08 Javascript
React Native实现简单的登录功能(推荐)
2016/09/19 Javascript
JavaScript数据结构之广义表的定义与表示方法详解
2017/04/12 Javascript
微信小程序 flex实现导航实例详解
2017/04/26 Javascript
Node.js 8 中的 util.promisify的详解
2017/06/12 Javascript
解决低版本的浏览器不支持es6的import问题
2018/03/09 Javascript
vue-router 手势滑动触发返回功能
2018/09/30 Javascript
Vue自定义全局Toast和Loading的实例详解
2019/04/18 Javascript
前端插件之Bootstrap Dual Listbox使用教程
2019/07/23 Javascript
[55:18]Liquid vs Chaos 2019国际邀请赛小组赛 BO2 第一场 8.15
2019/08/16 DOTA
python 七种邮件内容发送方法实例
2014/04/22 Python
Python中的jquery PyQuery库使用小结
2014/05/13 Python
Python学习笔记之常用函数及说明
2014/05/23 Python
Python里隐藏的“禅”
2014/06/16 Python
简单介绍Python中的几种数据类型
2016/01/02 Python
PyTorch快速搭建神经网络及其保存提取方法详解
2018/04/28 Python
python3实现磁盘空间监控
2018/06/21 Python
python 移动图片到另外一个文件夹的实例
2019/01/10 Python
Python小进度条显示代码
2019/03/05 Python
Python代码注释规范代码实例解析
2020/08/14 Python
浅谈Python描述数据结构之KMP篇
2020/09/06 Python
CSS3等相关属性制作分页导航实现代码
2012/12/24 HTML / CSS
Stella McCartney官网:成衣、包袋、香水、内衣、童装及Adidas系列
2018/12/20 全球购物
C语言变量的命名规则都有哪些
2013/12/27 面试题
业务员的岗位职责
2014/03/15 职场文书
广告语设计及教案
2014/03/21 职场文书
房屋买卖委托公证书
2014/04/08 职场文书
幼儿园安全责任书范本
2014/07/24 职场文书
预备党员入党思想汇报(范文)
2019/08/14 职场文书
500字作文之周记
2019/12/13 职场文书
深入理解java.lang.String类的不可变性
2021/06/27 Java/Android
海弦WR-800F
2022/04/05 无线电