Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/eddywashere/cloggy
A minimal logger object built with debug
https://github.com/eddywashere/cloggy
Last synced: 25 days ago
JSON representation
A minimal logger object built with debug
- Host: GitHub
- URL: https://github.com/eddywashere/cloggy
- Owner: eddywashere
- Created: 2016-06-27T05:56:42.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2016-06-27T05:59:57.000Z (over 8 years ago)
- Last Synced: 2024-08-12T20:32:37.705Z (3 months ago)
- Language: JavaScript
- Size: 1000 Bytes
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# cloggy
A minimal debugging utility to replace console statements with [debug](https://github.com/visionmedia/debug) powered logging. This works well with libraries like [redux-logger](https://github.com/evgenyrodionov/redux-logger#logger-object);
## Getting Started
```sh
npm install cloggy
```
In your code, require cloggy and pass in a namespace for your debug statements.
```js
import cloggy from 'cloggy';
const log = cloggy('app');
log.info('Doing something');
log.error('An error happened');
log.debug('Doing something');
log.log('Doing something');
log.warn('Doing something');
```
Debugging can be enabled with space or comma-delimited names in the following ways:
- ***Browser***: Open the browser console and set the following local storage item
- `localStorage.debug = '*'`
- `localStorage.debug = '*,-not_this'`
- `localStorage.debug = 'app:*,section:*'`
- ***Node***: Set `DEBUG` environment variable
- `DEBUG=* node app.js`
- `DEBUG=*,-not_this node app.js`
- `DEBUG=app:*,section:* node app.js`
For more information about `debug`, [check out the docs](https://github.com/visionmedia/debug#usage).
### Methods
The returned debug object contains the following namespaced log statements.
- `info`
- `debug`
- `log`
- `warn`
- `error`
There's nothing really special about the different methods other than debug assigning unique colors per function.
### Screenshot
Example running in [redux-logger](https://github.com/evgenyrodionov/redux-logger#logger-object) via custom logger object.
