# cclog

> A simple but powerful logger module. Support colors, line number, file

Latest version **0.4.1** (published 2015-12-16) · ISC license · 0 weekly downloads

## Install

```sh
npm install cclog
pnpm add cclog
yarn add cclog
bun add cclog
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.4.1 |
| Published | 2015-12-16 |
| First published | 2012-08-09 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 9 |
| Maintainers | guileen |

## Links

- npm: https://www.npmjs.com/package/cclog
- Repository: https://github.com/kissjs/cclog
- Issues: https://github.com/kissjs/cclog/issues
- npm.io page: https://npm.io/package/cclog

## Dependencies (1)

- [callsite](https://npm.io/package/callsite.md) 1.0.0

## Recent versions

- 0.4.1 (latest) — 2015-12-16
- 0.4.0 — 2015-07-19
- 0.3.2 — 2015-05-14
- 0.3.1 — 2014-04-14
- 0.3.0 — 2014-02-25
- 0.2.0 — 2014-02-20
- 0.1.10 — 2014-01-26
- 0.1.9 — 2014-01-24
- 0.1.8 — 2014-01-14
- 0.1.7 — 2014-01-10
- 0.1.6 — 2014-01-10
- 0.1.5 — 2014-01-10
- 0.1.4 — 2013-03-27
- 0.1.3 — 2013-02-28
- 0.1.2 — 2013-02-04
- … 2 more at https://npm.io/package/cclog/versions

## README

# cclog
<a href="https://travis-ci.org/kissjs/cclog"><img src="https://api.travis-ci.org/kissjs/cclog.png"></a>

<a href="https://nodei.co/npm/cclog/"><img src="https://nodei.co/npm/cclog.png?downloads=true&stars=true"></a>

Colorful console log, with line number via v8 [callSite](http://github.com/visionmedia/callsite).

![](http://guileen.github.io/upload/2014/cclog.jpg)

## Features

* colourful style
* fast get line number with callsite
* show date
* replace default console

## Installation

    npm install cclog
    
## Usage

### cclog.useColors
if `true` show colors in log, default `tty.isatty()`
### cclog.setLevel(levelStr)
only show log with the setting level or above.
avariable params: `'debug'`, `'info'`, `'warn'`, `'error'`, `'none'`
### cclog.logger(filename|options)
return a new logger object.
`cclog` is also a logger object;

options.filename the path of log file, default `null`.

options.stdout  the stream use for stdout.

options.stderr  the stream use for stderr.

### cclog(fmt, [...])
### cclog.log(fmt, [...])
### cclog.info(fmt, [...])
*stdout* fmt see [util.format](http://nodejs.org/api/util.html#util_util_format_format)

### cclog.warn(fmt, [...])
### cclog.error(fmt, [...])
*stderr* fmt see [util.format](http://nodejs.org/api/util.html#util_util_format_format)


### cclog.dir(obj, level)
*stdout* inspect obj

### cclog.trace(obj)
*stderr* if obj is `Error` instance then log the stack, else inspect it.

### cclog.intercept([msg], [callback])

```js
db.get('foo', cclog.intercept('callback foo', handle));
```

alias

```js
db.get('foo', function(err, data) {
  if(err) {
    cclog.error('callback foo', err);
  } else {
    cclog.info('callback foo', err, data);
  }
  handle && handle(err, data);
}
```

### cclog.ifError

_deprecated_ use `cclog.intercept()` instead.
*stderr* generate a function to handle error.

```js
fs.mkdir('/foo', function(err) {
  if(err) cclog.error(err);
});
```

use `cclog.ifError` to get a closure, NOTE always use `cclog.`

```js
// WRONG
var ifError = cclog.ifError;
fs.mkdir('/foo', ifError);

// right
fs.mkdir('/foo', cclog.ifError);
```

### cclog.replace()
replace `console` functions with `cclog`, `console.log(msg)` will work like `cclog.log(msg)`

### cclog.restore()
restore original `console` functions, but keep the function that doesn't present in original `console`.

## License 

(The MIT License)

Copyright (c) 2012 Jason Green &lt;guileen@gmail.com&gt;

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
'Software'), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

---
_Source: https://npm.io/package/cclog · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._