Repository files navigation

The best alternative to the console.log statement

This project isfree,open source and I try to provide excellentfree 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!

• 💡Features
• 👔Screenshot
• 🚀How to use
• 📚Documentation
• • 🧰Options
• • 🔌Methods
• • 🎨Palette
• • 🤹‍♂️LogRotate
• 👨‍💻Contributing
• 🐛Known Bugs
• 🍻 Community:
  • Discord (🇬🇧 English Channel |🇮🇹 Italian Channel |🇵🇱 Polish Channel)

• [✔️] Easy to use
• [✔️] MIT License
• [✔️] Palette (🎨 Customize colors)
• [✔️] Logrotate 🤹‍♂️
• [✔️] Typescript support
• [✔️] 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 withpinojs
• [✔️] Translations: 🇬🇧 🇮🇹 🇵🇱 🇪🇸 🇵🇹 🇷🇺 🇩🇪 🇫🇷 (Help me ❤️)

1. In your node project run:npm install @ptkdev/logger --save
2. Usage:

constLogger=require("@ptkdev/logger");constlogger=newLogger();logger.info("message");

You can setoptions tonew Logger(options); example:

constLogger=require("@ptkdev/logger");constoptions={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 .gitignoredebug_log:"./debug.log",error_log:"./errors.log",},};constlogger=newLogger(options);logger.info("message");

See folderexamples, run withnode example.js. Below is available a description ofoptions values.

You can customize palette colors with Objectpalette 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 folderexamples, run withnode example.js.

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"},...

Runnpm run docs

Support this project by becoming a sponsor. 🙏 Become a sponsor onpatreon or become top3 sponsor onko-fi. Your logo will show up here with a link to your website.

Thank you to all our backers! 🙏 Become a backer onpatreon.

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 andpackage.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!

I love snake_case syntax sorry for this 😭 don't hate me.

• Code and Contributions haveMIT License
• Images and logos haveCC BY-NC 4.0 License (Freepik Premium License)
• Documentations and Translations haveCC BY 4.0 License