https://github.com/jimschubert/finagle.g8
https://github.com/jimschubert/finagle.g8
Last synced: over 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/jimschubert/finagle.g8
- Owner: jimschubert
- License: mit
- Created: 2018-02-21T15:00:23.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2018-02-21T15:00:48.000Z (over 8 years ago)
- Last Synced: 2025-02-15T05:46:38.744Z (over 1 year ago)
- Language: Scala
- Size: 4.88 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
This is a Giter8 template for Finatra
```
sbt new jimschubert/finagle.g8
```
[License](./LICENSE)
# Notes
Giter8 will apply templating to the contents of `src/main/g8`, using the `default.properties` file within that directory as the prompts for templating.
Giter8 also supports scaffolding using the *sbt-giter8-scaffold* plugin. There are some intricacies to scaffolding to note:
* `src/main/scaffolds` is copied to the output directory as `.g8`
* directories immediately below `src/main/scaffolds` are the templates available
* scaffolding can have its own prompts, but Giter8 doesn't apply template replacements against scaffolds (otherwise, the output files would no longer be templates), so a templated `.g8/controllers/default.properties` file exists.
* The property `name` has special meaning in Giter8, and is used to identify module outputs.
For example a template defined with `controlers/src/main/scala/$name$.scala` and `name=plugin` will result in the output `plugin/controlers/src/main/scala/plugin.scala`. This can be unintuitive, which is why it's documented here
Any files you *don't* want to have templating applied against can be defined in `default.properties` as regex in the space-delimited `verbatim` prompt.