https://github.com/paulmillr/loggy

Colorful stdstream dead-simple logger for node.js.
https://github.com/paulmillr/loggy

Last synced: 7 days ago
JSON representation

Colorful stdstream dead-simple logger for node.js.

• Host: GitHub
• URL: https://github.com/paulmillr/loggy
• Owner: paulmillr
• Created: 2013-02-27T11:08:54.000Z (almost 12 years ago)
• Default Branch: master
• Last Pushed: 2023-06-30T21:29:42.000Z (over 1 year ago)
• Last Synced: 2024-05-08T17:02:52.094Z (8 months ago)
• Language: JavaScript
• Size: 45.9 KB
• Stars: 41
• Watchers: 4
• Forks: 7
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# loggy

Colorful stdstream dead-simple logger for node.js.

* Logs stuff to stdout (`log`, `info`, `success`).

* Logs errors & warnings to stderr (`warn`, `error`).

* Adds colors to log types (e.g. `warn`, `info` words will be colored). Uses lightweight [colorette](https://github.com/jorgebucaran/colorette).

* Emits system notifications for errors with [native-notifier](https://github.com/paulmillr/native-notifier).

* Tracks whether any error was logged (useful for changing process exit code).

* No 3rd-party deps (Growl etc.)



![Screen Shot 2013-04-21 at 03 26 41](https://cloud.githubusercontent.com/assets/574696/22355836/d5a57152-e435-11e6-8b22-6aca8b4e79b1.png)

Install with `npm install loggy`.

## Usage

Example:

```javascript

const logger = require('loggy');

// "05:48:30 - log: Hello, loggy" to stdout.

// "info" word is cyan.

logger.info('Hello', 'loggy');

// "05:48:30 - warn: Deprecated" to stderr.

// "warn" word is yellow.

logger.warn('Deprecated');

// Logs "05:48:30 - error: Oops" to stderr.

// "error" word is red.

// Emits system notifications with title "Error" and message "Oops”.

logger.error('Oops');

// Exit with proper code.

process.on('exit', () => {

   process.exit(logger.errorHappened ? 1 : 0);

});

// Disable colors.

logger.colors = false;

// Disable system notifications.

logger.notifications = false;

// Enable notifications for more methods

logger.notifications.levels = ['error', 'warn', 'success'];

// Prepend the notifications title

logger.notificationsTitle = 'My App';

// Dump stacks of Error objects in errors or warnings

logger.dumpStacks = true; // or color of your choice

```

Environment variables:

* `LOGGY_STACKS`: default value for `dumpStacks`. Pass `1` to see the stacks.

* `FORCE_NO_COLOR`: disables color output in `chalk`. Does not affect `logger.colors`.

Methods:

* `logger.error(...args)` - logs messages in red to stderr, creates notification.

* `logger.warn(...args)` - logs messages in yellow to stdout.

* `logger.log(...args)` - logs messages in cyan to stdout.

* `logger.info`, `logger.success` - logs messages in green to stdout.

* `logger.format(level)` - function that does color and date formatting.

Params:

* `logger.colors` - mapping of log levels to colors.

  Can be object, like `{error: 'red', log: 'cyan'}` or `false` (disables colors).

* `logger.errorHappened` - `false`, changes to `true` if any error was logged.

* `logger.notifications` - As Boolean, enables or disables notifications for errors, or

  as Array, list types to trigger notifications, like `['error', 'warn', 'success']`.

* `logger.notificationsTitle` - String, optional, prepends title in notifications.

## License

[MIT](https://github.com/paulmillr/mit) (c) 2016 Paul Miller (http://paulmillr.com)