The best alternative to the console.log statement

Beautiful Logger for Node.js

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

I love using console.log but it is difficult to record all the log information. I have implemented a small colored variant with tags, colors, messages of various errors and write to file logs in .json / txt format.

Resources: [NPM] [GITHUB]

💡 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");

Options

ParameterDescriptionValuesDefault value
languageSet language of log typeen/it/plen
colorsEnable colors in terminaltrue/enabled/false/disabledtrue
debugEnable all logs with method debugtrue/enabled/false/disabledtrue
infoEnable all logs with method infotrue/enabled/false/disabledtrue
warningEnable all logs with method warningtrue/enabled/false/disabledtrue
errorEnable all logs with method errorstrue/enabled/false/disabledtrue
sponsorEnable all logs with method sponsortrue/enabled/false/disabledtrue
writeWrite the logs into a file, you need set path valuestrue/enabled/false/disabledfalse
typeFormat of logs in fileslog/jsonlog
pathIf write is true, the library writes the logs to a pathObject{"debug_log": "./debug.log", "error_log": "./errors.log"}

Methods

MethodDescriptionParameters
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)

💫 License

  • Code and Contributions have MIT License
  • Images and logos have CC BY-NC 4.0 License
  • Documentations and Translations have CC BY 4.0 License

❤️ Thanks! Leave a feedback!

No Comments Yet