https://github.com/gbicou/sbt-hbs
Handlebars precompiler for sbt-web
https://github.com/gbicou/sbt-hbs
Last synced: 5 months ago
JSON representation
Handlebars precompiler for sbt-web
- Host: GitHub
- URL: https://github.com/gbicou/sbt-hbs
- Owner: gbicou
- License: mit
- Archived: true
- Created: 2015-01-28T09:22:11.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2019-05-10T05:51:27.000Z (almost 6 years ago)
- Last Synced: 2024-08-12T14:04:31.551Z (8 months ago)
- Language: Scala
- Homepage:
- Size: 221 KB
- Stars: 1
- Watchers: 3
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-sbt-plugins - sbt-hbs
README
# sbt-hbs [](https://travis-ci.org/bicouy0/sbt-hbs)
[sbt-web] plugin for precompiling handlebars templates to javascript files, using the [handlebarsjs] compiler.
Installation
------------
To use this plugin use the addSbtPlugin command within your project's `plugins.sbt` file:
```scala
resolvers += Resolver.sbtPluginRepo("releases")
addSbtPlugin("com.bicou.sbt" % "sbt-hbs" % "1.0.5")
```
Your project's build file also needs to enable sbt-web plugins. For example with `build.sbt`:
```scala
lazy val root = (project in file(".")).enablePlugins(SbtWeb)
```
Install handlebarsjs, either globally with npm:
```shell
npm install handlebars -g
```
Or locally in your project with a `package.json` file:
```json
{
"devDependencies": {
"handlebars": "^3.0.0"
}
}
```
Supported settings
------------------
Option | Description | Default
-----------------|------------------------------------------------------------------------|---------
`amd` | When set, generates JavaScript with the [AMD wrapper] | `false`
`commonjs` | Exports CommonJS style, path to Handlebars module | `""`
`handlebarPath` | Path to handlebar.js (only valid for amd-style) | `""`
`known` | Known helpers | `[]`
`knownOnly` | Known helpers only | `false`
`namespace` | Template namespace | `""`
`root` | Template root (base value that will be stripped from template names) | `""`
`data` | Include data when compiling | `false`
`bom` | Removes the BOM (Byte Order Mark) from the beginning of the templates | `false`
`simple` | Output template function only | `false`
`map` | Generates source maps | `false`
The following sbt code illustrates how to generate templates with AMD wrapper
```scala
HbsKeys.amd := true
```
Usage
-----
Once configured, any `*.hbs` or `*.handlebars` files placed in `src/main/assets` will be compiled to JavaScript code in `target/web/public`, the handlebars name is build from file path, relative to `root` option.
For example the name of the template located in `app/assets/javascripts/templates/index.hbs` will be `javascripts/templates/index`, unless you set `HbsKeys.root := "javascripts/templates/"` then it will be `index` (it's the handlebars id, not the javascript path).
If a file name begins with an underscore, it will be handled as a partial.
Don't forget to include the handlebars runtime via `"org.webjars" % "handlebars" % "3.0.0-1"` or by copying/linking in your public javascripts (`node_modules/handlebars/dist/handlebars.runtime.js` with npm).
Example
-------
Browse [play-rjs-coffee-hbs](https://github.com/bicouy0/play-rjs-coffee-hbs) repository to see usage with play framework.
License
-------
This code is licensed under the [MIT License].
[sbt-web]:https://github.com/sbt/sbt-web
[handlebarsjs]:http://handlebarsjs.com/
[AMD wrapper]:http://requirejs.org/docs/whyamd.html
[MIT License]:http://opensource.org/licenses/MIT