log-in-channel v1.2.0

log-in-channel

No messy console.log's anymore! Log things in specific channels you can mute, unmute and give specific colors.

Install

$ npm install log-in-channel

or

$ yarn add log-in-channel

Usage

Define your own instance of Logger in one file and use it in all other files!

// logger.helper.js
import Logger from 'log-in-channel';

// an object containing the channel ids for easier use while developing

interface IChannelIds {
  [key: string]: string | IChannelIds;
}

const ChannelIds: IChannelIds = {
  DEFAULT: 'default',
  auth: {
    STATE: 'auth/state',
  },
};

// create logger
/*

{
  colorSupportType?: null | 'terminal' | 'chrome', // Define here in which environment you are
  // null --> no colored logs
  // 'terminal' --> colored logs where chalk (npm package) works
  // 'chrome' --> colored logs where css styled logs work
  channelIds: IChannelIds,
  channel: {
    '<id of channel>': {
      // channel config params
      options?: {
        style?: {
          color?: '<hexa color code>', // string
          backgroundColor?: '<hexa color code>', // string
          fontWeight?: '<400 | 700>', // string
        },
      },
    },
  },
}

*/


const CustomLogger = new Logger<typeof ChannelIds>({
  colorSupportType: 'terminal',
  channelIds: ChannelIds,
  channels: {
    'default': {},
    'auth/state': {
      options: {
        style: {
          color: '#009aff',
        },
      },
    },

    ...
 },
});

export default CustomLogger;

// myfile.js
import CustomLogger from '../helpers/logger.helper';

CustomLogger.channel(CustomLogger.channels.auth.STATE).withPath('set').success('logged in :D');

And if you don't want to have logs of one channel, you can mute it and unmute it, when you need it again.

CustomLogger.muteChannel(CustomLogger.channels.auth.STATE); // mute single channel

CustomLogger.unmuteChannel(CustomLogger.channels.auth.STATE); // unmute single channel

CustomLogger.muteAllChannels(); // mute all channels

CustomLogger.unmuteAllChannels(); // unmute all channels

You can also add and remove event listeners to listen for log events.

const listenerId = CustomLogger.addListener((event) => {
  console.log(`Logged in channel with id ${event.channelId}!`);
});

CustomLogger.removeListener(listenerId);

Last but not least you can remove all colors and log all messages as plain text if you want to.

CustomLogger.logWithStyle(false);

// reactivate

CustomLogger.logWithStyle(true);

Example

You can find an example in the example directory.

Run with ts-node example/example.ts or yarn run:example or npm run run:example!

License

This repo is licensed under the MIT License.