https://github.com/rollup/log
🌳
https://github.com/rollup/log
Last synced: about 1 month ago
JSON representation
🌳
- Host: GitHub
- URL: https://github.com/rollup/log
- Owner: rollup
- License: mit
- Created: 2018-07-11T00:50:31.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2019-01-01T16:22:35.000Z (over 6 years ago)
- Last Synced: 2024-04-14T02:30:26.885Z (about 1 year ago)
- Language: TypeScript
- Size: 230 KB
- Stars: 3
- Watchers: 2
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
[tests]: https://img.shields.io/circleci/project/github/rollup-cabal/log.svg
[tests-url]: https://circleci.com/gh/rollup-cabal/log
[cover]: https://codecov.io/gh/rollup-cabal/log/branch/master/graph/badge.svg
[cover-url]: https://codecov.io/gh/rollup-cabal/log
[chat]: https://img.shields.io/badge/gitter-rollup%2Frollup-brightgreen.svg
[chat-url]: https://gitter.im/rollup/rollup
[size]: https://packagephobia.now.sh/badge?p=log
[size-url]: https://packagephobia.now.sh/result?p=log
# @rollup-cabal/log
[![tests][tests]][tests-url]
[![cover][cover]][cover-url]
[![chat][chat]][chat-url]
[![size][size]][size-url]
🌳
A logger that provides targeted log levels and display options.
_Note: This module requires Node 8.11.0._
## Install
Using npm:
```console
$ npm install @rollup-cabal/log
```
Using yarn:
```console
$ yarn add @rollup-cabal/log
```
## Usage
```js
import { logger } from '@rollup-cabal/log';
const log = logger()
log.info('batman');
//→ ⓡ batman
```
## API
### logger([options])
Each log [instance](#instance) is unique by default. To persist an instance and
fetch it elsewhere, provide an `id` property on `options`.
#### options
Type: `object`
##### id
Type: `string`
A unique identifier for a log instance.
##### level
Type: `string`
Default: `info`
Values: `trace` `debug` `info` `warn` `error`
The minimum log level to display output for. Output for levels above the set
level will be displayed. Log levels shown in _Values_ above are in order of
lowest to highest.
Setting a level of `'info'` will display output for `log.info`,
`log.warn`, and `log.error`. Setting a level of `'error'` will display output
only for `log.error`.
##### preface
Type: `string`
Text to display before each log message.
```js
import { logger } from '@rollup-cabal/log';
const log = logger({ preface: '⋊ batcave ⋉' });
log.info('batman');
//→ ⓡ ⋊ batcave ⋉ batman
```
##### timestamp
Type: `string`
Default: `boolean`
Set to `true` to display a timestamp before each log message.
```js
import { logger } from '@rollup-cabal/log';
const log = logger({ timestamp: true });
log.info('batman');
//→ [00:00:00] ⓡ batman
```
##### stderr
Type: `Array[string]`
Default: `['info', 'warn', 'error', 'pass', 'fail']`
Defines the levels which output to `stderr` by default. This setting is useful
for directing select loggers to output only specific levels to `stderr` while
allowing other levels to output to `stdout`.
```js
import { logger } from '@rollup-cabal/log';
const log = logger({ stderr: ['warn', 'error'] });
log.info('batman');
// stdout → ⓡ batman
log.warn('riddler');
// stderr → ⓡ riddler
```
### Instance
#### .info(text: `string`)
Displays output to `stderr` prefaced with `â“¡` colored blue. Akin to
`console.log`.
#### .warn(text: `string`)
Displays output to `stderr` prefaced with `â“¡` colored yellow.
#### .error(text: `string`)
Displays output to `stderr` prefaced with `â“¡` colored red.
#### .debug(text: `string`)
Displays output to `stdout` prefaced with `â“¡` colored magenta.
#### .trace(text: `string`)
Displays trace output akin to `console.trace` to `stdout` prefaced with `â“¡`
colored cyan.
#### .pass(text: `string`)
Displays output to `stderr` prefaced with `â“¡` colored green. The output is
persisted regardless of the set `level`.
#### .fail(text: `string`)
Displays output to `stderr` prefaced with `â“¡` colored red. The output is
persisted regardless of the set `level`.
## Meta
[CONTRIBUTING](./.github/CONTRIBUTING)
[LICENSE (MIT)](./LICENSE)