![]()
Pikmin - A lightweight, customizable Node.JS logger
[](/LICENSE) [](https://travis-ci.com/PassTheWessel/pikmin) [](https://npmjs.com/package/pikmin)
Pikmin is a fast and highly customizable logger for Node.JS with various custom transports
[`GitHub`](https://github.com/PassTheWessel/pikmin) **|** [`NPM`](https://npmjs.com/package/pikmin)
## Installing
```sh
$ yarn add pikmin # Install w/ Yarn
$ npm i pikmin # Install w/ NPM
```
## Example
```js
// main.js
const Pikmin = require('pikmin');
const pikmin = new Pikmin.instance({
name: 'main',
autogen: true,
format: `${Pikmin.colors.cyan('[%h:%m:%s]')} %l ${Pikmin.colors.green('->')} `,
transports: [
new Pikmin.FileTransport({ file: 'tmp/log.txt' }),
new Pikmin.ConsoleTransport({ process: process, name: 'info' })
]
});
pikmin.addTransport(new Pikmin.ConsoleTransport({ process: process, name: 'error', format: `${Pikmin.colors.red('%l')}`, defaults: {} }));
Pikmin.bind(pikmin, console);
pikmin.info(Symbol.iterator);
pikmin.info({ 'test': 123 });
pikmin.error('This is an error!');
require('./global.js')();
Pikmin.unbind(pikmin);
// global.js
const { loggers, colors } = require('../');
const log = loggers.get('main');
module.exports = () => {
log.info(`Method "${colors.green('info')}" is global`);
console.pikmin.error('Oh no!');
};
```
## Showcase
## Documentation
Documentation can be found at [https://github.com/PassTheWessel/pikmin/wiki](https://github.com/PassTheWessel/pikmin/wiki)