# crimson

> Simple Logging with Style and Log to File functionality

Latest version **1.0.0** (published 2016-04-16) · ISC license · 0 weekly downloads

## Install

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

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2016-04-16 |
| First published | 2015-12-06 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | kurisubrooks |
| Maintainers | kurisubrooks |
| Keywords | log, logger, logging, console, terminal |

## Links

- npm: https://www.npmjs.com/package/crimson
- Repository: https://github.com/kurisubrooks/crimson
- Homepage: https://github.com/kurisubrooks/crimson#readme
- Issues: https://github.com/kurisubrooks/crimson/issues
- npm.io page: https://npm.io/package/crimson

## Dependencies (2)

- [chalk](https://npm.io/package/chalk.md) ^1.1.1
- [moment](https://npm.io/package/moment.md) ^2.10.6

## Alternatives

- [cli-color](https://npm.io/package/cli-color.md) — 3.4M weekly downloads
- [log](https://npm.io/package/log.md) — 1.3M weekly downloads
- [logstash-client](https://npm.io/package/logstash-client.md) — 4.5K weekly downloads
- [@nocobase/plugin-logger](https://npm.io/package/@nocobase/plugin-logger.md) — 2.0K weekly downloads
- [child-process-debug](https://npm.io/package/child-process-debug.md) — 695 weekly downloads

## Recent versions

- 1.0.0 (latest) — 2016-04-16
- 0.0.2 — 2016-01-26
- 0.0.1 — 2015-12-06

## README

# Crimson

### Usage
```javascript
const Crimson = require('crimson');
const crimson = new Crimson({
    debug: true, 
    path: path.join(__dirname, 'logs'),
    keep: true,
    prefix: ''
});
```

All options are optional, and not required.

#### Crimson.debug
default: `true`
Specifies whether `crimson.debug()` will show log in console

#### Crimson.path
default: `path.join(__dirname, 'logs')`
Specifies the path to where the log files are kept.

#### Crimson.keep
default: `true`
Specifies whether to save the log to a file

#### Crimson.prefix
default: `''`
Adds a prefix to every log line


### Functions
```javascript
crimson.log(); // plain
crimson.success(); // green
crimson.error(); // red
crimson.info(); // blue
crimson.warn(); // yellow
crimson.fatal(); // red + throw
```

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