Giter VIP home page Giter VIP logo

rainlog's Introduction

Rainlog Node.js Logger

This versatile logger is an advanced console.log for your applications. It uses the built in util.format to make it easy to output strings and objects.

You can also log to file by setting it up in the configuration.

INSTALL

npm i rainlog

USAGE

By default 2 loggers are included: info and err. You can add extra loggers as you please.

const Rainlog = require('rainlog')
const log = new Rainlog()

// Write to console.log using the 'info' logger
log.info('hello world')

// Write to console.log using the 'error' logger
log.err('hello world')

// Update config for a single logger
log.get.err.set({ file: 'error.txt' })

// Update config for all loggers
log.set({ quiet: true })

// Reset config for a single logger
log.get.info.reset()

// Reset config for all loggers
log.reset()

// Write formatted text
log.info('%s %d %o', 'hello', 2020, { world: 'amazing' })
// Output: hello 2020 { world: 'amazing' }

// Use the $ function to write to file
log.$info('hello')

// Add a logger to the existing log, pass name and config
// The new logger is instantly available as 'log.warn'
log.add('warn', { quiet: true })
log.warn('this logger is on fire')

// Create multiple logs if you want
access = new Rainlog()
access.info('user accessed')
access.err('user not found')

FORMATTING

Here are the formatting options, taken from the Node.js docs:

%s - String.
%d - Number (integer or floating point value) or BigInt.
%i - Integer or BigInt.
%f - Floating point value.
%j - JSON. Replaced with the string '[Circular]' if the argument contains circular references.
%o - Object. A string representation of an object with generic JavaScript object formatting. Similar to util.inspect() with options { showHidden: true, showProxy: true }. This will show the full object including non-enumerable properties and proxies.
%O - Object. A string representation of an object with generic JavaScript object formatting. Similar to util.inspect() without options. This will show the full object not including non-enumerable properties and proxies.
%% - single percent sign ('%'). This does not consume an argument.

CONFIGURATION

Use the 'set' function to configure your logger. Files are not written to by default.

// The default configuration looks like this for all loggers
{
  // When quiet is true there will be no output to console
  quiet: process.env.NODE_ENV === 'production',

  // Set the file option to a file name to also write to file
  file: false,

  // Set colors and modifers, see the 'chalk' module for options
  style: 'green.bold.underline'
}

// Create the Rainlog instance
const log = new Rainlog()

// Optionally pass the config to the constructor
const log = new Rainlog({ quiet: true })

// Use the set function to configure your logger
log.get.info.set({ file: 'info.txt' })
log.get.err.set({ file: 'error.txt' })

LICENSE

MIT Licensed. Enjoy!

rainlog's People

Contributors

fugroup avatar eldoy avatar

Stargazers

 avatar

rainlog's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.