https://github.com/mrbar42/ignore-emit-webpack-plugin
Prevents ignored files from being emitted during a Webpack build
https://github.com/mrbar42/ignore-emit-webpack-plugin
ignore-files webpack-plugin webpack2
Last synced: 4 months ago
JSON representation
Prevents ignored files from being emitted during a Webpack build
- Host: GitHub
- URL: https://github.com/mrbar42/ignore-emit-webpack-plugin
- Owner: mrbar42
- License: mit
- Created: 2017-07-08T07:00:24.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-04-18T18:12:36.000Z (almost 2 years ago)
- Last Synced: 2024-11-01T06:42:29.075Z (4 months ago)
- Topics: ignore-files, webpack-plugin, webpack2
- Language: TypeScript
- Size: 364 KB
- Stars: 18
- Watchers: 2
- Forks: 1
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Ignore Emit Webpack plugin
[](https://travis-ci.org/mrbar42/ignore-emit-webpack-plugin)
Prevent files that are matching a pattern from being emitted in a webpack build.
This is achieved with a webpack plugin.
You can easily ignore file by accident - use with care.
## Quick Usage
```sh
npm i --save-dev ignore-emit-webpack-plugin
```
Typescript
```typescript
// webpack.config.js
import IgnoreEmitPlugin from 'ignore-emit-webpack-plugin';
export default {
// ...
plugins: [
new IgnoreEmitPlugin(/\.map$/)
]
};
```
JS
```js
// webpack.config.js
const IgnoreEmitPlugin = require('ignore-emit-webpack-plugin');
module.exports = {
// ...
plugins: [ new IgnoreEmitPlugin(/\.map$/) ]
// ...
};
```
The module is written in Node 8.x flavored es6.
To get the es5 transpiled version use `require('ignore-emit-webpack-plugin/es5')`
## Usage
Signature: `new IgnoreEmitPlugin(patterns, options)`
- **patterns** `{RegExp|string|Array.}` - regex, string or array with mixed regex/strings (deep nesting allowed),
to match against the **OUTPUT** path of assets.
- **options** `{object}` - optional, options object
- options.debug `{boolean}` - prints extra logs
not defining patterns or defining invalid pattern will throw error.
```js
// single regex
new IgnoreEmitPlugin(/\/artifacy.js$/);
// single regex in array
new IgnoreEmitPlugin([ /\/artifacy.js$/ ]);
// mixed array
new IgnoreEmitPlugin([ 'file.woff', /\/artifacy.js$/ ]);
// you can also do this - but you really shouldn't
new IgnoreEmitPlugin([ [ [ [ /\/artifacy.js$/ ] ] ] ]);
// file.js
// dir/file.js
new IgnoreEmitPlugin('file.js'); // both file.js and dir/file.js ignored
new IgnoreEmitPlugin(/\/file\.js/); // only dir/file.js is ignored
new IgnoreEmitPlugin(/^file\.js/); // only file.js is ignored
```
## I want to help!
Contribution would be much appreciated.
Either by creating pull requests of opening issues.