Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/taehwanno/warnings-to-errors-webpack-plugin
a webpack plugin that can recognize every warning as errors.
https://github.com/taehwanno/warnings-to-errors-webpack-plugin
webpack webpack-plugin
Last synced: 2 months ago
JSON representation
a webpack plugin that can recognize every warning as errors.
- Host: GitHub
- URL: https://github.com/taehwanno/warnings-to-errors-webpack-plugin
- Owner: taehwanno
- License: mit
- Created: 2018-02-20T16:30:27.000Z (almost 7 years ago)
- Default Branch: main
- Last Pushed: 2023-03-04T03:59:42.000Z (almost 2 years ago)
- Last Synced: 2024-10-04T13:40:06.311Z (3 months ago)
- Topics: webpack, webpack-plugin
- Language: JavaScript
- Homepage: https://npm.im/warnings-to-errors-webpack-plugin
- Size: 636 KB
- Stars: 17
- Watchers: 3
- Forks: 6
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Warnings To Errors Webpack Plugin [](https://circleci.com/gh/taehwanno/warnings-to-errors-webpack-plugin/tree/master)
**Table of contents**
- [Motivation](#motivation)
- [Installation](#installation)
- [Usage](#usage)
- [License](#license)
## Motivation
Even if the build result with webpack has some warnings, the build can succeed with no error exit codes. This can be trouble if some developer not carefully sees the result of CI service. By changing all warnings to errors, webpack can recognize every warning as an error.
## Installation
```bash
$ npm i -D warnings-to-errors-webpack-plugin
# or
$ yarn add -D warnings-to-errors-webpack-plugin
```
## Usage
- **default**
```js
const WarningsToErrorsPlugin = require('warnings-to-errors-webpack-plugin');
module.exports = {
// ...
plugins: [
new WarningsToErrorsPlugin(),
],
};
```
- **with [`warningsFilter`](https://webpack.js.org/configuration/stats/#statswarningsfilter) and [`ignoreWarnings`](https://webpack.js.org/configuration/other-options/#ignorewarnings)**
This plugin ignores warnings that are matched by `warningsFilter` or `ignoreWarnings` without recognizing them as errors.
```js
// webpack v5
{
plugins: [
new WarningsToErrorsPlugin(),
],
ignoreWarnings: [
{
message: /compilation warning/,
},
],
}
```
If you use `ignoreWarnings` and `warningsFilter` options at the same time in webpack v5, the plugin will ignore all matched warnings in both. but recommend using `ignoreWarnings` only.
```js
// webpack v5
{
plugins: [
new WarningsToErrorsPlugin(),
],
ignoreWarnings: [
{
message: /compilation warning 1/,
},
],
stats: {
warningsFilter: [
/compilation warning 2/,
],
},
}
```
```js
// webpack v2, v3 and v4
{
plugins: [
new WarningsToErrorsPlugin(),
],
stats: {
warningsFilter: [
/compilation warning/,
],
},
}
```
- **with [`NoEmitOnErrorsPlugin`](https://webpack.js.org/plugins/no-emit-on-errors-plugin/)**
Skip the emitting phase whenever there are warnings while compiling. this ensures that no assets are emitted that include warnings.
```js
// webpack >= v4
{
optimization: {
noEmitOnErrors: true,
},
plugins: [
new WarningsToErrorsPlugin();
],
};
```
```js
// webpack v2 and v3
{
plugins: [
new WarningsToErrorsPlugin(),
new NoEmitOnErrorsPlugin(),
],
};
```
## License
MIT © [Taehwan Noh](https://github.com/taehwanno)