Security News
Combatting Alert Fatigue by Prioritizing Malicious Intent
In 2023, data breaches surged 78% from zero-day and supply chain attacks, but developers are still buried under alerts that are unable to prevent these threats.
@nuxt/friendly-errors-webpack-plugin
Advanced tools
Recognizes certain classes of webpack errors and cleans, aggregates and prioritizes them to provide a better Developer Experience
Friendly-errors-webpack-plugin recognizes certain classes of webpack errors and cleans, aggregates and prioritizes them to provide a better Developer Experience.
It is easy to add types of errors so if you would like to see more errors get handled, please open a PR!
npm install @nuxt/friendly-errors-webpack-plugin --save-dev
Simply add FriendlyErrorsWebpackPlugin
to the plugin section in your Webpack config.
var FriendlyErrorsWebpackPlugin = require('@nuxt/friendly-errors-webpack-plugin');
var webpackConfig = {
// ...
plugins: [
new FriendlyErrorsWebpackPlugin(),
],
// ...
}
You need to turn off all error logging by setting your webpack config quiet option to true.
app.use(require('webpack-dev-middleware')(compiler, {
// ...
logLevel: 'SILENT',
// ...
}));
If you use the webpack-dev-server, there is a setting in webpack's devServer
options:
// webpack config root
{
// ...
devServer: {
// ...
quiet: true,
// ...
},
// ...
}
If you use webpack-hot-middleware, that is done by setting the log option to false
. You can do something sort of like this, depending upon your setup:
app.use(require('webpack-hot-middleware')(compiler, {
log: false
}));
Thanks to webpack-dashboard for this piece of info.
You can pass options to the plugin:
new FriendlyErrorsPlugin({
compilationSuccessInfo: {
messages: ['You application is running here http://localhost:3000'],
notes: ['Some additional notes to be displayed upon successful compilation']
},
onErrors: function (severity, errors) {
// You can listen to errors transformed and prioritized by the plugin
// severity can be 'error' or 'warn'
},
// should the console be cleared between each compilation?
// default is true
clearConsole: true,
// INFO: all logs
// WARNING: warnings and errors
// ERROR: only errors
// SILENT: no log
logLevel: true,
// base: default
// consola: consola adapter
// can also be npm package name or reporter object
reporter: 'consola'
// add formatters and transformers (see below)
additionalFormatters: [],
additionalTransformers: []
})
The plugin has no native support for desktop notifications but it is easy to add them thanks to node-notifier for instance.
var NotifierPlugin = require('@nuxt/friendly-errors-webpack-plugin');
var notifier = require('node-notifier');
var ICON = path.join(__dirname, 'icon.png');
new NotifierPlugin({
onErrors: (severity, errors) => {
if (severity !== 'error') {
return;
}
const error = errors[0];
notifier.notify({
title: "Webpack error",
message: severity + ': ' + error.name,
subtitle: error.file || '',
icon: ICON
});
}
})
]
Webpack's errors processing, is done in four phases:
You can add transformers and formatters. Please see transformErrors, and formatErrors in the source code and take a look a the default transformers and the default formatters.
Reporter is a class for generating output of errors messages, structure is:
success
, info
, note
, warn
, error
.clearConsole
for clearing the terminal console.You can take a look at source code as example base reporter
FAQs
Recognizes certain classes of webpack errors and cleans, aggregates and prioritizes them to provide a better Developer Experience
The npm package @nuxt/friendly-errors-webpack-plugin receives a total of 263,562 weekly downloads. As such, @nuxt/friendly-errors-webpack-plugin popularity was classified as popular.
We found that @nuxt/friendly-errors-webpack-plugin demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 7 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
In 2023, data breaches surged 78% from zero-day and supply chain attacks, but developers are still buried under alerts that are unable to prevent these threats.
Security News
Solo open source maintainers face burnout and security challenges, with 60% unpaid and 60% considering quitting.
Security News
License exceptions modify the terms of open source licenses, impacting how software can be used, modified, and distributed. Developers should be aware of the legal implications of these exceptions.