Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lukeed/webpack-plugin-replace
Replace content while bundling.
https://github.com/lukeed/webpack-plugin-replace
Last synced: about 2 months ago
JSON representation
Replace content while bundling.
- Host: GitHub
- URL: https://github.com/lukeed/webpack-plugin-replace
- Owner: lukeed
- License: mit
- Created: 2017-06-04T01:13:32.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2021-08-09T08:02:20.000Z (about 3 years ago)
- Last Synced: 2024-06-30T01:20:01.266Z (3 months ago)
- Language: JavaScript
- Size: 13.7 KB
- Stars: 36
- Watchers: 6
- Forks: 8
- Open Issues: 7
-
Metadata Files:
- Readme: readme.md
- License: license
Awesome Lists containing this project
README
# webpack-plugin-replace [](https://travis-ci.org/lukeed/webpack-plugin-replace)
> Replace content while bundling.
## Install
```
$ npm install --save-dev webpack-plugin-replace
```
## Usage
```js
// webpack.config.js
const ReplacePlugin = require('webpack-plugin-replace');
module.exports = {
// ...
plugins: [
new ReplacePlugin({
exclude: [
'foo.js',
/node_modules/,
filepath => filepath.includes('ignore')
],
patterns: [{
regex: /throw\s+(new\s+)?(Type|Reference)?Error\s*\(/g,
value: 'return;('
}],
values: {
'process.env.NODE_ENV': JSON.stringify('production'),
'FOO_BAR': '"hello world"',
'DEV_MODE': false,
}
})
]
};
```
## API
### webpack-plugin-replace(options)
#### options.exclude
Type: `Array|String|Function|RegExp`
Default: `false`
If multiple conditions are provided, matching _any_ condition will exclude the filepath, which prevents any alterations.
> **Note:** By default, nothing is excluded!
#### options.include
Type: `Array|String|Function|RegExp`
Default: `true`
If multiple conditions are provided, matching _any_ condition will include & scan the filepath for eligible replacements.
> **Note:** By default, all filepaths are included!
#### options.patterns
Type: `Array`
Default: `[]`
An array of `RegExp` pattern definitions. Each definition is an object with `regex ` and `value ` keys. If `value` is a function, it takes the same arguments as [`String.prototype.relace`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/replace#Specifying_a_function_as_a_parameter).
#### options.values
Type: `Object`
Default: `{}`
An object whose keys are `strings` that should be replaced and whose values are `strings` the replacements.
If desired, you may forgo the `values` key & declare your `key:value` pairs directly to the main configuration. For example:
```js
{
exclude: /node_modules/,
values: {
'process.env.NODE_ENV': JSON.stringify('production'),
}
}
// is the same as:
{
exclude: /node_modules/,
'process.env.NODE_ENV': JSON.stringify('production'),
}
```
## License
MIT © [Luke Edwards](https://lukeed.com)