node package manager
Stop wasting time. Easily manage code sharing in your team. Create a free org »

lme

lme

Simply and beautifully log to console.

Build Status Known Vulnerabilities npm npm Gitter chat

console.log ging done right, beautifully.

You don't have to write the 13 char long console.log() anymore. Try:

lme.d("hello world");

💫 This package is built from ground up with simplicity in mind. Best configuration ships with this package. i.e, You don't have to configure anything extra to start using this package. But if you need something unique, or if color of your terminal background contradicts with this package's colors (causing accessibility issues), or if you are a kind of unicorn, you have wonderful options to adjust them here. And this package is bound to strictly follow semantic versioning.

v1.5 is out. What's new?
- Set environment variable to adjust level of logging.
- Define your own color schemes for lines
- Define your own color schemes for texts
- Multiple argumnets support: lme.s("hi", "hello")
- Stability, performance improvements and Bug fixes.

Why lme ( logme )

Greenkeeper badge

Install / Update

npm install --save lme

Usage

Syntax

lme.<status>(message);

Example

const lme = require('lme');
 
lme.d("my kitty is pinky!"); // default style, used for anonymous outputs. 
lme.e("Snap! something went wrong."); // used for logging errors. 
lme.s("Oh yeah!"); // used for logging success. 
lme.w("Attention! Thank you for your attention."); // used for logging warnings. 
 
// lines 
lme.line() // used to draw lines 
lme.eline() // used to draw lines in error theme. 
lme.sline() // used to draw lines in success theme. 

APIs

Syntax : lme.<status>(message);

  • where <status> can have the following values:
status name when to use example
d default default output lme.d("hi");
s success on success output lme.s("hi");
e error on error-ed output lme.e("hi");
w warning for warnings like output lme.w("hi");
h highlight for highlighting an output lme.h("hi");
i info for info like output lme.i("hi");
t trace for tracing stack lme.t("hi");

where message can be string / float / int / objects. (note that javascript treats arrays as objects.)

You can also use multiple arguments with lme like:

lme.d(message[, message]);

Drawing lines with lme.line()

Syntax : lme.line(character, length). (both arguments are optional)

You can prefix d, s, e, w, h to the line() function to obtain the corresponding color scheme for your line. You can also simply use lme.line() which has some default values as described below.

Argument List

argument type purpose default value
character string determines which character should be used for drawing lines -
length integer length of the line 30

Examples

lme.line();
lme.eline("^");
lme.sline("@", 12);
lme.wline("#", 50);

APIs for drawing lines

status name when to use example
line default default output lme.line();
dline same as line default output lme.dline("*", 5);
sline success on success output lme.sline("*");
eline error on error-ed output lme.eline("/", 50);
wline warning for warnings like output lme.wline("*");
hline highlight for highlighting an output lme.hline("*");

Advanced fearures

Wiki
More configurations are on its way.

If you wish to file any feature/bugs, mention it on issues.

Enjoy.

Thanks

Thanks to everyone who contributed to this project by means of providing feedback, rising issues, opening pull requests and reviewing codes. Thanks for using lme.

Contributors

Loves lme? ❤️

tell your friends.. 👬
star this project on Github ⭐️

Change log

  • v1.5.2, 1.5.3 (8th June 2017)
    • Adds extra badges, docs update.
    • Gitter chat
  • v1.5.1 (27th March 2017)
    • IMPORTANT bug fix: addressing issue with displaying instances of Error class. (#30). (Highly recommended to update to this version)
  • v1.5.0 (6th March 2017)
  • v1.4.1, v1.4.2
    • Patch: Excluding an unnecessary folder -> reduces package size.
    • Updating docs and media.
  • v1.4.0 (26th Jan 2017)
    • Added support for custom color configuration.
    • Added support for multiple arguments. (thanks @demacdonald)
    • Stability and performance improvements.

See detailed change log

License

MIT © Vajahath Ahmed