https://github.com/kevlened/debug-webpack-plugin
Debug webpack builds and plugins
https://github.com/kevlened/debug-webpack-plugin
Last synced: 3 months ago
JSON representation
Debug webpack builds and plugins
- Host: GitHub
- URL: https://github.com/kevlened/debug-webpack-plugin
- Owner: kevlened
- License: mit
- Created: 2016-06-18T20:05:33.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2017-12-29T19:19:07.000Z (almost 8 years ago)
- Last Synced: 2024-10-30T16:20:42.634Z (11 months ago)
- Language: JavaScript
- Size: 4.88 KB
- Stars: 9
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## Debug Webpack Plugin
This is a [webpack](http://webpack.github.io/) plugin that makes it easier to debug webpack builds or plugins. It's built on top of [debug](https://github.com/visionmedia/debug).
### Getting started
Install the plugin:
```
npm install --save-dev debug-webpack-plugin
```
### Example as a plugin
This plugin can be included to make it easier to debug your webpack builds (and provide some insight into how webpack works). As a convenience, all events that webpack supports for plugins are already included in the plugin.
```
var DebugWebpackPlugin = require('debug-webpack-plugin');
var path = require('path');
module.exports = {
context: path.join(__dirname, 'app'),
plugins: [
new DebugWebpackPlugin({
// Defaults to ['webpack:*'] which can be VERY noisy, so try to be specific
scope: [
'webpack:compiler:*', // include compiler logs
'webpack:plugin:ExamplePlugin' // include a specific plugin's logs
],
// Inspect the arguments passed to an event
// These are triggered on emits
listeners: {
'webpack:compiler:run': function(compiler) {
// Read some data out of the compiler
}
},
// Defaults to the compiler's setting
debug: true
})
],
// This compiler setting changes the debug settings of loaders
// and is respected by the DebugWebpackPlugin
debug: true
};
```
### Example in a plugin
When you're building a plugin and want to make it easier to debug, you can do the following:
```
var Debugger = require('debug-webpack-plugin').Debugger;
module.exports = {
apply: function(compiler) {
// Create your namespaced debugger
var dbg = Debugger(compiler).create('webpack:plugin:ExamplePlugin');
compiler.plugin('run', function(comp, cb) {
// Log something with the namespaced debugger
dbg.log('The plugin is logging something');
// Emit something that can be listened to
dbg.emit({something: 'The plugin is emitting something'});
cb();
});
}
};
```