# onelinelogger

> Simple NodeJS logging to upgrade and extend console.log()

Latest version **1.1.4** (published 2022-01-23) · MIT license · 0 weekly downloads

## Install

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

## 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.1.4 |
| Published | 2022-01-23 |
| First published | 2015-12-03 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.12 |
| Dependencies | 1 |
| Unpacked size | 18.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Gary Smart |
| Maintainers | garyns |
| Keywords | log, logger, logging, terminal, output, console |

## Links

- npm: https://www.npmjs.com/package/onelinelogger
- Repository: https://github.com/garyns/OneLineLogger
- Homepage: https://github.com/garyns/OneLineLogger#readme
- Issues: https://github.com/garyns/OneLineLogger/issues
- npm.io page: https://npm.io/package/onelinelogger

## Dependencies (1)

- [colors](https://npm.io/package/colors.md) ^1.1.2

## 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.1.4 (latest) — 2022-01-23
- 1.1.3 — 2022-01-23
- 1.1.2 — 2022-01-23
- 1.1.1 — 2021-05-29
- 1.1.0 — 2021-03-26
- 1.0.2 — 2020-05-16
- 1.0.1 — 2015-12-03
- 1.0.0 — 2015-12-03
- 0.0.7 — 2015-12-03
- 0.0.6 — 2015-12-03
- 0.0.5 — 2015-12-03
- 0.0.4 — 2015-12-03

## README

# OneLineLogger

Simple no-fuss colorised logging for NodeJS

## Feature Overview

* Light-weight, quick to setup and easy to use.
* Multiple logger instances
* Customizable logger prefixes (to help distinguish logging from different modules)
* One line statement to optionally upgrade (colorize and timestamp) all existing uses of `console.log()`, `console.info()`, `console.warn()` and `console.error()` throughout a code base.
* Log to file.
* Configurable logging levels - DEBUG, INFO, WARN & ERROR.

> Please note OneLineLogger is for NodeJS. It will not work in Web Browsers.

## Installing

##### NPM

```shell
npm install onelinelogger
```

##### GIT

Clone from GIT and install dependencies.

```shell
git clone https://github.com/garyns/OneLineLogger.git
cd OneLineLogger
npm install
```

## Examples

##### Basic Usage

```js
// Variable logger is considered the 'default logger' instance. Custom loggers are discussed later.
var logger = require("onelinelogger");

logger.log("Call to logger.log()");
logger.info("Call to logger.info()");
logger.warn("Call to logger.warn()");
logger.error("Call to logger.error()");
logger.debug("Call to logger.debug()");
logger.highlight("Call to logger.highlight()");
```

Here is the output:

![Console Output](https://raw.githubusercontent.com/garyns/OneLineLogger/master/mdassets/Console1-BasicLogger.jpg)

For onelinelogger 1.1.2+ `logger.boo()` is an alias for `logger.highlight()`

##### Overloading console.log() and related functions

```js
var logger = require("onelinelogger");

// Before Overloading
console.log("Call to console.log()");
console.info("Call to console.info()");
console.warn("Call to console.warn()");
console.error("Call to console.error()");

// Overload with default logger
logger.replaceConsole();

console.log("Call to console.log()");
console.info("Call to console.info()");
console.warn("Call to console.warn()");
console.error("Call to console.error()");
console.debug("Call to console.debug()");
console.highlight("Call to console.highlight()");
```

Here is the output (spacing added):

![Console Output](https://raw.githubusercontent.com/garyns/OneLineLogger/master/mdassets/Console3-ConsoleOverload.jpg)

##### Custom Logger Instance

Create custom loggers to help associate log entries with different parts of your code.

```js
// Default Logger instance
var logger = require("onelinelogger");

// Custom Logger instance
// [MY_LOGGER] is now added to every line
var myLogger = logger.create("MY_LOGGER");

myLogger.log("Call to myLogger.log()");
myLogger.info("Call to myLogger.info()");
myLogger.warn("Call to myLogger.warn()");
myLogger.error("Call to myLogger.error()");
myLogger.debug("Call to myLogger.debug()");
myLogger.highlight("Call to myLogger.highlight()");


// Alternatively, you could...
var myLogger2 = require("onelinelogger").create("MY_LOGGER2");

```

Here is the output:

![Console Output](https://raw.githubusercontent.com/garyns/OneLineLogger/master/mdassets/Console2-CustomLogger.jpg)

You can change the 'prefix' of a logger by calling `setPrefix()`.

```js
var logger = require("onelinelogger");

// Output of default logger now prefixed with [MAIN]
logger.setPrefix("MAIN");

// Customer Logger - [MY_LOGGER] is added to every line...
var myLogger = logger.create("MY_LOGGER");

// ... And now it's [THEIR_LOGGER]
myLogger.setPrefix("THEIR_LOGGER");
```

##### Global Settings

These settings affect ALL logger instances - that is the default logger and any custom loggers you create.

```js
var logger = require("onelinelogger");

// Append all output to a file
logger.setGlobalFile("log.txt");

// Stop logging to a file
logger.setGlobalFile(null);

// Set the length of the prefix text
// Tweaking this property helps you keep your text lining up
// Eg 0 -> [MAIN], where 10 -> [MAIN     ]
logger.setGlobalPrefixLength(10);

// Set Logging Level to one of constants logger.DEBUG logger.INFO (default), logger.NOTICE, logger.WARN or logger.ERROR, or alternatively the strings DEBUG, INFO, NOTICE, WARN or ERROR
logger.setLevel(logger.INFO)
logger.setLevel("WARN")

// Get Logging Level (as Number 0 - 4).
const currentLogLevel = logger.getLevel()

// Get Logging Level Name (DEBUG, INFO, NOTICE, WARN or ERROR)
const currentLogLevelName = logger.getLevelName()


// Suppress (false) or show (true) calls to .debug()
// NOTE deprecated in v1.1.2. Use setLevel(logger.DEBUG) instead.
logger.setGlobalDebugging(true);

// Check if log level is logger.DEBUG
const debugging = logger.isDebug();

// The previous isDebug() example is equivalent to
const debugging = logger.getLevel() === logger.DEBUG
```

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