webpack-sane-compiler-reporter

Beautiful reporting for webpack-sane-compiler compilation events.

Installation

$ npm install webpack-sane-compiler-reporter --save-dev

Usage

const startReporting = require('webpack-sane-compiler-reporter');

const { stop, options } = startReporting(compiler, {/* options */});

// Now, just call compiler.run() or compiler.watch() to start a compilation and start outputting reports
// Calling stop() will stop listening to the compiler events
// Furthermore, you have access to the options that were computed by the merge of provided options with the defaults

Available options

Name	Description	Type	Default
stats	Display webpack stats after each compilation	boolean/string (true, false or 'once')	true
write	Function responsible for printing/outputting the generated report messages	function	Prints to stderr
printStart	Function responsible for generating a message when a compilation starts	function
printSuccess	Function responsible for generating a message when a compilation succeeds	function
printFailure	Function responsible for generating a message when a compilation fails	function
printInvalidate	Function responsible for generating a message when invalidate() is called when watching	function
printStats	Function responsible for generating a message representing a WebpackStats instance	function
printError	Function responsible for generating a message of a Error instance	function

Other exports

renderers

For convenience this package also exports the renderers used internally:

const reporter = require('webpack-sane-compiler-reporter');

reporter(compiler, {
    printError: (err) => `${reporter.renderers.renderError(err)}\n`,
});

symbols

You can also access the symbols that precede some messages.

const reporter = require('webpack-sane-compiler-reporter');

reporter(compiler, {
    printStart: () => `${reporter.symbols.start} A iniciar a compilação...\n`,
});

Tests

$ npm test
$ npm test -- --watch during development

License

MIT License