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

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

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

准备

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

是不是很炫酷？放心，很简单。

开始

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

rush:bash;"> $ mkdir my-cli && cd my-cli $ npm init

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

rush:js;"> { "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"字段，配置后才可以在控制台使用你的命令。

rush:plain;"> "bin": { "my-cli": "./index.js" }

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

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

全局安装你的包

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

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

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

rush:js;"> 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方法将文件拷贝到项目目录下。