Skip to content
๐Ÿฆ’ Beautiful Logger for Node.js: the best alternative to the console.log statement
JavaScript
Branch: nightly
Clone or download

Latest commit

Fetching latest commitโ€ฆ
Cannot retrieve the latest commit at this time.

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github [Release] v1.1.0 Mar 8, 2020
examples [Release] v1.1.0 Mar 8, 2020
modules [Release] v1.1.1 Mar 8, 2020
translations [Release] v1.0.0 Mar 8, 2020
.all-contributorsrc [Release] v1.0.0 Mar 8, 2020
.editorconfig
.eslintrc.json [Release] v1.1.0 Mar 8, 2020
.gitattributes [Release] v1.0.0 Mar 8, 2020
.gitignore [Release] v1.1.0 Mar 8, 2020
.gitmodules [Release] v1.0.0 Mar 8, 2020
.jshintrc [Release] v1.0.0 Mar 8, 2020
.npmignore [Release] v1.1.0 Mar 8, 2020
CHANGELOG.md [Release] v1.1.2 Mar 28, 2020
LICENSE.md [Release] v1.0.0 Mar 8, 2020
README.md [Release] v1.1.2 Mar 28, 2020
jsconfig.json [Release] v1.0.0 Mar 8, 2020
package-lock.json [Release] v1.1.2 Mar 28, 2020
package.json [Release] v1.1.2 Mar 28, 2020

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
  • [โœ”๏ธ] 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",
	"path": {
		"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 and all logger methods.

Options

Parameter Description Values Default value
language Set language of log type en|it|pl en
colors Enable colors in terminal true|enabled|false|disabled true
debug Enable all logs with method debug true|enabled|false|disabled true
info Enable all logs with method info true|enabled|false|disabled true
warning Enable all logs with method warning true|enabled|false|disabled true
error Enable all logs with method errors true|enabled|false|disabled true
sponsor Enable all logs with method sponsor true|enabled|false|disabled true
write Write the logs into a file, you need set path values true|enabled|false|disabled false
type Format of logs in files log|json log
path If write is true, the library writes the logs to a path Object {"debug_log": "./debug.log", "error_log": "./errors.log"}

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)

๐Ÿ“š 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

๐Ÿ’ป

๐Ÿ’ฐ 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.