rollup-plugin-emit-ejs
v3.1.0
Published
Emit files from ejs with rollup
Downloads
4,667
Readme
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, this plugin uses the emitFile() plugin context method which allow other plugins like rollup-plugin-html-minifier to process the emitted files.
Install
yarn add rollup-plugin-emit-ejs --devor
npm install rollup-plugin-emit-ejs -DUsage
// 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'
}
})
]
}<!-- src/layout.html.ejs !-->
<!doctype html>
<html>
<head>
<meta charset="utf-8">
<title><%= title %></title>
<% stylesheets.forEach(stylesheet => { %>
<link rel="stylesheet" href="<%= stylesheet %>">
<% }) %>
</head>
<body>
<%- content %>
<% javascripts.forEach(javascript => { %>
<script src="<%= javascript %>"></script>
<% }) %>
</body>
</html><!-- src/index.html.ejs !-->
<main>
<p><%= body %></p>
</main>This will emit a file named index.html next to the javascript bundle file.
Options
{
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
layoutoption 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
.ejsextension is automatically removed from template filenames. So this option is useful if you only want to use the.ejsextension 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 javascriptsstylesheets: array of relative paths to stylesheetsIn the layout, an extra
contentvariable 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)
options
Options to pass to ejs. (See ejs options)
Default: {}
Note that the
filenameoptions is forced by the plugin.