https://github.com/dadi/web-dustjs
A Dust.js interface for DADI Web
https://github.com/dadi/web-dustjs
dadi dadi-web dust dust-js schema-less web-server
Last synced: 6 months ago
JSON representation
A Dust.js interface for DADI Web
- Host: GitHub
- URL: https://github.com/dadi/web-dustjs
- Owner: dadi
- Created: 2017-05-05T10:53:56.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2019-05-01T09:07:33.000Z (over 6 years ago)
- Last Synced: 2024-04-25T11:42:36.299Z (over 1 year ago)
- Topics: dadi, dadi-web, dust, dust-js, schema-less, web-server
- Language: JavaScript
- Size: 26.4 KB
- Stars: 1
- Watchers: 6
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Dust.js engine interface
[](https://www.npmjs.com/package/@dadi/web-dustjs)
[](https://coveralls.io/github/dadi/web-dustjs?branch=master)
[](https://travis-ci.org/dadi/web-dustjs)
[](http://standardjs.com/)
[](https://github.com/semantic-release/semantic-release)
This module allows [Dust.js](http://www.dustjs.com/) templates to be used with [DADI Web](https://github.com/dadi/web).
## Installation
- Add this module as a dependency:
```
npm install @dadi/web-dustjs --save
```
- Include it in the `engines` array passed to Web:
```npm
require('@dadi/web')({
engines: [
require('@dadi/web-dustjs')
]
})
```
## Configuration
The following configuration parameters can be added to the global Web config file, under `engines.dust`.
### `cache`
If `true`, compiled templates are saved to the Dust cache (recommended).
- Format: `Boolean`
- Default: `true`
---
### `debug`
Dust.js debug mode enabled.
- Format: `Boolean`
- Default: `false`
---
### `debugLevel`
The debug level to use. Should be one of `DEBUG`, `INFO`, `WARN` or `ERROR`.
- Format: `String`
- Default: 'WARN'
---
## `whitespace`
Preserve whitespace in the output.
- Format: `Boolean`
- Default: `true`
---
## `clientRender`
#### `enabled`
If `true`, compiled templates are made available to the client-side.
- Format: `Boolean`
- Default: `false`
#### `format`
Defines whether compiled templates are written to individual JS files ('separate') or combined into a single one ('combined').
- Format: ['separate', 'combined']
- Default: 'separate'
#### `path`
The location where compiled templates should be written to, relative to 'public'. This should be a folder when 'format' is 'separate' and a file when 'combined'.
- Format: `String`
- Default: `'templates'`
#### `whitelist`
When defined, only templates with names matching an entry in whitelist will be made available to the client. Wildcards supported.
- Format: `Array`
- Default: `[]`
---
### `paths`
Paths required by Dust.
- Format: `Object`
- Default:
```
{
{
filters: 'workspace/utils/filters',
helpers: 'workspace/utils/helpers'
}
}
```
## Helpers
This module automatically includes the official set of [helpers by LinkedIn](https://github.com/linkedin/dustjs-helpers). Other helper modules will need to be required manually, using a loader file placed in the helpers directory defined in config (e.g. `workspace/utils/helpers/loader.js`)
*Example:*
```js
var components = require('@dadi/web').Components
var dust = require('dustjs-linkedin')
// Load common-dustjs-helpers
var commonDustHelpers = require('common-dustjs-helpers')
new commonDustHelpers.CommonDustjsHelpers().export_helpers_to(dust)
// Load the DADI helper pack
require('@dadi/dustjs-helpers')(dust, { components: components })
```