# laravel-mix-ejs
> Laravel Mix extension to compile EJS templates
Latest version **2.0.1** (published 2022-09-28) · MIT license · 0 weekly downloads
## Install
```sh
npm install laravel-mix-ejs
pnpm add laravel-mix-ejs
yarn add laravel-mix-ejs
bun add laravel-mix-ejs
```
## Health
**Score 15/100 (F)** — status: abandoned.
Positive: no vulnerabilities.
Warnings: low downloads; no types; no esm support.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 2.0.1 |
| Published | 2022-09-28 |
| First published | 2019-07-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 6 |
| Unpacked size | 12.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | dsktschy |
| Maintainers | dsktschy |
| Keywords | laravel, mix, ejs |
## Links
- npm: https://www.npmjs.com/package/laravel-mix-ejs
- Repository: https://github.com/dsktschy/laravel-mix-ejs
- Homepage: https://github.com/dsktschy/laravel-mix-ejs#readme
- Issues: https://github.com/dsktschy/laravel-mix-ejs/issues
- npm.io page: https://npm.io/package/laravel-mix-ejs
## Dependencies (6)
- [ejs](https://npm.io/package/ejs.md) ^3.1.7
- [globby](https://npm.io/package/globby.md) ^10.0.1
- [is-glob](https://npm.io/package/is-glob.md) ^4.0.1
- [anymatch](https://npm.io/package/anymatch.md) ^3.0.3
- [chokidar](https://npm.io/package/chokidar.md) ^3.0.2
- [fs-extra](https://npm.io/package/fs-extra.md) ^8.1.0
## Recent versions
- 2.0.1 (latest) — 2022-09-28
- 2.0.0-alpha.3 (next) — 2022-09-04
- 2.0.0 — 2022-09-19
- 1.1.5 — 2022-09-04
- 2.0.0-alpha.2 — 2022-09-04
- 1.1.4 — 2022-09-04
- 2.0.0-alpha.1 — 2022-03-09
- 2.0.0-alpha.0 — 2022-03-08
- 1.1.3 — 2019-07-30
- 1.1.2 — 2019-07-28
- 1.0.0 — 2019-07-22
## README
# Laravel Mix EJS [](https://www.npmjs.com/package/laravel-mix-ejs) [](https://github.com/dsktschy/laravel-mix-ejs/blob/master/LICENSE.txt)
This extention provides a method to compile EJS templates, in which [the `mix` function](https://laravel-mix.com/docs/6.0/versioning#laravel-users) is available.
## Installation
### With laravel-mix@>=6
```sh
$ npm install --save-dev laravel-mix-ejs
```
### With laravel-mix@<6
```sh
$ npm install --save-dev laravel-mix-ejs@1
```
## Usage
```js
const mix = require('laravel-mix')
require('laravel-mix-ejs')
mix.ejs(
'src/templates',
'dist',
{},
{ base: 'src/templates' }
)
```
## API
### ejs(from, to, data, options)
#### from
Type: `string | string[]`
Paths or glob patterns to files and directories to be copied.
#### to
Type: `string`
Destination path for copied files and directories.
#### data
Type: `object`
Overwrites the parameters used in the templates.
```js
mix.ejs(
'src',
'dist',
{ title: 'Foo' },
{ base: 'src' }
)
```
```html
<% const heading = 'Bar' %>
<%= title %>
<%= heading %>
Foo
Bar
```
Contains the following parameters by default since v2.
##### **[>= v2]** mix(filePath)
[The `mix` function](https://laravel-mix.com/docs/6.0/versioning#laravel-users). It returns a hashed file path in `mix-manifest.json`.
Note: Currently, hashes are output only when Laravel Mix versioning is enabled and in production mode. If needed in development mode as well, [please use this way](https://github.com/dsktschy/laravel-mix-ejs/issues/6#issuecomment-1258324544).
```js
mix
.setPublicPath('dist')
.version()
.js('src/js/app.js', 'dist/js')
.sass('src/sass/app.scss', 'dist/css')
.ejs(
'src/templates',
'dist',
{}, // The `mix` function is provided by default since v2
{ base: 'src/templates' }
)
```
```html
```
##### **[>= v2]** webpackCompilation
##### **[>= v2]** webpackConfig
#### options
Type: `object`
In addition to [the EJS options](https://github.com/mde/ejs#options), the following properties can also be set.
##### base
Type: `string`
Default: `''`
When a path to a directory is set, the directory will be copied with the hierarchical structure kept.
```js
// src/foo/bar.ejs -> dist/bar.html
mix.ejs(
'src',
'dist'
)
// src/foo/bar.ejs -> dist/foo/bar.html
mix.ejs(
'src',
'dist',
{},
{ base: 'src' }
)
```
##### ext
Type: `string`
Default: `'.html'`
Changes the output file extension.
```js
// src/index.ejs -> dist/index.html
mix.ejs(
'src',
'dist',
{},
{ base: 'src' }
)
// src/index.ejs -> dist/index.php
mix.ejs(
'src',
'dist',
{},
{
base: 'src',
ext: '.php'
}
)
```
##### partials
Type: `string | string[]`
Default: `[]`
Paths set to this option will be watched but not output. Use for partial templates that are used with `include()`.
```js
// src/partials/header.ejs -> dist/partials/header.html
mix.ejs(
'src',
'dist',
{},
{ base: 'src' }
)
// src/partials/header.ejs -> No output
mix.ejs(
'src',
'dist',
{},
{
base: 'src',
partials: 'src/partials'
}
)
```
---
_Source: https://npm.io/package/laravel-mix-ejs · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._