incenteev/hashed-asset-bundle

Apply an asset version based on a hash of the asset for symfony/asset

Installs: 54 798

Dependents: 1

Suggesters: 0

Stars: 23

Watchers: 3

Forks: 3

Open Issues: 1

Type:symfony-bundle

v1.0.2 2018-05-25 14:13 UTC

README

The HashedAssetBundle provides an asset version strategy which uses a hash of the file content as asset version. This allows bumping the asset version separately for each asset (automatically).

Build Status Total Downloads Latest Stable Version

Installation

Use Composer to install the bundle:

$ composer require incenteev/hashed-asset-bundle

Usage

Register the bundle in the kernel:

// app/AppKernel.php

// ...

class AppKernel extends Kernel {
    public function registerBundles()
    {
        $bundles = array(
            // ...
            new Incenteev\HashedAssetBundle\IncenteevHashedAssetBundle(),
        );
    }
}

Then configure FrameworkBundle to use the new version strategy:

framework:
    assets:
        version_strategy: incenteev_hashed_asset.strategy

Advanced configuration

The default configuration should fit common needs, but the bundle exposes a few configuration settings in case you need them:

incenteev_hashed_asset:
    # Absolute path to the folder in which assets can be found
    # Note: in case you apply a base_path in your asset package, it is not
    # yet applied to the string received by the bundle
    web_root: '%kernel.root_dir%/../web'
    # Format used to apply the version. This is equivalent to the
    # `framework > assets > version_format` of the static version strategy
    # of FrameworkBundle.
    version_format: '%%s?%%s'

License

This bundle is under the MIT license.

Alternative projects

If you want to apply cache busting by renaming files in your asset pipeline (for instance with the gulp-rev plugin), have a look at https://github.com/irozgar/gulp-rev-versions-bundle which processes a manifest file.

Reporting an issue or a feature request

Issues and feature requests are tracked in the Github issue tracker.