实现一个搭建自己模板的简易脚手架
前言
最近在工作闲暇期间我改了一下之前写的react+typescript模板,打算用改造后的模板制作一个自己的博客,并且该模板将来用于做少量小试验用,但与此同时,我又觉得每一次都需要去github进行clone操作比较麻烦,所以就在参考了vue-cli源码的基础上,自己写了一个相似的脚手架工具方便自己,另外也开放出来给大家使用,同时详情一下主要逻辑和制作过程,也希望大家多提提意见
地址
欢迎star
脚手架
模板
使用方法
npm install -g oxctploxctpl init 项目名称cd 项目名称npm install主要逻辑(图示)
图示
项目目录
image.png
步骤
在安装了oxctpl后,执行oxctpl init 项目名:
指定命令及其执行的文件
该步骤非常简单,只需在package.json文件中增加bin选项,并增加你想要的命令及其执行文件就可,在该例中我们增加了oxctpl命令,它的执行文件是bin/oxctpl:
image.png获取客户命令中的参数
在oxctpl init 项目名中我们可以获取到两个参数,一个是init,一个是项目名,项目名暂且不表,而init命令是用来执行bin/oxctpl-init文件的,这时候我们就需要用到一个tj大神写的库[commander( tj/commander.js)了,这个库是专门用来解决客户输入的参数而后执行相应命令的,所以在bin/oxctpl中的内容是这样的:
image.png
接下来主要逻辑都在oxctpl-init文件中项目名解决
进入到oxctpl-init中,首先我们就要对项目名称进行解决,首先就要判断项目名能否存在,假如不存在的话跳出进程并提醒:
image.png
假如存在则分为下面三种情况:当前目录能否存在和项目名同名的文件夹,假如存在则跳出进程并提醒,假如不存在则进行下一步,我们可以使用
fs模块中的readdirSync方法读取到当前目录下的所有目录和文件名,而后遍历这些名字,使用statSync(fileName).isDirectory()判断能否为目录,最后再判断能否存在同名目录就可:
image.png当前所处目录的目录名和项目名相同,这时候需要讯问客户能否直接在当前目录下创立模板,是的话则进行下一步,否的话退出进程,这时候我们需要和客户进行交互,inquirer库就是一个专门用来在命令行和客户进行交互的库,代码如下:
image.png前两个条件都不符合的情况下,直接进行下一步就可:
image.png
下载模板
在上一步中,我们对项目名进行了少量条件判断,完成后下一步就是从github中将模板下载下来:首先创立项目名称的目录
image.png
在项目目录中创立隐藏文件夹并下载模板
该步骤的解决主要在download方法中,代码如下:
image.png
我使用了download-git-repo这个库进行模板下载,而后在项目目录中创立.download-temp隐藏文件夹,并将模板下载到了隐藏文件夹中,这时候我们的项目目录结构是这样的:
image.png
在这一步中,我们还可以使用ora这个库对下载过程加个loading进行美化
实际上在这一步中,假如不打算对模板进行自己设置的话,就已经算是完成一个脚手架的基本功能了,但是这并不能满足客户的所有需求,所以我们需要对模板进行肯定的自己设置。对模板进行自己设置
前面说到过,在命令行中我们可以使用inquirer这个库和客户进行交互,所以在该项目中,我们也将使用这个库收集客户指定的项目名称,版本号和简介对模板中的package.json进行自己设置- 首先需要在模板中制定变量
在这一步中,我们首先需要去到模板
的package.json中制定变量,比方在我自己的模板中有三个变量,当然通过这种方法也可以对模板需要安装的包进行自己设置:
image.png - 收集客户输入的信息
在该步骤中,我们通过inquirer收集客户输入的信息:
image.png - 模板生成
现在,模板已经被下载在隐藏文件夹.download-temp中,而客户输入的信息也已经收集到了,那么接下来就是进行模板信息的填充并生成最终模板了。
在这一部中我们需要使用metalsmith,handlebars和rimraf三个库,其中handlebars用于替换模板信息,metalsmith用于生成模板,rimraf用于删除模板创立成功后的隐藏文件夹,代码如下:
image.png
首先制定metalsmith所需要的信息,包含当前目录,客户输入的信息,以及最终输出文件的目标路径,而后使用handlebars对半成品模板进行变量的替换,最后生成最终模板并删除.download-temp隐藏文件夹。
- 首先需要在模板中制定变量
尾声
通过上面的多个步骤,我们的建议脚手架就已经算是完成。当然我们还可以使用chalk对脚手架进行进一步的美化,这个库用于输出不同颜色的console:
image.png
image.png
下一步将会对该脚手架进行进一步的优化,用以支持redux和mobx的选择。
最后欢迎大家star和提建议哦。
1. 本站所有资源来源于用户上传和网络,如有侵权请邮件联系站长!
2. 分享目的仅供大家学习和交流,您必须在下载后24小时内删除!
3. 不得使用于非法商业用途,不得违反国家法律。否则后果自负!
4. 本站提供的源码、模板、插件等等其他资源,都不包含技术服务请大家谅解!
5. 如有链接无法下载、失效或广告,请联系管理员处理!
6. 本站资源售价只是摆设,本站源码仅提供给会员学习使用!
7. 如遇到加密压缩包,请使用360解压,如遇到无法解压的请联系管理员
开心源码网 » 实现一个搭建自己模板的简易脚手架