这是一个根据自定义模板自动生成文件的命令行工具。只需要设置一次,就可以重复使用。
$ npm install -g yoso
首先编写你自己的模板文件。这里是用的模板引擎是nunjucks,相关语法参考nunjucks官网。你可以将多个模板文件按照一定的文件结构放在一个文件夹中,也可以放置一个单独的文件。模板文件的后缀名直接用你希望的后缀名。 例如
component
├── component.html
├── component.js
├── component.scssv
└── ui.js
vue-ts.vue
vuex.ts
支持从gitlab和github仓库中获取模板。如果要从git仓库中加载模板文件,你需要先设置git仓库的信息。
-
github仓库需要用户名,仓库名,分支名(默认master),token(非必需,但是github对于未经身份验证的请求,会限制每小时最多60次请求)。
-
gitlab仓库需要gitlab地址,仓库id,分支(默认master),token(必需),其中,如果不清楚仓库id,可以通过直接输入仓库名来搜索获得,如果有重名的仓库,就带上namespace。
$ yoso config
- 从本地模板加载
$ yoso new [options] <tpl> <path>
例如
$ yoso new vuex src/store/demo
可选参数
参数
-o, --others 添加自定义字段
- 从github仓库加载
可以简单的通过yoso init
唤起GUI操作界面,此时的配置是读取yoso config
中的设置参数:
也可以指定参数来定制化操作:
$ yoso init [options] [tpl] [path]
例如
$ yoso init vuex src/store/demo
可选参数
参数
-b, --branch <branch> 设置分支
-u, --username <username> 设置用户名
-r, --repo <repo> 设置仓库名
-o, --others 添加自定义字段
可以使用命令行参数-o
或--others
,添加自定义字段,插到模板中的对应位置。默认包含的字段有:
{
name,//从输入的 path 中获得
author,//从 git config 中获得
email,//从 git config 中获得
date,//当前日期
}
输入格式为key value
,用一个或多个空格分隔,首尾的空格默认会清除。可以使用同名自定义字段覆盖默认字段。