https://github.com/electerious/rosid-handler-ejs
Load EJS templates and render them.
https://github.com/electerious/rosid-handler-ejs
ejs html rosid transpiler
Last synced: about 1 year ago
JSON representation
Load EJS templates and render them.
- Host: GitHub
- URL: https://github.com/electerious/rosid-handler-ejs
- Owner: electerious
- License: mit
- Created: 2015-12-27T21:30:15.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2022-01-08T15:50:34.000Z (over 4 years ago)
- Last Synced: 2025-04-18T16:38:51.456Z (about 1 year ago)
- Topics: ejs, html, rosid, transpiler
- Language: JavaScript
- Homepage:
- Size: 89.8 KB
- Stars: 5
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# rosid-handler-ejs
[](https://travis-ci.org/electerious/rosid-handler-ejs) [](https://coveralls.io/github/electerious/rosid-handler-ejs?branch=master) [](https://david-dm.org/electerious/rosid-handler-ejs#info=dependencies) [](https://greenkeeper.io/)
A function that loads an EJS file and transforms it to HTML.
## Install
```
npm install rosid-handler-ejs
```
## Usage
### API
```js
const handler = require('rosid-handler-ejs')
handler('index.ejs').then((data) => {})
handler('index.xml').then((data) => {})
handler('index.ejs', { optimize: true }).then((data) => {})
handler('index.ejs', { data: { key: 'value' } }).then((data) => {})
handler('index.ejs', { data: 'data.json' }).then((data) => {})
```
### Rosid
Add the following object to your `rosidfile.json`, `rosidfile.js` or [routes array](https://github.com/electerious/Rosid/blob/master/docs/Routes.md). `rosid-handler-ejs` will transform all matching EJS files in your source folder to HTML.
```json
{
"name" : "EJS",
"path" : "[^_]*.{html,ejs}*",
"handler" : "rosid-handler-ejs"
}
```
```html
Hello <%= 'World' %>
```
```html
Hello World
```
## Parameters
- `filePath` `{String}` Path to file.
- `opts` `{?Object}` Options.
- `optimize` `{?Boolean}` - Optimize output. Defaults to `false`.
- `data` `{?Object|String}` - Data used to render the template. Defaults to `{}`.
- `localOverwrites` `{?Boolean}` - Enable or disable [custom data per file](#custom-data-per-file). Defaults to `true`.
## Returns
- `{Promise}` The transformed file content.
## Miscellaneous
### Data
The data in `opts.data` will be used to render your template. `opts.data` can either be an object (the data) or a string (path to data file). `rosid-handler-ejs` tries to require the path when a string is specified instead of an object. The path must be absolute or relative to the current working directory.
### Custom data per file
Create a file with the name `filename.data.json` or `filename.data.js` along your `filename.ejs` to add or overwrite data from `opts.data`. You can disable this behaviour with the `localOverwrites` option.
### Environment
`rosid-handler-ejs` passes a variable called `environment` to your template. `environment` is `prod` when `opts.optimize` is `true` and `dev` when `opts.optimize` is `false`.