{"_id":"@soda/friendly-errors-webpack-plugin","_rev":"1569119","name":"@soda/friendly-errors-webpack-plugin","description":"Recognizes certain classes of webpack errors and cleans, aggregates and prioritizes them to provide a better Developer Experience","dist-tags":{"latest":"1.8.1"},"maintainers":[{"name":"fangbinwei","email":"fangbinwei@yeah.net"},{"name":"soda","email":"imyanglan@163.com"}],"time":{"modified":"2021-11-15T08:41:02.000Z","created":"2019-01-29T09:46:02.353Z","1.8.1":"2021-11-15T08:38:05.955Z","1.8.0":"2020-12-10T14:55:12.842Z","1.7.1":"2019-01-29T09:46:02.353Z"},"users":{},"author":{"name":"Geoffroy Warin"},"repository":{"type":"git","url":"git+https://github.com/sodatea/friendly-errors-webpack-plugin.git"},"versions":{"1.8.1":{"name":"@soda/friendly-errors-webpack-plugin","version":"1.8.1","description":"Recognizes certain classes of webpack errors and cleans, aggregates and prioritizes them to provide a better Developer Experience","main":"index.js","engines":{"node":">=8.0.0"},"scripts":{"test":"eslint --ignore-pattern \"test/**\" . && jest --testEnvironment node"},"keywords":["friendly","errors","webpack","plugin"],"author":{"name":"Geoffroy Warin"},"repository":{"type":"git","url":"git+https://github.com/sodatea/friendly-errors-webpack-plugin.git"},"bugs":{"url":"https://github.com/sodatea/friendly-errors-webpack-plugin/issues"},"license":"MIT","jest":{"testEnvironment":"node","transformIgnorePatterns":["node_modules","src","index.js"]},"peerDependencies":{"webpack":"^4.0.0 || ^5.0.0"},"devDependencies":{"@babel/core":"^7.5.4","@babel/plugin-transform-async-to-generator":"^7.5.0","autoprefixer":"^9.6.0","babel-core":"6.26.3","babel-eslint":"^10.0.1","babel-preset-react":"^6.23.0","babel-loader-7":"npm:babel-loader@7.1.5","babel-loader":"^8.0.6","css-loader":"^2.1.1","eslint":"^5.16.0","eslint-7":"npm:eslint@^7.14.0","eslint-loader":"^2.1.2","eslint-plugin-node":"^9.0.1","eslint-webpack-plugin":"^2.4.0","expect":"^24.8.0","jest":"^24.8.0","memory-fs":"^0.4.1","mini-css-extract-plugin":"^0.6.0","node-sass":"^4.12.0","postcss-loader":"^3.0.0","sass":"^1.20.1","sass-loader":"^7.1.0","style-loader":"^0.23.1","webpack":"^4.31.0"},"dependencies":{"chalk":"^3.0.0","error-stack-parser":"^2.0.6","string-width":"^4.2.3","strip-ansi":"^6.0.1"},"gitHead":"598bedf3baca837fb4b8cead39ba4f8c6659e3ae","homepage":"https://github.com/sodatea/friendly-errors-webpack-plugin#readme","_id":"@soda/friendly-errors-webpack-plugin@1.8.1","_nodeVersion":"12.22.7","_npmVersion":"6.14.15","dist":{"shasum":"4d4fbb1108993aaa362116247c3d18188a2c6c85","size":9394,"noattachment":false,"key":"/@soda/friendly-errors-webpack-plugin/-/@soda/friendly-errors-webpack-plugin-1.8.1.tgz","tarball":"http://registry.cnpm.dingdandao.com/@soda/friendly-errors-webpack-plugin/download/@soda/friendly-errors-webpack-plugin-1.8.1.tgz"},"_npmUser":{"name":"soda","email":"haoqunjiang+npm@gmail.com"},"directories":{},"maintainers":[{"name":"fangbinwei","email":"fangbinwei@yeah.net"},{"name":"soda","email":"imyanglan@163.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/friendly-errors-webpack-plugin_1.8.1_1636965485810_0.06079418863895292"},"_hasShrinkwrap":false,"publish_time":1636965485955,"_cnpm_publish_time":1636965485955},"1.8.0":{"name":"@soda/friendly-errors-webpack-plugin","version":"1.8.0","description":"Recognizes certain classes of webpack errors and cleans, aggregates and prioritizes them to provide a better Developer Experience","main":"index.js","engines":{"node":">=8.0.0"},"scripts":{"test":"eslint --ignore-pattern \"test/**\" . && jest --testEnvironment node"},"keywords":["friendly","errors","webpack","plugin"],"author":{"name":"Geoffroy Warin"},"repository":{"type":"git","url":"git+https://github.com/sodatea/friendly-errors-webpack-plugin.git"},"bugs":{"url":"https://github.com/sodatea/friendly-errors-webpack-plugin/issues"},"license":"MIT","jest":{"testEnvironment":"node","transformIgnorePatterns":["node_modules","src","index.js"]},"peerDependencies":{"webpack":"^4.0.0 || ^5.0.0"},"devDependencies":{"@babel/core":"^7.5.4","@babel/plugin-transform-async-to-generator":"^7.5.0","autoprefixer":"^9.6.0","babel-core":"6.26.3","babel-eslint":"^10.0.1","babel-preset-react":"^6.23.0","babel-loader-7":"npm:babel-loader@7.1.5","babel-loader":"^8.0.6","css-loader":"^2.1.1","eslint":"^5.16.0","eslint-7":"npm:eslint@^7.14.0","eslint-loader":"^2.1.2","eslint-plugin-node":"^9.0.1","eslint-webpack-plugin":"^2.4.0","expect":"^24.8.0","jest":"^24.8.0","memory-fs":"^0.4.1","mini-css-extract-plugin":"^0.6.0","node-sass":"^4.12.0","postcss-loader":"^3.0.0","sass":"^1.20.1","sass-loader":"^7.1.0","style-loader":"^0.23.1","webpack":"^4.31.0"},"dependencies":{"chalk":"^2.4.2","error-stack-parser":"^2.0.2","string-width":"^2.0.0","strip-ansi":"^5"},"gitHead":"448000b004e6e0b0da07421d52685f1cc75329c3","homepage":"https://github.com/sodatea/friendly-errors-webpack-plugin#readme","_id":"@soda/friendly-errors-webpack-plugin@1.8.0","_nodeVersion":"12.19.0","_npmVersion":"6.14.8","dist":{"shasum":"84751d82a93019d5c92c0cf0e45ac59087cd2240","size":9391,"noattachment":false,"key":"/@soda/friendly-errors-webpack-plugin/-/@soda/friendly-errors-webpack-plugin-1.8.0.tgz","tarball":"http://registry.cnpm.dingdandao.com/@soda/friendly-errors-webpack-plugin/download/@soda/friendly-errors-webpack-plugin-1.8.0.tgz"},"_npmUser":{"name":"soda","email":"haoqunjiang+npm@gmail.com"},"directories":{},"maintainers":[{"name":"fangbinwei","email":"fangbinwei@yeah.net"},{"name":"soda","email":"imyanglan@163.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/friendly-errors-webpack-plugin_1.8.0_1607612112702_0.49737671872466516"},"_hasShrinkwrap":false,"publish_time":1607612112842,"_cnpm_publish_time":1607612112842},"1.7.1":{"name":"@soda/friendly-errors-webpack-plugin","version":"1.7.1","description":"Recognizes certain classes of webpack errors and cleans, aggregates and prioritizes them to provide a better Developer Experience","main":"index.js","scripts":{"test":"eslint --ignore-pattern test/* && jest"},"keywords":["friendly","errors","webpack","plugin"],"author":{"name":"Geoffroy Warin"},"repository":{"type":"git","url":"git+https://github.com/sodatea/friendly-errors-webpack-plugin.git"},"bugs":{"url":"https://github.com/sodatea/friendly-errors-webpack-plugin/issues"},"license":"MIT","peerDependencies":{"webpack":"^2.0.0 || ^3.0.0 || ^4.0.0"},"devDependencies":{"babel-core":"^6.23.1","babel-eslint":"^7.1.1","babel-loader":"^6.3.0","babel-plugin-transform-async-to-generator":"^6.22.0","babel-preset-react":"^6.23.0","eslint":"^3.16.1","eslint-loader":"^1.6.1","expect":"^1.20.2","jest":"^18.1.0","memory-fs":"^0.4.1","webpack":"^2.2.1"},"dependencies":{"chalk":"^1.1.3","error-stack-parser":"^2.0.0","string-width":"^2.0.0"},"gitHead":"da05e1ca5759d3d45a06c5ba494b5052e2156c4f","homepage":"https://github.com/sodatea/friendly-errors-webpack-plugin#readme","_id":"@soda/friendly-errors-webpack-plugin@1.7.1","_nodeVersion":"10.15.0","_npmVersion":"6.7.0","dist":{"shasum":"706f64bcb4a8b9642b48ae3ace444c70334d615d","size":8901,"noattachment":false,"key":"/@soda/friendly-errors-webpack-plugin/-/@soda/friendly-errors-webpack-plugin-1.7.1.tgz","tarball":"http://registry.cnpm.dingdandao.com/@soda/friendly-errors-webpack-plugin/download/@soda/friendly-errors-webpack-plugin-1.7.1.tgz"},"maintainers":[{"name":"fangbinwei","email":"fangbinwei@yeah.net"},{"name":"soda","email":"imyanglan@163.com"}],"_npmUser":{"name":"soda","email":"haoqunjiang+npm@gmail.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/friendly-errors-webpack-plugin_1.7.1_1548755162185_0.22009127378561022"},"_hasShrinkwrap":false,"publish_time":1548755162353,"_cnpm_publish_time":1548755162353}},"readme":"# Friendly-errors-webpack-plugin\n\n[![npm](https://img.shields.io/npm/v/@soda/friendly-errors-webpack-plugin.svg)](https://www.npmjs.com/package/@soda/friendly-errors-webpack-plugin)\n[![Build Status](https://travis-ci.org/sodatea/friendly-errors-webpack-plugin.svg?branch=master)](https://travis-ci.org/sodatea/friendly-errors-webpack-plugin)\n[![Build status](https://ci.appveyor.com/api/projects/status/bbrt7hmp6lav3erh/branch/master?svg=true)](https://ci.appveyor.com/project/sodatea/friendly-errors-webpack-plugin/branch/master)\n\nFriendly-errors-webpack-plugin recognizes certain classes of webpack\nerrors and cleans, aggregates and prioritizes them to provide a better\nDeveloper Experience.\n\nIt is easy to add types of errors so if you would like to see more\nerrors get handled, please open a [PR](https://help.github.com/articles/creating-a-pull-request/)!\n\n## Getting started\n\n### Installation\n\n```bash\nnpm install @soda/friendly-errors-webpack-plugin --save-dev\n```\n\n### Basic usage\n\nSimply add `FriendlyErrorsWebpackPlugin` to the plugin section in your Webpack config.\n\n```javascript\nvar FriendlyErrorsWebpackPlugin = require('@soda/friendly-errors-webpack-plugin');\n\nvar webpackConfig = {\n  // ...\n  plugins: [\n    new FriendlyErrorsWebpackPlugin(),\n  ],\n  // ...\n}\n```\n\n### Turn off errors\n\nYou need to turn off all error logging by setting your webpack config quiet option to true.\n\n```javascript\napp.use(require('webpack-dev-middleware')(compiler, {\n  // ...\n  logLevel: 'silent',\n  // ...\n}));\n```\n\nIf you use the webpack-dev-server, there is a setting in webpack's ```devServer``` options:\n\n```javascript\n// webpack config root\n{\n  // ...\n  devServer: {\n    // ...\n    quiet: true,\n    // ...\n  },\n  // ...\n}\n```\n\nIf 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:\n\n```javascript\napp.use(require('webpack-hot-middleware')(compiler, {\n  log: false\n}));\n```\n\n_Thanks to [webpack-dashboard](https://github.com/FormidableLabs/webpack-dashboard) for this piece of info._\n\n## Demo\n\n### Build success\n\n![success](http://i.imgur.com/MkUEhYz.gif)\n\n### eslint-loader errors\n\n![lint](http://i.imgur.com/xYRkldr.gif)\n\n### babel-loader syntax errors\n\n![babel](http://i.imgur.com/W59z8WF.gif)\n\n### Module not found\n\n![babel](http://i.imgur.com/OivW4As.gif)\n\n## Options\n\nYou can pass options to the plugin:\n\n```js\nnew FriendlyErrorsPlugin({\n  compilationSuccessInfo: {\n    messages: ['You application is running here http://localhost:3000'],\n    notes: ['Some additional notes to be displayed upon successful compilation']\n  },\n  onErrors: function (severity, errors) {\n    // You can listen to errors transformed and prioritized by the plugin\n    // severity can be 'error' or 'warning'\n  },\n  // should the console be cleared between each compilation?\n  // default is true\n  clearConsole: true,\n\n  // add formatters and transformers (see below)\n  additionalFormatters: [],\n  additionalTransformers: []\n})\n```\n\n## Adding desktop notifications\n\nThe plugin has no native support for desktop notifications but it is easy\nto add them thanks to [node-notifier](https://www.npmjs.com/package/node-notifier) for instance.\n\n```js\nvar FriendlyErrorsPlugin = require('friendly-errors-webpack-plugin');\nvar notifier = require('node-notifier');\nvar ICON = path.join(__dirname, 'icon.png');\n\nnew FriendlyErrorsPlugin({\n    onErrors: (severity, errors) => {\n      if (severity !== 'error') {\n        return;\n      }\n      const error = errors[0];\n      notifier.notify({\n        title: \"Webpack error\",\n        message: severity + ': ' + error.name,\n        subtitle: error.file || '',\n        icon: ICON\n      });\n    }\n  })\n```\n\n## API\n\n### Transformers and formatters\n\nWebpack's errors processing, is done in four phases:\n\n1. Extract relevant info from webpack errors. This is done by the plugin [here](https://github.com/sodatea/friendly-errors-webpack-plugin/blob/master/src/core/extractWebpackError.js)\n2. Apply transformers to all errors to identify and annotate well know errors and give them a priority\n3. Get only top priority error or top priority warnings if no errors are thrown\n4. Apply formatters to all annotated errors\n\nYou can add transformers and formatters. Please see [transformErrors](https://github.com/sodatea/friendly-errors-webpack-plugin/blob/master/src/core/transformErrors.js),\nand [formatErrors](https://github.com/sodatea/friendly-errors-webpack-plugin/blob/master/src/core/formatErrors.js)\nin the source code and take a look a the [default transformers](https://github.com/sodatea/friendly-errors-webpack-plugin/tree/master/src/transformers)\nand the [default formatters](https://github.com/sodatea/friendly-errors-webpack-plugin/tree/master/src/formatters).\n\n## TODO\n\n- [x] Make it compatible with node 4\n\n","_attachments":{},"homepage":"https://github.com/sodatea/friendly-errors-webpack-plugin#readme","bugs":{"url":"https://github.com/sodatea/friendly-errors-webpack-plugin/issues"},"license":"MIT"}