blob: 484e939e4fc64b2d210922cb0fede72c44053771 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
|
<p align="center">
<a href="http://gulpjs.com">
<img height="257" width="114" src="https://raw.githubusercontent.com/gulpjs/artwork/master/gulp-2x.png">
</a>
</p>
# gulplog
[![NPM version][npm-image]][npm-url] [![Downloads][downloads-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Gitter chat][gitter-image]][gitter-url]
Logger for gulp and gulp plugins
## Usage
```js
var logger = require('gulplog');
// logs strings
logger.debug('The MOST verbose!');
logger.info('Some important info');
logger.warn('All the warnings to you');
logger.error('OH NO! SOMETHING HAPPENED!');
// supports util.format!
logger.info('%s style!', 'printf');
// log anything
logger.debug({ my: 'obj' });
logger.info([1, 2, 3]);
```
## API
Logging (and level of logging) is controlled by [`gulp-cli`][gulp-cli-url]
#### logger.debug(msg)
Highest log level. Typically used for debugging purposes.
If the first argument is a string, all arguments are passed to node's
[`util.format()`][util-format-url] before being emitted.
#### logger.info(msg)
Standard log level. Typically used for user information.
If the first argument is a string, all arguments are passed to node's
[`util.format()`][util-format-url] before being emitted.
#### logger.warn(msg)
Warning log level. Typically used for warnings.
If the first argument is a string, all arguments are passed to node's
[`util.format()`][util-format-url] before being emitted.
#### logger.error(msg)
Error log level. Typically used when things went horribly wrong.
If the first argument is a string, all arguments are passed to node's
[`util.format()`][util-format-url] before being emitted.
## License
MIT
[downloads-image]: http://img.shields.io/npm/dm/gulplog.svg
[npm-url]: https://npmjs.org/package/gulplog
[npm-image]: http://img.shields.io/npm/v/gulplog.svg
[travis-url]: https://travis-ci.org/gulpjs/gulplog
[travis-image]: http://img.shields.io/travis/gulpjs/gulplog.svg
[gitter-url]: https://gitter.im/gulpjs/gulp
[gitter-image]: https://badges.gitter.im/gulpjs/gulp.png
[gulp-cli-url]: https://github.com/gulpjs/gulp-cli
[util-format-url]: https://nodejs.org/docs/latest/api/util.html#util_util_format_format
|
