Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aleclarson/lodge
Isomorphic console w/ inspection, colors, namespaces, and configuration
https://github.com/aleclarson/lodge
console logger logging minimal
Last synced: 19 days ago
JSON representation
Isomorphic console w/ inspection, colors, namespaces, and configuration
- Host: GitHub
- URL: https://github.com/aleclarson/lodge
- Owner: aleclarson
- License: mit
- Created: 2018-06-20T18:21:53.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2021-02-10T03:24:14.000Z (over 3 years ago)
- Last Synced: 2024-10-13T04:05:54.842Z (24 days ago)
- Topics: console, logger, logging, minimal
- Language: CoffeeScript
- Homepage:
- Size: 45.9 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# lodge
[](https://www.npmjs.com/package/lodge)
[](https://bundlephobia.com/result?p=lodge)
[](https://packagephobia.now.sh/result?p=lodge)
[](https://paypal.me/alecdotbiz)
```js
const log = require('lodge');
// simplest case
log('hello world');
// multiple arguments
log('hello', 'world');
// non-strings are pretty-printed
log('object:', { hello: 'world' });
// first argument can be a format string
log('string: %s, object: %O', 100, { hello: 'world' });
// join the given arguments into a formatted string
log.stylize('string: %s, object: %O', 100, { hello: 'world' });
// ansi colors included
log(log.red('CODE RED'));
// warnings
log.warn('be careful');
// print to stderr
log.error('oh crap');
// print a strack trace
log.trace();
// clear the console/terminal
log.clear();
// namespaces
const log2 = log.debug('foo');
// must set DEBUG=1 or DEBUG=foo to see this
log2('something useful in debugging');
// DEBUG=1 is not required to see warnings/errors
log2.warn('foo is deprecated');
// prefixes
log2.prefix('[foo]');
log2.prefix(() => `[${new Date().toISOString()}]`);
```
The built-in `console` functions are used when the global `window` variable exists. Otherwise, functions with similar behavior are used with the `process.stdout` or `process.stderr` streams.
You may override `log.cleanStack` to customize the output of the `trace` method.
### Environment variables
Use `QUIET=1` to disable all messages. The `--quiet` CLI flag also works.
The `DEBUG` environment variable is flexible. `DEBUG=1` enables all debug logs. The asterisk (`*`) allows for globbing. For example, `a*` matches both `abc` and `acb` but not `cba`. The comma (`,`) lets you specify multiple globs. The `--debug` CLI flag is identical to `DEBUG=1`.
Use `NO_COLOR=1` to disable ANSI colors. The `--no-color` CLI flag also works.
Use `NO_WARNINGS=1` to disable warning messages. The `--no-warnings` CLI flag also works.
Use `TRACE_WARNINGS=1` to attach a stack trace to each warning.
For browser environments, you can set these properties on the `window` object before importing this library.
### Colors
The following ANSI colors are available: (256 color spectrum)
- red
- blue
- green
- yellow
- cyan
- pink
- white
- silver
- gray
- coal
- black
The non-grayscale colors all have light variants available as `lred`, `lblue`, `lgreen`, etc.
### Prefixes
You can set the `prefix` method of the main logger (or a namespace) if you want to prepend a string to every message.
```js
const foo = log.debug('foo');
foo.prefix = () => `[${new Date().toISOString()}] foo:`
foo('test') // => '[2018-06-28T20:03:48.892Z] foo: test'
```
Loggers created by the `create` or `debug` method will inherit the prefix of their ancestors.
Loggers created with the `debug` method have a default prefix of their identifier with a dark gray color.