构建属于自己的CLI工具

前言

CLI，全称是command-line interface，也就是命令行交互接口。无论是在前端还是后端，都可以用于在构建时通过命令快速生成项目或模板等。例如前端的vue-cli（Vue前端开发脚手架），后端的dva-cli（Ant Design后端开发脚手架）等

需求

那么如何构建属于自己的CLI工具呢，在项目开发时可以快速生成自己需要的代码模板，去除重复工作，并且还可以为其他的开发者提供快速入门的使用呢？我们的具体需求如下：

1，通过执行命令，自动生成项目代码模板
2，项目代码模板可以自定义编辑
3，CLI可以通过软件包形式分发，其他开发者可以简单使用

思路

CLI其实可以理解成早先时候黑漆漆的C语言控制台窗口，通过简单的命令输入，可以得到指定的输出，那么为了满足以上三点需求，使用NodeJS开发CLI是一个很好的选择：

1，获得用户的输入，并且根据相应的输入，可以定制编程相应执行逻辑
2，模板代码有两种实现思路，一是采用代码生成，二是分离静态资源模板
3，使用包管理工具

准备工作

npm install commander --save
npm install git-clone --save
npm install shelljs --save

工具说明

1、commander

commander是目前很成熟的Node命令行交互接口实现工具，使用该工具可以很便捷很快速地实现第一点需求

2、git-clone

git-clone是一个很轻量的Node编写的git clone封装，可以很便捷很快速地从github上克隆执行项目模板。也就是说，我们将项目模板静态存储在github上，每当执行cli命令时，将其下载，这样我们就很轻松地得到了项目代码模板。另外，当需要改变项目模板代码时，只需要修改github上的项目代码就可以，cli工具无需修改

3、shelljs

shelljs同样是一个很轻量的Node编写的系统命令封装，可以很便捷很快速地在Node代码中使用系统命令。在本例中，因为从github上下载的项目代码会带有.git文件，需要使用rm命令将其删除

构建说明

安装完依赖包之后，我们只需要编写一个文件的代码：

#!/usr/bin/env node

const clone = require('git-clone')
const program = require('commander')
const shell = require('shelljs');
const log = require('tracer').colorConsole()


program
    .version('1.0.0')
    .description('xserver中间件应用模板工程的cli')
program
    .command('*  ')
    .action(function(tpl, project) {
        log.info('目前xserver-cli支持以下模板：')
        log.info('使用例子：x-cli x-express myproject')
        if (tpl && project) {
            let pwd = shell.pwd()
            log.info(`正在拉取模板代码，下载位置：${pwd}/${project}/ ...`)
            clone(`https://github.com/cheneyweb/${tpl}.git`, pwd + `/${project}`, null, function() {
                shell.rm('-rf', pwd + `/${project}/.git`)
                log.info('模板工程建立完成')
            })
        } else {
            log.error('正确命令例子：x-cli x-express myproject')
        }
    })
program.parse(process.argv)

以上就是xserver-cli的源代码，极为简单，只有28行

使用说明

npm install xserver-cli -g
x-cli x-express myproject

执行完以上命令后，首先是安装xserver-cli，然后是以x-express的项目代码为模板，生成自定义项目myproject，路径位于当前执行命令的目录下

Paste_Image.png

结语

是不是十分的简单呢？原来CLI也没有特别神秘的地方嘛，我们也可以制作属于
自己的脚手架工具
另外，关于本文章中提到的xserver-cli工具，已经上传到npm中，目前支持x-express和x-koa两个项目模板代码

关于x-express和x-koa，这是我构建的一个以中间件应用为基础的组件化后端开发框架，分别基于express和koa框架，详情可以了解如下传送门：
XServer—全新组件化后端构建

1.png

2.png