# broccoli-underscore-template-compiler

**Repository Path**: mirrors_salsify/broccoli-underscore-template-compiler

## Basic Information

- **Project Name**: broccoli-underscore-template-compiler
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-19
- **Last Updated**: 2026-09-26

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Broccoli Underscore Template Compiler

## Installation

```bash
npm install -D broccoli-underscore-template-compiler
```

## Example

```javascript
var compileTemplates = require('broccoli-underscore-template-compiler');

var templatesTree = compileTemplates('templates', {
  description: 'TemplateCompiler (appTemplates)'
});
```

## Input Format

Given the following input:

```html
<template id="firstTemplate" data-notes="This is my first template">
  <%- message %>
</template>
```

This plugin will produce an ES6 module equivalent to:

```javascript
export var firstTemplate = _.extend(_.template('\n  <%- message %>\n'), {
  metadata: {
    notes: 'This is my first template'
  }
});

export default {
  firstTemplate: firstTemplate
};
```

Each `<template>` in the source file will be available as a field in the module's
default export, as well as an exported variable of the same name, with any data
attributes on the template available under a `metadata` hash hanging off of the
resulting function.

## Usage

The templates produced by this filter are just the output of Underscore's `_.template` function, so you can use them as [their documentation](http://underscorejs.org/#template) suggests:

```js
var helloTemplate = _.template("hello: <%= name %>");
helloTemplate({ name: 'moe' });
//=> "hello: moe"
```

The exported template function is exposed from the compiled module, e.g.

```html
<!-- templates/my-templates.html -->
<template id="helloTemplate">hello: <%= name %></template>
```

```js
import { helloTemplate } from 'templates/my-templates';
helloTemplate({ name: 'moe' });
//=> "hello: moe"
```

## Configuration

### `compileTemplates(inputTree, options)`

---

`options.extensions` *{Array}* (Optional, default `['html']`)

The file extensions which should be read and compiled as templates.

## License

This project is distributed under the MIT license.