开源了一个小的前端脚手架(队内分享)

前端小智
English

这个是我开源的第二个项目,第一个开源项目是一个 okr 的树形图,目前有 349 个star,地址如下: https://github.com/qq449245884/vue-okr-tree,精力有限,近期维护的比较少,如果有兴趣的小伙伴可以加入一直维护。

现在来看看我开源的第二个小项目,主要是我们团队要用的,目的是减少一些琐屑的工作,增加开发效率。

背景

目前队内新项目,我们都使用了自己的公共库、自己一套的 eslint 规范及 git commit 相关的检查,如果有新项目我们还要从老的项目一个一个把配置拷贝过来,效率比较低。

为了解决这些痛点,我们需要有自己的脚手架,帮我们完成这些耗时的工作。

为什么需要脚手架?主要有 3 点原因:

  • 减少重复性的工作,不再需要复制其他项目再删除无关代码,或者从零创建一个项目和文件
  • 根据交互动态生成项目和配置文件等
  • 多个协作更为方便,不需要所文件传来传去

调研

安装

npm install --global ztjy-cli

命令使用

查看版本

ztjy -v  或 ztjy --version

查看当前模板

ztjy ls

说明:

如果是公司内网环境选择使用不带 github 开头的模板

初始化项目

我们可以使用 init 命令选择一个模板来初始化我们新的项目。

ztjy init

执行 init 首先会让用户选择一个模板初始化,如果是公司内网选择不带 github 开头模板

选择对应的模板后,接着会让用户填写项目的名称及版本,对应 package.json 中的 namedescription,如下所示:

注意:如果下载失败,可能原因是网络问题,可以多执行多次试试。

下载成功后,在当前目录下就可以看到我们指定的 my-vue-template 项目。

添加模板

如果现有模板没有我们想要的,我们可以 add 命令添加新的模板:

ztjy add

执行 add 命令后,依次会让我们输入项目的名称、描述及下载 地址。

这里的下载地址需要符合指定的格式,模板是使用 download-git-repo 库下载的,所以具体的地址格式可以参考:

https://gitlab.com/flippidipp...

删除模板

如果模板已经不需要了,我们可以使用 del 命令删除:

ztjy del 模板名称

项目地址:

gitubh: https://github.com/qq44924588...

三方库介绍

<!-- 终端样式库 -->
"chalk": "^3.0.0",
<!-- 命令行交互 -->
"commander": "^5.0.0",
<!-- 从git拉模板 -->
"download-git-repo": "^3.0.2",
<!-- fs操作拓展 -->
"fs-extra": "^9.0.0",
<!-- 模板引擎 -->
"handlebars": "^4.7.3",
<!-- 命令行交互 -->
"inquirer": "^7.1.0",
<!-- 加载效果,图标 -->
"ora": "^4.0.3"

~~完,我是刷碗智,欢迎给个赞呀。

代码部署后可能存在的BUG没法实时知道,事后为了解决这些BUG,花了大量的时间进行log 调试,这边顺便给大家推荐一个好用的BUG监控工具 Fundebug

交流

有梦想,有干货,微信搜索 【大迁世界】 关注这个在凌晨还在刷碗的刷碗智。

本文 GitHub https://github.com/qq44924588... 已收录,有一线大厂面试完整考点、资料以及我的系列文章。

阅读 710

终身学习者
我要先坚持分享20年,大家来一起见证吧。
62.3k 声望
93.6k 粉丝
0 条评论
62.3k 声望
93.6k 粉丝
文章目录
宣传栏