rig-cli v1.0.2

rig-cli

##1. 统一添加注释头

• 可以指定某个文件进行注释头部添加；
• 支持添加注释头的文件类型有：java、xml、js、vue、html、ts；
• 不指定类型，则自动搜索目录下支持上述类型的文件进行添加；
• 可以指定某个目录，递归添加注；
• 自动检查是否已经添加，添加后会直接跳过；

###1.1. 注释头示例

/******************************************************************************
 *
 * @(#) Demo.java
 * @Package com.crcgas
 *
 * 注意：本内容为润智科技有限公司机密信息，仅限内部传阅，未经本公司书面同意，禁止外传以及用于其他商业目的
 * Copyright © Resource smart Technology Co.,Ltd. All rights reserved.
 *
 *****************************************************************************/

###1.2. 脚本使用说明

#指定某个文件添加注释头
rig-cli add-header-comment -f your-file.java

#指定某个目录下所有文件添加注释头
rig-cli add-header-comment -d your-path

#默认不添加参数表示处理当前目录
rig-cli add-header-comment

#关于参数说明
# -f <your-file> 需要添加注释的文件
# -d <your-path> 需要添加注释的文件目录
# -t <java|xml|js|vue|html|ts> 指定类型

##2. 示例项目初始化 ##3. 代码生成

• 根据给定的模板目录和参数json，生成最终代码到指定目录；
• 可以理解模板目录就是单表； ###3.1.脚本使用说明

#根据给定的模板和参数json，生成代码到指定目录；
rig-cli generate -c config.json -t template-path -o ouput-path

#默认不添加参数则取当前目录的config.json、template目录、output目录
rig-cli generate 

#关于参数说明
# -c <config-file>   配置文件，默认为：config.json
# -t <template-path> 模板目录，默认为：template目录
# -o <ouput-path>    输出目录，默认为：output目录

###3.2.模板引擎 该代码生成工具采用的模板引擎为：doT.js

• 语法对照

• 全局方法：可以通过it.func.方法名使用