https://github.com/reactual/c
a node.js console.log prettifier :art:
https://github.com/reactual/c
Last synced: 10 months ago
JSON representation
a node.js console.log prettifier :art:
- Host: GitHub
- URL: https://github.com/reactual/c
- Owner: reactual
- License: mit
- Created: 2017-12-16T06:00:34.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2022-12-07T00:34:32.000Z (about 3 years ago)
- Last Synced: 2025-02-25T05:17:00.430Z (10 months ago)
- Language: JavaScript
- Size: 283 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
### **c** (:art:)
_A console.log prettifier for node.js_
## Notice
Currently under development/unreleased, not for use in production.
## Installation
Published as an npm module under the `@reactual` organization.
```bash
yarn add @reactual/c
# or via npm
npm install --save @reactual/c
```
## Usage
There are a few possible ways to use _`c`_ within a project:
### Import Directly As Needed
Import or require from `@reactual/c` in each file as needed. Since _`c`_ is a default export, you can use any variable name you prefer.
```js
/** ES6 imports */
import c from '@reactual/c'
/** or any var preferred */
import log from '@reactual/c'
/** ES5 require */
const c = require('@reactual/c')
/** or any var preferred */
const log = require('@reactual/c')
```
### Logging messages
Replace normal `console.log` statements with examples below.
```js
const total = 2 + 2
// console.log('The total is:', total
c('The total is:', total)
```
### Specifying a log level
The most basic usage is to not specify a log level. _`c`_ defaults to `info`, or `error` if the value being logged is an instance of a node.js `Error`. You can also force a specific log level by passing a 3rd argument.
```js
const total = 2 + 2
/** level unspecified, defaults to "info" for values that aren't instances of Error */
c('info unspecified example, total:', total)
/** info, forced with abbreviation */
c('info example, total:', total, 'i')
/** info, forced with full word */
c('info, full word example, total:', total, 'info')
/** warn, forced with abbreviation */
c('warning example, total:', total, 'w')
/** error, forced with abbreviation */
c('error example, total:', total, 'e')
/** level unspecified, defaults to "error" for instances of Error */
c('error unspecified example, total:', new Error(total))
```
Valid values for log level, You can use the full name or abbreviation:
- `info` | `i`
- `warn` | `w`
- `error` | `e`
If you pass an invalid value for level, _`c`_ will ignore it and fallback to `info` or `error` depending on the value being logged.
In addition to instances of `Error`, the below error classes will default to the `error` level.
- `AssertionError`
- `RangeError`
- `ReferenceError`
- `SyntaxError`
- `TypeError`