Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ali322/tidy-stats-webpack-plugin
output more tidy and clearness webpack stats
https://github.com/ali322/tidy-stats-webpack-plugin
Last synced: 17 days ago
JSON representation
output more tidy and clearness webpack stats
- Host: GitHub
- URL: https://github.com/ali322/tidy-stats-webpack-plugin
- Owner: ali322
- Created: 2018-03-28T01:48:32.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-03-01T19:01:35.000Z (over 1 year ago)
- Last Synced: 2024-10-11T09:14:41.911Z (about 1 month ago)
- Language: JavaScript
- Size: 199 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Tidy-stats-webpack-plugin [](https://travis-ci.org/ali322/tidy-stats-webpack-plugin) [](https://badge.fury.io/js/tidy-stats-webpack-plugin)
===
[](https://nodei.co/npm/tidy-stats-webpack-plugin/)
Tidy-stats-webpack-plugin output more tidy and clearness
stats, provide a better
Developer Experience.
## Getting started
### Installation
```bash
npm install tidy-stats-webpack-plugin --save-dev
```
### Basic usage
Simply add `TidyStatsWebpackPlugin` to the plugin section in your Webpack config.
```javascript
var TidyStatsWebpackPlugin = require('tidy-stats-webpack-plugin');
var webpackConfig = {
// ...
plugins: [
new TidyStatsWebpackPlugin({
errorsOnly: true
}),
],
// ...
}
```
### Turn off errors
You need to turn off all error logging by setting your webpack config quiet option to true.
```javascript
app.use(require('webpack-dev-middleware')(compiler, {
quiet: true,
publicPath: config.output.publicPath,
}));
```
If you use the webpack-dev-server, there is a setting in webpack's ```devServer``` options:
```javascript
// webpack config root
{
// ...
devServer: {
// ...
quiet: true,
// ...
},
// ...
}
```
If you use webpack-hot-middleware, that is done by setting the log option to a no-op. You can do something sort of like this, depending upon your setup:
```javascript
app.use(require('webpack-hot-middleware')(compiler, {
log: () => {}
}));
```
## Options
You can pass options to the plugin:
```js
new TidyStatsPlugin({
onErrors: function (errors) {
// called when errors occured
},
onWarnings: function(warnings) {
// called when warnings occured
},
// write all stats into file
writeToFile: 'path/to/stats.json',
// should show errors only or not
errorsOnly: true,
// dont show assets
ignoreAsset: false,
// should show finish time and duaration
time: true
// should the console be cleared between each compilation?
// default is true
clearConsole: true
})
```
## Adding desktop notifications
The plugin has no native support for desktop notifications but it is easy
to add them thanks to [node-notifier](https://www.npmjs.com/package/node-notifier) for instance.
```js
var TidyStatsPlugin = require('tidy-stats-webpack-plugin');
var notifier = require('node-notifier');
var ICON = path.join(__dirname, 'icon.png');
new TidyStatsPlugin({
onErrors: (,errors) => {
const error = errors[0];
notifier.notify({
title: "Webpack error",
message: error.name,
subtitle: error.file || '',
icon: ICON
});
}
})
]
```
## License
[MIT License](http://en.wikipedia.org/wiki/MIT_License)