Gckit-CLI

模板

介绍

Gckit-CLI文件生成最重要的条件就是需要模板的支持，每一种语言的每一种文件类型都需要唯一的一种模板所对应支持。系统默认提供了一套简单的模板，大家也可以根据需要自定义自己的一套适用的模板。

提示

 在执行文件生成时，必须保证对应的模板已经配置自定义。

  • 所有的语言文件类型的模板都可以支持用户自定义，只需要将自定义的模板文件放到.gckit的templates文件夹下即可
  • 当然大家可以贡献自己的模板，可以通过给我发 issue 提供您理想的模板
  • 推荐大家 Clone 一份gckit-templates然后根据需要自定义自己的模板
  • .gckit目录下存放templates文件夹底下即可

目录结构

模板文件的文件组织结构大概如下:

.
├── config
└── templates
    └── swift
        ├── api
        │   ├── all.template
        │   ├── common.template
        │   ├── inherit.template
        │   └── normal.template
        ├── cell
        │   ├── all.template
        │   ├── common.template
        │   ├── inherit.template
        │   └── normal.template
        ├── core
        │   ├── all.template
        │   ├── common.template
        │   ├── inherit.template
        │   └── normal.template

以Swift语言模板为例，在templates目录底下，顶级目录为语言(Swift首字母小写与.gckitconfig中的lang字段对应)，然后是各个文件类型目录(viewcontroller、model、cell...)，然后是对应的模板文件，一般情况提供了 normal、common、inherit、all四种不同的模板

加载顺序

模板文件可以加载系统提供的，也可以自定义存放到系统用户目录底下的.gckit目录下，当然也可以存放到项目级别的.gckit目录下，加载顺序是:

#与`.gckitconfig`文件的加载顺序是一样的
项目级别 -> 用户级别 -> Gckit-CLI 默认
  • 优先级最高为: 项目级别，当前项目下 存在.gckit并且对应的模板文件存在就优先加载
  • 次优先级为:用户级别，当项目目录下找不到对应的模板就会到系统的用户目录对应的.gckit目录下寻找，如果能找到就加载
  • 最低优先级为:Gckit-CLI默认提供的，当项目级别和用户级别都找不到最好才会匹配默认提供的模板

自定义模板

如果Gckit-CLI默认提供的模板满足不了自己的需求时，可以通过自定义模板来实现 自定义模板的步骤:

  1. 首先 Clone 一份gckit-templates项目
  2. 然后将 Clone 的项目中templates文件夹拷贝到用户目录.gckit或者项目的.gckit文件夹下
  3. 找到对应语言对应文件类型的模板，然后根据.gckitconfig中的配置参数自定义模板