脚手架插件

Giter8 提供了一个 sbt 插件用以创建和使用脚手架.

使用脚手架插件

加入下面行到 project/scaffold.sbt 文件中

addSbtPlugin("org.foundweekends.giter8" % "giter8-scaffold" % "0.7.1")

完后就可以在 sbt 控制台下运行 g8Scaffold 命令. 使用 TAB 自动完成功能会发现可用的脚手架模板.

> g8Scaffold <TAB>
controller   global       model

这个模板插件会提示完成脚手架创建所需的属性:

> g8Scaffold controller
className [Application]:

创建一个脚手架

g8 运行时会在给定的 Github 项目的 src/main/scaffolds 目录下寻找所有的脚手架. 每个 src/main/scaffolds 下的子目录就是一个单独的脚手架, 并可在 sbt 控制台下通过目录名来访问. 脚手架目录下也可以有一个像原始模板目的 default.properties 文件, 用来定义字段值. name 在这里也是一个特殊字段: 如果它存在, scaffold 会以 name 的值来创建一个目录, 其中的子目录布局将与源脚手架目录保持一致.

脚手架目录是建立在模板项目根目录下的 <project_root>.g8

$ ls sample/.g8
total 0
drwxr-xr-x   5 jtournay  staff   170B Aug  6 03:21 .
drwxr-xr-x  11 jtournay  staff   374B Aug  6 05:29 ..
drwxr-xr-x   4 jtournay  staff   136B Aug  6 03:21 controller
drwxr-xr-x   4 jtournay  staff   136B Aug  6 03:21 global
drwxr-xr-x   4 jtournay  staff   136B Aug  6 03:21 model

你也可以通过创建 .g8 目录来为你的 sbt 项目创建自己的脚手架.

Giter8 — 合并的页面