Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jamesjieye/html-webpack-exclude-assets-plugin
Add the ability to exclude assets based on RegExp patterns
https://github.com/jamesjieye/html-webpack-exclude-assets-plugin
html-webpack-plugin webpack
Last synced: about 1 month ago
JSON representation
Add the ability to exclude assets based on RegExp patterns
- Host: GitHub
- URL: https://github.com/jamesjieye/html-webpack-exclude-assets-plugin
- Owner: jamesjieye
- License: mit
- Created: 2016-11-21T03:47:58.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2018-03-23T05:14:12.000Z (over 6 years ago)
- Last Synced: 2024-04-23T11:18:31.893Z (7 months ago)
- Topics: html-webpack-plugin, webpack
- Language: JavaScript
- Size: 12.7 KB
- Stars: 52
- Watchers: 3
- Forks: 14
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Exclude Assets extension for the HTML Webpack Plugin
========================================
[](https://badge.fury.io/js/html-webpack-exclude-assets-plugin) [](https://travis-ci.org/jamesjieye/html-webpack-exclude-assets-plugin) [](https://github.com/Flet/semistandard)
Enhances [html-webpack-plugin](https://github.com/ampedandwired/html-webpack-plugin)
functionality by adding the `{excludeAssets: RegExp | [RegExp]}` option to allow you to exclude assets.
When adding an entry with third party css files, for example, `style: ['bootstrap/dist/css/bootstrap.css']`, to webpack, the injected scripts include style.js or style.[chunkhash].js. The `excludeChunks` option of `html-webpack-plugin` will exclude both style.css and style.js. With this plugin, you can keep style.css in and style.js out by setting `excludeAssets: /style.*.js/`.
You can also exclude CSS assets, for example, a theme CSS style, by setting `excludeAssets: /theme.*.css/`.
Installation
------------
You must be running webpack on Node v4.0.0 or higher.
Note: `style-loader`'s dependency `loader-utils` only supports Node v4.0.0 since v1.0. See `style-loader`'s [#174 pull request](https://github.com/webpack-contrib/style-loader/pull/174) for details.
Install the plugin with npm:
```shell
$ npm install --save-dev html-webpack-exclude-assets-plugin
```
Basic Usage
-----------
Require the plugin in your webpack config:
```javascript
var HtmlWebpackExcludeAssetsPlugin = require('html-webpack-exclude-assets-plugin');
```
Add the plugin to your webpack config as follows:
```javascript
plugins: [
new HtmlWebpackPlugin(),
new HtmlWebpackExcludeAssetsPlugin()
]
```
The above configuration will actually do nothing due to the configuration defaults.
When you set `excludeAssets` to an array of regular expressions or a single regular expression, the matched assets will be skipped when the chunks are injected into the HTML template.
```javascript
plugins: [
new HtmlWebpackPlugin({
excludeAssets: [/style.*.js/] // exclude style.js or style.[chunkhash].js
}),
new HtmlWebpackExcludeAssetsPlugin()
]
```