Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fullpipe/twig-webpack-extension
Inject your webpack entry points into twig templates with easy.
https://github.com/fullpipe/twig-webpack-extension
Last synced: about 4 hours ago
JSON representation
Inject your webpack entry points into twig templates with easy.
- Host: GitHub
- URL: https://github.com/fullpipe/twig-webpack-extension
- Owner: fullpipe
- License: mit
- Created: 2016-06-18T12:55:14.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2023-03-04T05:48:55.000Z (over 1 year ago)
- Last Synced: 2024-05-14T04:21:54.446Z (6 months ago)
- Language: PHP
- Size: 343 KB
- Stars: 51
- Watchers: 3
- Forks: 14
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Twig Webpack extension
[](https://packagist.org/packages/fullpipe/twig-webpack-extension)
[](LICENSE)
[](https://packagist.org/packages/fullpipe/twig-webpack-extension/stats)
[](https://github.com/fullpipe/twig-webpack-extension/actions)
Inject your webpack entry points into twig templates with easy.
This repo provides a Twig extension that joins Webpack resultant files with Twig template engine in an easy way.
This approach allows the dynamic insertion of the css stylesheets and js scripts with Webpack generated hash.
> Also works well with **extract-text-webpack-plugin**
## Install
```bash
composer require fullpipe/twig-webpack-extension
```
### Set up Webpack
You need to install the `webpack-manifest-plugin`
```bash
npm install webpack-manifest-plugin --save
```
or with Yarn
```bash
yarn add webpack-manifest-plugin
```
Configure `webpack.config.js`
```js
// webpack.config.js
var ManifestPlugin = require('webpack-manifest-plugin');
const path = require("path");
module.exports = {
...
entry: {
vendor: ["jquery", "lodash"],
main: './src/main.js'
},
output: {
...
filename: "js/[name].js",
path: path.resolve(__dirname, "../public/build"),
publicPath: '/build/', // required
},
plugins: [
new ManifestPlugin(),
new ExtractTextPlugin({
filename: "css/[name].css",
publicPath: "/build/",
}),
]
}
```
### Register as a Twig extension
```yaml
# app/config/services.yml
parameters:
webpack.manifest: "%kernel.root_dir%/../public/build/manifest.json" #should be absolute
webpack.public_dir: "%kernel.root_dir%/../public" #your public-dir
services:
twig_extension.webpack:
class: Fullpipe\TwigWebpackExtension\WebpackExtension
public: false
arguments:
- "%webpack.manifest%"
- "%webpack.public_dir%"
tags:
- { name: twig.extension }
```
### Inject entry points to your Twig
```twig
{# app/Resources/views/base.html.twig #}
...
{% webpack_entry_css 'main' %}
{% webpack_entry_css 'inline' inline %}
...
{% webpack_entry_js 'vendor' %}
{% webpack_entry_js 'main' defer %}
{% webpack_entry_js 'second' async %}
{% webpack_entry_js 'inline' inline %}
```
### Example
See working [example](example) with [webpack.config.js](example/frontend/webpack.config.js).
## Hashing output files avoiding the browser cache
If you use `[hash]` or `[chunkhash]`:
```js
// webpack.config.js
...
output: {
...
filename: '[name].[chunkhash].js',
chunkFilename: '[name].[chunkhash].js'
},
plugins: [
new ExtractTextPlugin({
...
filename: 'css/[name].[contenthash].css',
}),
]
```
You should clear twig cache after each webpack compilation.
So for dev environment do not use `[hash]` or `[chunkhash]`.