我做了一个模板库工具,那些喜欢收集模板的看过来^_^

327 阅读2分钟

template-library-cli(模板库工具)

背景:

来公司一年了,公司业务已经相对熟悉,使用的技术栈也已经熟练掌握,长期以往发现新加的需求模块都跟之前的很类似,甚至新起一个项目也与之前的类似,特别是像后台管理系统这种每个模块开发过程基本一致的项目,先为模块添加一个路由,路由进入的模块界面是一个分页表格,然后是增加和修改的表单,因为前端界面用的是组件库,所以基本上就是拷贝之前的模块,修改一个表格和表单的字段配置就完事了。为此我也在公司Git仓库中存储了一些相关的模板。在下一次开发类似功能时以供拷贝使用。

通常我们会把模板分为两种类型:

  1. 应用模板:其实就是一个成品项目,或者是具备基础架构的项目,通常一个这种项目模板就直接是一个单独的仓库,我们把这种仓库称之为 应用模板库 ,代号 app
  2. 文件模板:就是业务文件,可以是一个单文件,也可以是一整个业务模块的文件夹,通常是将很多个这种类型的模板集合到一个仓库,我们把这种仓库称之为 业务文件模板库 ,代号 file

然而即使准备了些模板,在使用时,却还需要经历 离开当前的位置 再 找到模板的位置 复制后再 找到要粘贴的位置 这种繁琐的操作,此时如果我们能通过在当前界面的命令行一个命令便能将模板库中指定的模板放到指定的位置,那岂不是更高效?

嗯, 这正是此 模板库工具 能做的一些事情,也许不止于此。

用法

以下是工具的应用场景操作案例,更具体的用法说明可以去查看上方的仓库地址

准备 1:克隆一个业务文件模板库到本地

tlc clone https://github.com/friendlysxw/vue-file-templates.git 

值得注意的是:在克隆 业务文件 [file] 类型的模板仓库时,此仓库根目录需要有一个 tlc-config.json 配置文件,并且其中应该存储当前仓库中的模板信息,格式如下:

{
    "templates":[
        {
            "name":"模板的名称",
            "desc":"模板的简短描述",
            "path":"模板在当前仓库中的路径 ( 文件路径 | 目录路径 )"
        }
    ]
}

clone-file.gif

准备 2:克隆一个应用项目模板库到本地

tlc clone https://github.com/PanJiaChen/vue-admin-template.git

clone-app.gif

生成 1:在我们的项目中生成业务文件

tlc generate file 或 tlc g file

generate-file.gif

生成 2:初始化生成一个应用项目

tlc generate app 或 tlc g app

generate-app.gif