1.0.1 • Published 3 years ago
generator-un-vue2 v1.0.1
generator-un-vue2
介绍
前端工程化之cli辅助工具。
利用yeoman,plop打造的代码模板生成器
工作原理
前提:安装yeoman 和 plop。
整个工作流程比较简单,分成两步:
1、用yeoman生成plop命令以及模板文件,
2、用已生成的plop文件,结合plop-cli生成自己想要的component, api, controller, service等文件
适用范围
理论上可以用于所有基于node的cli系统。 建议配合vue-cli, create-react-app, vite等已有脚手架,生成个更加符合特定业务的文件骨架。
安装教程
- 先安装yeoman和plop两个脚手架工具(建议全局安装)
npm i yo -g
npm i plop -g
- 安装generator-un-vue2这个yeoman的文档生成器
npm i generator-un-vue2 -D
使用说明
- 通过yeoman生成plop命令文件以及模板:进入项目根目录,输入以下命令:
yo un-vue2
这个命令输入后,就有了创造各种代码模板的命令了
- 通过plop命令,来生成需要的文件,目前配置了两类文件命令,一是组件(component),一是接口(api)。可以自由扩展任意类型的命令模板(参考下方 定制 )
生成组件
以layout组件为例
plop component layout
生成api
以user资源接口为例
plop api user
定制
可以通过修改plopfile.js和plop-templates中的文件自由定制文件生成的路径以及内容
参与贡献
- Fork 本仓库
- 新建 Feat_xxx 分支
- 提交代码
- 新建 Pull Request