# grunt-nunjucks

> Grunt task for precompiling nunjucks templates

Latest version **0.1.4** (published 2014-03-14) · 0 weekly downloads

## Install

```sh
npm install grunt-nunjucks
pnpm add grunt-nunjucks
yarn add grunt-nunjucks
bun add grunt-nunjucks
```

## Health

**Score 10/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; low quality score; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.4 |
| Published | 2014-03-14 |
| First published | 2013-10-24 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 0.8.0 |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 40 |
| Author | James Long |
| Maintainers | jlongster |
| Keywords | gruntplugin |

## Links

- npm: https://www.npmjs.com/package/grunt-nunjucks
- Repository: https://github.com/jlongster/nunjucks-grunt
- Issues: https://github.com/jlongster/nunjucks-grunt/issues
- npm.io page: https://npm.io/package/grunt-nunjucks

## Recent versions

- 0.1.4 (latest) — 2014-03-14
- 0.1.3 — 2014-02-10
- 0.1.2 — 2014-02-07
- 0.1.1 — 2014-01-17
- 0.1.0 — 2013-10-24

## README

# grunt-nunjucks

A grunt task to precompile your nunjucks templates easily. Use this in
combination with
[grunt-contrib-watch](https://github.com/gruntjs/grunt-contrib-watch)
to automatically precompile your templates on change.

## Getting Started
This plugin requires Grunt `~0.4.1`

If you haven't used [Grunt](http://gruntjs.com/) before, be sure to check out the [Getting Started](http://gruntjs.com/getting-started) guide, as it explains how to create a [Gruntfile](http://gruntjs.com/sample-gruntfile) as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

```shell
npm install grunt-nunjucks --save-dev
```

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

```js
grunt.loadNpmTasks('grunt-nunjucks');
```

## The "nunjucks" task

### Overview
In your project's Gruntfile, add a section named `nunjucks` to the data object passed into `grunt.initConfig()`.

```js
grunt.initConfig({
  nunjucks: {
    options: {
      // Task-specific options go here.
    },
    your_target: {
      // Target-specific file lists and/or options go here.
    },
  },
})
```

A real example:

```js
grunt.initConfig({
    nunjucks: {
        precompile: {
            baseDir: 'views/',
            src: 'views/*',
            dest: 'static/js/templates.js',
            options: {
                env: require('./nunjucks-environment'),
                name: function(filename) {
                    return 'foo/' + filename;
                }
            }
        }
    }
});

grunt.loadNpmTasks('grunt-nunjucks');
```

Grunt provides several ways to specify file sources and destinations.
Read more about how to configure the files
[here](http://gruntjs.com/configuring-tasks#files).

This is really powerful when combing with
[`grunt-contrib-watch`](https://github.com/gruntjs/grunt-contrib-watch).
This will automatically precompile your templates every time one of
them is changed, so you can simply use precompile template in
development too. That makes deployment easier since you're using the
same configuration as production.

```
    watch: {
        nunjucks: {
            files: 'views/*',
            tasks: ['nunjucks']
        }
    }
```

### Options

#### options.asFunction
Type: `Boolean` (default: `false`)

Compile each template as a callable function. Use this if you want to
compile each template file into a separate js file as a simple
callable object.

#### options.env
Type: `nunjucks.Environment`

The nunjucks `Environment` object to use at compile-time. You need
this if you use extensions or asynchronous filters. See
[Precompiling](http://jlongster.github.com/nunjucks/api.html#api1).

Note that this `env` only exists so the precompiler can compile code
correctly with your extensions or async filters. You still need to set
up and configure an `env` on the client-side. It's recommended that
you isolate your `env` configuration into it's own module so it can
load it from multiple places.

#### options.name
Type: `function(filepath: string)` (default: filepath)

Define a function to transform each template's filepath into a template name.
These names are used with [`nunjucks.render`](http://jlongster.github.io/nunjucks/api.html#render).

---
_Source: https://npm.io/package/grunt-nunjucks · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._