0.1.1 • Published 3 years ago

@nzambello/logvar v0.1.1

Weekly downloads
-
License
Apache-2.0
Repository
-
Last release
3 years ago

logvar

TypeScript version Node.js version APLv2 Node.js CI

Utility that prints variables in console log for debugging purpose. 🐛

logvar({ life }); // logs `life: 42`

Table of contents 📖

The purpose 👨‍💻

This is the same old story: a lazy developer automating a simple but repetitive task when it is not really needed. Does the world need another utility for lazy devs? Maybe not, but I did this.

I found myself writing things like:

console.log(`loremIpsum:`, loremIpsum);

500 times a day to debug stuff in js.

I was logging variables but having some of them, I needed a label with the name, so I logged a string with the name and then the value. 500 times a day. This utility is a helper function doing this for you.

The real purpose: life 🍻

Was I losing time on this console.log thingy? Maybe not, but don't we developers have more to focus on? I think quality of life of a developer is compromised by a lot of stuff, debugging is tedious and this won't be annoying anymore!

So, this utility is meant to hug you during your debugging time saying: "Hey, you're great, you will find out what is going on. Here's some help". 🤗

Installation 🚀

yarn add --dev @nzambello/logvar
# npm i --save-dev @nzambello/logvar

Usage 🛠️

Try it out on CodeSandBox.

import logvar from '@nzambello/logvar';
// node:
// var logvar = require('@nzambello/logvar');

const life = 42;
const hello = 'world!';

// passing an object with the varibles to inspect like this
logvar({ life });
/* prints:
life: 42
*/

// passing multiple variables
logvar({ life, hello });
/* prints:
life:  42
hello: world!
*/

// passing a variable directly
logvar(life);
/* prints:
42
*/

License 👐

Licensed under the APLv2. See the LICENSE file for details.