Skip to content
nightly
Go to file
Code

README.md

Beautiful Logger for Node.js: the best alternative to the console.log statement

๐Ÿฆ’ Beautiful Logger for Node.js

The best alternative to the console.log statement

๐ŸŽ Support: Donate

This project is free, open source and I try to provide excellent free support. Why donate? I work on this project several hours in my spare time and try to keep it up to date and working. THANK YOU!

๐Ÿ“Ž Menu

๐Ÿ’ก Features

  • [โœ”๏ธ] Easy to use
  • [โœ”๏ธ] MIT License
  • [โœ”๏ธ] Linux / Mac OSX / Windows 10 (Powershell)
  • [โœ”๏ธ] Palette (๐ŸŽจ Customize colors)
  • [โœ”๏ธ] Logrotate ๐Ÿคนโ€โ™‚๏ธ
  • [โœ”๏ธ] Typescript typization supported
  • [โœ”๏ธ] The best alternative to the console.log statement
  • [โœ”๏ธ] Write stdout logs to file (supported format: text/log and json)
  • [โœ”๏ธ] The JSON logs format is compatible with pinojs
  • [โœ”๏ธ] Translations: ๐Ÿ‡ฌ๐Ÿ‡ง ๐Ÿ‡ฎ๐Ÿ‡น ๐Ÿ‡ต๐Ÿ‡ฑ ๐Ÿ‡ช๐Ÿ‡ธ ๐Ÿ‡ต๐Ÿ‡น ๐Ÿ‡ท๐Ÿ‡บ ๐Ÿ‡ฉ๐Ÿ‡ช ๐Ÿ‡ซ๐Ÿ‡ท (Help me โค๏ธ)

๐Ÿ‘” Screenshot

Beautiful Logger for Node.js

๐Ÿš€ Installation

  1. In your node project run: npm install @ptkdev/logger --save
  2. Usage:
const Logger = require("@ptkdev/logger");
const logger = new Logger();
logger.info("message");

You can set options to new Logger(options); example:

const Logger = require("@ptkdev/logger");

const options = {
	"language": "en",
	"colors": true,
	"debug": true,
	"info": true,
	"warning": true,
	"error": true,
	"sponsor": true,
	"write": true,
	"type": "log",
	"rotate": {
		"size": "10M",
		"encoding": "utf8"
	},
	"path": { // remember: add string *.log to .gitignore
		"debug_log": "./debug.log",
		"error_log": "./errors.log",
	}
};

const logger = new Logger(options);
logger.info("message");

See folder examples, run with node example.js. Below is available a description of options values.

๐Ÿงฐ Options

Parameter Description Values Default value Available since
language Set language of log type en / it / pl / es / pt / de / ru / fr en v1.0.0
colors Enable colors in terminal true / enabled / false / disabled true v1.0.0
debug Enable all logs with method debug true / enabled / false / disabled true v1.0.0
info Enable all logs with method info true / enabled / false / disabled true v1.0.0
warning Enable all logs with method warning true / enabled / false / disabled true v1.0.0
error Enable all logs with method errors true / enabled / false / disabled true v1.0.0
sponsor Enable all logs with method sponsor true / enabled / false / disabled true v1.0.0
write Write the logs into a file, you need set path values true / enabled / false / disabled false v1.0.0
type Format of logs in files log / json log v1.0.0
rotate Rotates the log files when size exceeds this value 10B / 10K / 10M / 10G "rotate": {"size": "10M"} v1.5.0
palette Change palette with hexcode colors Object default palette v1.5.0
path If write is true, the library writes the logs to a path Object {"debug_log": "./debug.log", "error_log": "./errors.log"} v1.0.0

๐Ÿ”Œ Methods

Method Description Parameters
debug(message, tag) message: Display debug log message
tag: prefix of message
message: string (mandatory)
tag: string (optional)
info(message, tag) message: Display info log message
tag: prefix of message
message: string (mandatory)
tag: string (optional)
warning(message, tag) message: Display warning log message
tag: prefix of message
message: string (mandatory)
tag: string (optional)
error(message, tag) message: Display errors log message
tag: prefix of message
message: string (mandatory)
tag: string (optional)
sponsor(message, tag) message: Display sponsor log message
tag: prefix of message
message: string (mandatory)
tag: string (optional)
stackoverflow(message, tag, error_string) message: Display stackoverflow log message
tag: prefix of message
error_string: query for stackoverflow, if empty we use message param
message: string (mandatory)
tag: string (optional)
error_string: string (optional)
docs(message, url, tag) message: Display docs log message
url: link of documentation
tag: prefix of message
message: string (mandatory)
url: string (optional)
tag: string (optional)

๐ŸŽจ Palette

Beautiful Logger for Node.js

You can customize palette colors with Object palette and with hexcode values.

  • label is text on left (INFORMATION / ERROR / DOCS, etc..)
  • text is message of log on right
  • background is background color on left side
{
	...
	"palette": {
		"info": { // method name
			"label": "#ffffff", // label on left
			"text": "#4CAF50",  // log message
			"background": "#4CAF50" // background
		},
		"warning": {
			"label": "#ffffff",
			"text": "#FF9800",
			"background": "#FF9800"
		},
		"error": {
			"label": "#ffffff",
			"text": "#FF5252",
			"background": "#FF5252"
		},
		"stackoverflow": {
			"label": "#ffffff",
			"text": "#9C27B0",
			"background": "#9C27B0"
		},
		"docs": {
			"label": "#ffffff",
			"text": "#FF4081",
			"background": "#FF4081"
		},
		"debug": {
			"label": "#ffffff",
			"text": "#1976D2",
			"background": "#1976D2"
		},
		"sponsor": {
			"label": "#ffffff",
			"text": "#607D8B",
			"background": "#607D8B"
		},
		"time": {
			"label": "#ffffff",
			"background": "#795548"
		}
	}
	...
}

See folder examples, run with node example.js.

๐Ÿคนโ€โ™‚๏ธ LogRotate

Rotates the file when size exceeds 10 megabytes (optional, default 10M - values: 10B (byte) / 10K (kilobyte)/ 10M (megabyte)/ 10G (gigabyte))

...
"rotate": {
	"size": "10M",
	"encoding": "utf8"
},
...

๐Ÿ“š Documentation

Run npm run docs

๐Ÿ‘‘ Sponsors

Support this project by becoming a sponsor. ๐Ÿ™ Become a sponsor on patreon or become top3 sponsor on ko-fi. Your logo will show up here with a link to your website.

๐Ÿฆ„ Backers

Thank you to all our backers! ๐Ÿ™ Become a backer on patreon.

๐Ÿ‘จโ€๐Ÿ’ป Contributing

I โค๏ธ contributions! I will happily accept your pull request! Translations, grammatical corrections (GrammarNazi you are welcome! Yes my English is bad, sorry), etc... Do not be afraid, if the code is not perfect we will work together ๐Ÿ‘ฏ and remember to insert your name in .all-contributorsrc and package.json file.

Thanks goes to these wonderful people (emoji key):


Patryk Rzucidล‚o

๐Ÿ’ป ๐ŸŒ ๐Ÿ“– ๐Ÿ›

Ilua Chubarov

๐Ÿ’ป

Bruno Kรผmmel

๐Ÿ’ป ๐ŸŒ

Alina Osv

๐ŸŒ

Sylvain Tรฉchenรฉ

๐ŸŒ

Giovanni Cardamone

๐Ÿ’ป

๐Ÿ’ฐ In the future, if the donations allow it, I would like to share some of the success with those who helped me the most. For me open source is share of code, share development knowledges and share donations!

๐Ÿ“ฒ Tools

๐Ÿ Sorry for snake_case

I love snake_case syntax sorry for this ๐Ÿ˜ญ don't hate me.

๐Ÿ’ซ License

  • Code and Contributions have MIT License
  • Images and logos have CC BY-NC 4.0 License (Freepik Premium License)
  • Documentations and Translations have CC BY 4.0 License
Copyleft (c) 2020 Patryk Rzucidล‚o (@PTKDev) <support@ptkdev.io>
You canโ€™t perform that action at this time.