搭建自己的cli脚手架工具

Posted 2020-12-10 flamestudio

cli本质就是一个nodejs项目，因此创建一个nodejs项目即可。

在package.json中加入bin配置，例如：

{ 
    "name": "yulan-cli",
    ...,
    "bin": {
        "yulan": "./src/index.js"
    },

}

然后执行npm link就可以注册到全局Path用于调试了（可以通过命令行键入yulan了，实际会执行yulan后面对应的./src/index.js，这里可以是任意的路径）。

在对应的js文件中，首行需要声明#!/usr/bin/env node，意思是当前js文件需要通过node去执行。

最后开发完成后可以通过npm publish即可发布到官方npm仓库。（需要事先登录NPM）

使用时全局安装即可。

 

依赖的npm包

 

commander 制作脚手架必备基础库，内置-v、--help等常用参数

inquirer 用于询问用户并接收用户输入

handlebars 用于字符串替换（模板渲染）

download-git-repo clone git仓库

ora. 耗时操作命令行显示loading效果

chalk 命令行输出彩色字体

logSymbols 命令行输出简单的图标（成功 失败等）