Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/juliendargelos/rollup-plugin-emit-ejs
Emit files from ejs with rollup
https://github.com/juliendargelos/rollup-plugin-emit-ejs
ejs rollup rollup-plugin
Last synced: 2 months ago
JSON representation
Emit files from ejs with rollup
- Host: GitHub
- URL: https://github.com/juliendargelos/rollup-plugin-emit-ejs
- Owner: juliendargelos
- License: mit
- Created: 2019-09-12T15:31:38.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-06T07:03:01.000Z (almost 2 years ago)
- Last Synced: 2024-03-14T15:25:55.986Z (9 months ago)
- Topics: ejs, rollup, rollup-plugin
- Language: TypeScript
- Size: 1.7 MB
- Stars: 3
- Watchers: 2
- Forks: 1
- Open Issues: 16
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
- awesome - emit-ejs - Emit files from ejs templates. (Plugins / Output)
README
# rollup-plugin-emit-ejs
[](https://github.com/juliendargelos/rollup-plugin-emit-ejs/actions?workflow=test)
[](https://github.com/juliendargelos/rollup-plugin-emit-ejs/actions?workflow=build)
[](https://github.com/juliendargelos/rollup-plugin-emit-ejs)
This plugin allows you to emit files from ejs templates to rollup bundle.
It is primarily meant to emit html files since it helps you to link bundled javascripts/stylesheets and includes a basic layout system, but it can deal with any file type.
Unlike [rollup-plugin-bundle-html](https://github.com/haifeng2013/rollup-plugin-bundle-html), this plugin uses the [emitFile()](https://rollupjs.org/guide/en/#thisemitfileemittedfile-emittedchunk--emittedasset--string) plugin context method which allow other plugins like [rollup-plugin-html-minifier](https://github.com/juliendargelos/rollup-plugin-html-minifier) to process the emitted files.
## Install
```bash
yarn add rollup-plugin-emit-ejs --dev
```
or
```bash
npm install rollup-plugin-emit-ejs -D
```
## Usage
```javascript
// rollup.config.js
import emitEJS from 'rollup-plugin-emit-ejs'
export default {
// ...
plugins: [
emitEJS({
src: 'src',
layout: 'src/layout.html.ejs',
data: {
title: 'Hey',
body: 'Hey Hey Hey'
}
})
]
}
```
```ejs
<%= title %>
<% stylesheets.forEach(stylesheet => { %>
<% }) %>
<%- content %>
<% javascripts.forEach(javascript => { %>
<% }) %>
```
```ejs
<%= body %>
```
This will emit a file named `index.html` next to the javascript bundle file.
## Options
```typescript
{
src: string
dest?: string
include?: string | string[]
exclude?: string | string[]
layout?: string
extension?: string
data?: Data
options?: Options
}
```
### src
Source directory to find ejs templates from.
Required
### dest
Relative path from bundle location where to output files from ejs templates.
Default: `'.'`
### include
Glob or array of globs defining which templates to include.
Default: `'**/*.ejs'`
### exclude
Glob or array of globs defining which templates to exclude.
Default: `[]`
> Note that the template provided in the `layout` option is automatically excluded.
### layout
Path to an ejs template to use as layout. Skip this option if you don't need layout.
Default: `undefined`
### extension
Extension to append to emitted files (the leading `.` can be omitted).
Default: `undefined`
> Note that the trailing `.ejs` extension is automatically removed from template filenames. So this option is useful if you only want to use the `.ejs` extension in your template filenames, but need to replace it with another extension like `.html`. Otherwise, you can just stack the output extension directly in the filename (`index.html.ejs`) and skip this option.
### data
Data to pass to ejs.
Default: `{}`
> The following helper variables are forced by the plugin and available in all templates:
> - `javascripts`: array of relative paths to javascripts
> - `stylesheets`: array of relative paths to stylesheets
>
> In the layout, an extra `content` variable is passed containing the content to wrap into the layout. This variable needs to be printed **unescaped** if you want to use it as html, use the corresponding ejs tag: `<%-` (See [ejs tags](https://github.com/mde/ejs#tags))
### options
Options to pass to ejs. (See [ejs options](https://github.com/mde/ejs#options))
Default: `{}`
> Note that the `filename` options is forced by the plugin.