NEIAPI / nei-toolkit

NEI 接口文档管理平台配套自动化工具
https://nei.netease.com
MIT License
812 stars 123 forks source link

nei构建iOS工程时对参数namePrefix的统一处理 #18

Closed agger0207 closed 8 years ago

agger0207 commented 8 years ago

当前nei构建工程时,对于文件前缀存在三个参数进行描述:

  1. 命令行或者build.json中通过参数--namePrefix指定的网络请求前缀;如果不指定,默认为HT; 2.NEIKey.json中指定的模板替换规则"Prefix":"XYZ"会将工程模板中的{{Prefix}}替换成为指定的字符串
  2. NEIKey.json中指定的模板替换规则"CategoryPrefix":"xyz"会将工程模板中的{{CategoryPrefix}}替换成为指定的字符串。

使用者在构建自己的工程时,需要指定以上三个参数才可以正确生成自己想要的工程,不便于使用;因此希望toolkit改进如下:

  1. NEIKey.json中不再需要指定Prefix或者CategoryPrefix
  2. 即使在NEIKey.json中指定了Prefix或者CategoryPrefix, 一概忽略;
  3. 通过--namePrefix传递的参数默认替换掉{{Prefix}}, 并且以小写形式替换掉{{CategoryPrefix}}; 则用户只需要传递一个参数.
  4. 如果没有传递--namePrefix参数,直接报错,不继续执行。
  5. nei mobile命令如果没有传递--namePrefix参数,也直接报错,不继续执行;即不再提供默认的HT前缀;

参数名可以保持为namePrefix, 也可以统一替换为prefix或者Prefix

例如:

--namePrefix HTE, 则使用HTE替换掉模板文件中的{{Prefix}}, 使用hte替换掉模板文件中的{{CategoryPrefix}}.

agger0207 commented 8 years ago

fixed in v0.4.5.