brieucthomas/elixir-twig-extension

Laravel Elixir twig extension

Laravel Elixir Twig Extension

, _(*1)

The Laravel Elixir version task appends a unique hash to filename, allowing for cache-busting., _(*2)

``` js elixir(function(mix) { mix.version("css/all.css"); });, <sub>(*3)</sub>

For example, the generated file name will look something like: 
`all-16d570a7.css`.

In Laravel, you can use in your views the `elixir()` function to load 
the appropriately hashed asset:

``` html
<link rel="stylesheet" href="{{ elixir("css/all.css") }}">

This twig extension is an adaptation of this elixir() function., <sub>(*4)</sub>

Requirements

You need PHP >= 5.5.9 to use the library, but the latest stable version of PHP is recommended., <sub>(*5)</sub>

Install

Install using Composer:, <sub>(*6)</sub>

``` bash composer require brieucthomas/elixir-twig-extension, <sub>(*7)</sub>

This will edit (or create) your composer.json file and automatically 
choose the most recent version.

## Documentation

### Register the extension

``` php
use BrieucThomas\Twig\Extension\ElixirExtension;

$elixir = new ElixirExtension(
    $publicDir,     // the absolute public directory 
    $buildDir,      // the elixir build directory (default value is 'build')
    $manifestName   // the manifest filename (default value is 'rev-manifest.json')
);
$twig->addExtension($elixir);

Register the extension as a Symfony Service

``` yml, <sub>(*8)</sub>

app/config/services.yml

services: app.twig_elixir_extension: class: BrieucThomas\Twig\Extension\ElixirExtension arguments: ["%kernel.root_dir%/../web/"] public: false tags: - { name: twig.extension }, <sub>(*9)</sub>

### Create a gulpfile

Here an example of `gulpfile.js` to compile and version 
the script `app/Resources/js/app.js` :

```javascript
// gulpfile.js
const elixir = require('laravel-elixir');

elixir.config.assetsPath = 'app/Resources';
elixir.config.publicPath = 'web';
elixir.config.appPath = 'src';
elixir.config.viewPath = 'app/Resources/views';

elixir(function(mix) {
    // compile scripts to web/js/all.js (default output)
    mix.scripts(['app.js']);

    // version compiled scripts        
    mix.version(['js/all.js']);
});

Using the Extension

``` twig , <sub>(*10)</sub>

You can surround with the `asset` twig extension to make your 
application more portable:

``` twig
<link rel="stylesheet" href="{{ asset(elixir('css/all.css')) }}">
<script src="{{ asset(elixir('js/all.js')) }}"></script>