让我们从开发时繁琐的文件创建、引用、初始化代码中解放人力，把更多的精力关注到业务逻辑上
- 在目标目录生成指定文件
- 解析生成的文件，进行变量替换
- 添加生成文件的引用路径
捷径：在文件夹下初始运行$ egen --init，会默认生成一个helloWorld的配置，修改使用即可
- 项目根目录下创建egen-config.js文件
- 创建件egen模板文件夹（默认为egenTpl）及其模板文件
- 根目录下运行
$ egen xxx， xxx为配置中的需要从命令行输入的变量，一般为生成的文件名或模块名
- 一键生成: 一键完成所有文件的创建、路径引用、文件代码初始化
- 自定义子命令：用自定义的子命令单独生成单个文件task
- 灵活迁移：运行脱离于具体项目，仅依赖于配置文件
$ npm install -g egen
$ egen xxx
第一次运行时，项目根目录下如果没有所需的egen-config.js配置文件，会默认生成一个初始的配置，您可以根据业务需求更改配置后使用
工具的配置文件在项目的根目录下面, 这个文件夹下需要自己去和写配置文件和模板文件
- egen-config.js ———配置文件
- egenTpl ———模板文件夹，可以更改名字及目录，只需要在config中重新指定即可
示例：https://github.com/strwind/egen/tree/master/demo/helloWorld
/**
* @file 模块信息配置
* @author yaofeifei([email protected]）
* @date 2014-10-30
*/
var path = require('path');
var cwd = process.cwd();
var join = path.join;
var tplPath = join(cwd, 'egenTpl');
var config = {
/**
* 命令配置变量映射（可选）
* args1 代表egen命令后的第一个参数，args2代表第二个，以此类推
* Args1 代表第一个参数的第一个字母大写转化， 以此类推
* ARGS1 代表第一个参数的全部字母大写转化， 以此类推
*/
'commandMap': {
'${moduleName}': 'args1',
'${ModuleName}': 'Args1',
'${MODULENAME}': 'ARGS1'
},
/**
* 模板变量替换字典（可选）
* 模板变量与配置变量的区别：
* 模板变量是用于模板中的变量替换
* 配置变量仅仅用于该config文件中的变量替换
*/
'commonTplData': {
'userName': 'yaofeifei',
'email': '[email protected]',
'createDate': true,
'moduleName': '${moduleName}',
'ModuleName': '${ModuleName}',
'MODULENAME': '${MODULENAME}',
'customVar': '${moduleName}—${ModuleName}—${MODULENAME}~随意组合'
},
/**
* 模板的变量起始串设置，egen采用的是etpl模板引擎 (可选)
* 为了解决egen的变量与模板代码中的变量冲突
* 默认设置为：
* commandOpen': <%
* commandClose': %>
* variableOpen': ${
* variableClose': }
*/
'etplSetting': {
'commandOpen': '<%',
'commandClose': '%>',
'variableOpen': '$${',
'variableClose': '}'
},
/**
* 生成任务list
* 每个有type属性的对象， key名即文件名
* @type {string} path： 文件路径
* @type {string} type：文件类型
* @type {string=} subCommand：子命令
* @type {string} tplForm: 模板路径
* @type {Object=} fileReference: 文件引用信息
* @type {string=} fileReference.path： 文件引用路径
* @type {string=} fileReference.content： 文件引用的内容
* @type {number=} fileReference.line： 文件引用的行号
* @type {Object=} tplData：私有模板配置字典数据
* type {Function=} callback: 回调函数，这里只配置函数的位置，具体的函数放在handlers中
*/
'taskList': [
//资源文件夹配置
{
'path': join(cwd, 'assets'),
'type': 'folder',
// css文件夹配置
'css': {
'type': 'folder',
'subCommand': 'addcss',
'${moduleName}.css': {
'type': 'file',
'tplFrom': join(tplPath, 'css.css'),
'callback': 'config.handlers.cssDone'
},
'callback': 'config.handlers.cssFolderDone'
},
'callback': 'config.handlers.assetsFolderDone'
},
//依赖文件夹配置
{
'path': join(cwd, 'dep'),
'type': 'folder',
'callback': 'config.handlers.depFolderDone'
},
// html配置
{
'path': join(cwd, '${moduleName}.html'),
'type': 'file',
'subCommand': 'addhtml',
'tplFrom': join(tplPath, 'tpl.html'),
'tplData': {
'cssPath': 'assets/css/${moduleName}.css'
},
'callback': 'config.handlers.htmlDone'
}
],
/**
* 处理函数集合（可选）
*/
'handlers': {
// status=true为成功,status=false为失败
'assetsFolderDone': function (status) {
console.log('assets folder done!');
},
'depFolderDone': function (status) {
console.log('dep folder done!');
},
'cssFolderDone': function (status) {
console.log('css folder done!');
},
'htmlDone': function (status) {
console.log('html file done!');
},
'cssDone': function (status) {
console.log('css file done!');
}
}
};
module.exports = exports = config;
采用的是etpl模板解析引擎， 查看语法请猛点：https://github.com/ecomfe/etpl
其中唯一差别是，命令和变量的语法起始串默认符号不同
commandOpen: '<%'
commandClose: '%>'
variableOpen: '${'
variableClose: '}'
在项目根目录下运行命令$ egen index
result:
-assets
-css
-index.less
-dep
-egenTpl
-egen-config.js
-index.html
在项目根目录下运行命令$ egen -addcss demo
result:
-assets
-css
-demo.less
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent