Added support for multiple streams & optional streams per logger. Fixes #26

[jordrake]

This would allow you to pass a stream as a property when configuring types to use that stream over the default one.

This does add a property to types that in its current state could not be represented by the config in package.json. If you feel this is necessary I can change it that type.stream is stream identifier and then have an api-only option of a map of identifier to implementation.

If you are happy with the current implementation I will crack on with updating the documentation.

Also, love the library in both functionality and ease of contribution!

EDIT: This now also fixes #26 by providing the ability to have an array of streams as either options.stream or type.stream

[klaudiosinani]

Nice idea! I can see how this might be useful, but we can apply it in a way that supports multiple writable streams, in order to also close #26. The user will be able to define an array of valid writable streams under the stream logger attribute, which will override, for only that logger, both the default process.stdout as well as any other user-defined stream used when initializing a new Signale instance e.g.

const options = {
  stream: [stream_1, stream_2], // Overrides the default `process.stdout` with `stream_1` & `stream_2` for all loggers
  types: {
    error: {
     stream: [stream_3, stream_4] // Overrides both the default `process.stdout` and `stream_1` & `stream_2` with `stream_3` & `stream_4` only for the .error() logger
    }
  }
}
const signale = new Signale(options);
signale.error('Foo'); // 'Foo' will appear only on `stream_3` & `stream_4`
signale.success('Bar'); // 'Bar' will appear only on `stream_1` & `stream_2`

A new _formatStream(stream) method can be created on line 87, just above _formatDate(), that will make sure that the user-defined streams are packed into an array:

_formatStream(stream) {
  return Array.isArray(stream) ? stream : [stream];
}

And then we can write on all streams like so:

_log(message, streams = this._stream) {
  this._formatStream(streams).forEach(stream => {
    stream.write(message + '\n');
  });
}

[jordrake]

Thanks for the feedback. I agree it would be an easy win to fix #26 too!

I've done the work requested however I didn't extract the array type consolidation to a function as it's a single line only used in one place and it didn't feel like it fit in the same vein as the other format* functions which were string formatting. Happy to change this if you want though.

[klaudiosinani]

A separate format function would be useful if access to writable streams was required on more than one different parts of the code and also for keeping things as modular as possible, but it is a change easily applied if needed in the future. Also, it would be better if the readme update could go to a separate pull request on its own, so it can be easily merged when ready to release the new version. Everything else looks awesome! Thank you a lot for taking the time to contribute : )

[jordrake]

No problem, I've introduced both the format function and raised the README pr here: #29

[jordrake]

A small thing I thought of was errors when trying to write to a stream, for multiple streams do you want to fail fast on the first or try to write to them all and failed at the end, e.g.:

_log(message, streams = this._stream) {
  let firstError;
  this._formatStream(streams).forEach(stream => {
    try {
      stream.write(message + '\n');
    } catch(e) {
      firstError = firstError || e;
    }
  });

  if(firstError) {
    throw firstError;
  }
}

[klaudiosinani]

Yep, I believe fast failure is better since it is up to the user to provide the valid writable streams and resolve any possible issues at first sight. Just a final tweak here and it is good to be merged. Also, thank you a lot for your readme PR!

[klaudiosinani]

Looks nice!

[klaudiosinani]

This should be omitted, in order to prevent confusion, since default loggers are all expected to write to the default process.stdout stream

[klaudiosinani]

A few tweaks and it is good to go : )

[klaudiosinani]

stream is undefined here, should be: _formatStream(stream)

[jordrake]

Good 👀

[klaudiosinani]

Awesome! Thank you a lot! : )

[brettimus]

Does this still need a blurb in the readme? Or do you prefer to update readme with an official release?

[klaudiosinani]

Yep, PR #29 will be merged just before the release of 1.2.0 : )