Custom Reporters / Printers

[shellscape]

(You might have noticed that I'm enthusiastic about your project 😄)

While the default output is definitely colorful, distinct, and pleasant to look at, I'd like to request the ability to use a custom reporter / printer for controlling the styles applied to the output. I'd like to use this as a component in a project that follows the "stylish conventions" and a custom reporter would help me to keep the output for whybundled in line with that style.

[d4rkr00t]

Yeah, it definitely makes sense, I'll have a look at adding custom print functions asap.

[d4rkr00t]

I've been thinking about that, and even though it's not hard to add a custom print function, I want to better understand your use case.

I don't think it's a good idea to use commands/{default|by}.js as an Node API for whybundled, because these functions handle lots of cli specific things e.g. progress bar, reading files from fs, killing the process in case something goes wrong, etc... I can extract non-cli specific stuff from commands and provide them as an API, which seems totally reasonable.

But if you don't need the logic inside commands, if default behaviour is enough, you can use analyze and build your own print:

const { analyze } = require('whybundled');
const report = analyze(stats);
customPrint(report);

[shellscape]

Oh we'd totally be using whybundled via the CLI, just through child_process/execa. A --reporter flag is what I was going after (sorry, should have been more specific about that in the original message). Mocha et. al. does pretty much the same. Since webpack-command handles using the webpack API to run builds, the idea that was simply to have the buildchild_process pipe to the whybundled process behind the scenes, removing an additional step for users. With a custom reporter we'd also add a byline so folks knew where the info was being generated from (this project).

Since this was conceived as a CLI, I didn't want to make a request that the API be opened up - I don't think that work is needed.

[d4rkr00t]

Oh, ok :) Cool! It shouldn't be much work to add that. I'll try and put up a PR in couple of days.

[d4rkr00t]

Published as v1.4.0