@careteam/mfe-init

mfe-init

mfe配套了脚手架工具，用于初始化各种应用代码。

基于 egg-init 实现。

安装脚手架工具

通过tnpm安装

$ tnpm i @careteam/mfe-init -g

使用脚手架工具

创建指定脚手架模版的类型

通过--type指定类型：

$ mfe-init --type mobx [dir]

mobx是初始化模版的类型，支持的类型点击查看初始化模版类型 dir指定目标目录，如果缺省表示在当前目录初始化，当前目录不为空时会报错。

不输入类型可以选择

$ mfe-init [dir]
? Please select a boilerplate type (Use arrow keys)
❯ mobx - mobx boilerplate
  react - react boilerplate
  ...

通过尖头光标移动选择

支持的参数

$ mfe-init -h

可查看支持的参数列表

Usage: mfe-init [dir] --type=simple

Options:
  --type          boilerplate type                                                [string]
  --dir           target directory                                                [string]
  --force, -f     force to override directory                                     [boolean]
  --template      local path to boilerplate                                       [string]
  --package       boilerplate package name                                        [string]
  --registry, -r  npm registry, support china/npm/custom, default to auto detect  [string]
  --silent        don't ask, just use default value                               [boolean]
  --version       Show version number                                             [boolean]
  -h, --help      Show help                                                       [boolean]

自定义模板

自定义模板采用 npm 包的形式管理

• 新建仓库如 asgard-boilerplate
• boilerplate 目录下存放所有的初始化文件
• 可以使用 mfe-init --template=PATH 本地检查生成效果
• index.js 文件可以声明要替换的变量，在 boilerplate 文件夹中写模板的时候，可以通过 {{name}} 占位符的方式进行替换

module.exports = {
  name: {
    desc: '名称',
    // 内置实现，默认取文件夹名称
  },
  description: {
    desc: '描述',
    'default': '指定描述默认值',
  },
  author: {
    desc: '作者',
    // 内置实现，默认取git账号或系统用户名
  },
  gitUrl: {
  	desc: '对应的git仓库地址',
    // 内置实现，默认取git仓库信息或置空
  },
  type: {
  	'default': 'pane',
  	silent: true, // 设置为silent的不在输入流程中显示，可以作为变量在boilerplate模版中使用
  },
  project: {
  	'default': 'hio',
  	silent: true, // 同上
  }
};

• 更新依赖关系，只需要指定你的包名，更新到 init-config 这个模块的 package.json 中 config.boilerplate 字段
• 发布模板（和配置）到 npm

License

MIT