Skip to content

Repository files navigation

logger

LicenseTravis CICoverage StatusCommitizen

💢 Make logging friendlier, simpler and use emojis in your messages. Try logger!

Installation

logger is available on npm/yarn:

$ npm install @codevor/logger.js --save
$ yarn add @codevor/logger.js

Usage

With ES6/import

importLoggerfrom'@codevor/logger.js';Logger.success('Success message example.');// => ✅ Success message exampleLogger.error('Error message example.');// => 🚫 Error message exampleLogger.warn('Warning message example.');// => ⚠️ Warning message exampleLogger.info('Information message example.');// => ℹ️ Informational message example// PROMISE STATUSES LOGSLogger.pending('Promise message example.',{hello: true});// => ℹ️ Promise message example | pending {"hello":true}Logger.fulfilled('Promise message example.',{hello: true});// => ✅ Promise message example | fulfilled {"hello":true}Logger.rejected('Promise message example.',{hello: true});// => 🚫 Promise message example | rejected {"hello":true}Logger.settled('Promise message example.',{hello: true});// => ✅ Promise message example | settled {"hello":true}

With require

constLogger=require('@codevor/logger.js');Logger.success('Success message example.');// => ✅ Success message exampleLogger.error('Error message example.');// => 🚫 Error message exampleLogger.warn('Warning message example.');// => ⚠️ Warning message exampleLogger.info('Information message example.');// => ℹ️ Informational message example// PROMISE STATUSES LOGSLogger.pending('Promise message example.',{hello: true});// => ℹ️ Promise message example | pending {"hello":true}Logger.fulfilled('Promise message example.',{hello: true});// => ✅ Promise message example | fulfilled {"hello":true}Logger.rejected('Promise message example.',{hello: true});// => 🚫 Promise message example | rejected {"hello":true}Logger.settled('Promise message example.',{hello: true});// => ✅ Promise message example | settled {"hello":true}

Note: All promises convert objects to strings

Change Emojis

Is it possible to change emojis for each message? Yes! Check it out:

importLogger,{Emoji}from'@codevor/logger.js';Logger.success('Success message example.');// => ✅ Success message exampleEmoji.setEmoji({type: 'success',emoji: '🐶'});Logger.success('Success message example.');// => 🐶 Success message example

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Changelog

This project adheres to Semantic Versioning. Every release, along with the migration instructions, is documented on the Github Releases page.

Bugs and Sugestions

Report bugs or do suggestions using the issues.

License

MIT License © Codevor

About

💢 Make logging friendlier, simpler and use emojis in your messages. Try logger!

Topics

Resources

Contributing

Stars

5 stars

Watchers

2 watching

Forks

Releases

Packages

Used by

Contributors

Languages