just-simple

Simple utilities for diagnostics and logging

Installation

git clone https://github.com/oyamist/just-simple.git
cd just-simple
npm install
npm run test

Example simpleString(value)

Use js.simpleString to generate a simple string for a data value:

const { js } = require('just-simple').JustSimple;
var addr = {city: "SFO");
js.simpleString(addr); // {city:SFO}

You can override the toString method of a class to print it simply:

    class Observation {
        constructor(tag, value, text) {
            this.tag = tag;     // an important attribute
            this.value = value; // an important attribute
            this.text = text;   // annotational attribute
        }
 
        toString() {
            var {
                tag,
                value,
            } = this;
            return `<${tag}:${js.simpleString(value)}>`;
        }
    }
 
    var ob1 = new Observation('size', 42, 'a universal dimension');
    js.simpleString(ob1); // <size:42>

Here is a simple string for a complex value:

var ob2 = new Observation('address', addr, 'an object');
 
js.simpleString([ob1,[ob2]]);
// [[<size:42>], <address:{city:SFO}>]

Example logger

Setting up Winston consistently across different packages is tedious. JustSimple.logger provides a bare-bones utilitarian Winston logger instance.

const { logger } = require("just-simple").JustSimple;
 
logger.info("Hello world");
// 20190926 08:40:17 I Hello world

Example LOCAL_DIR

NodeJs applications often need application local file storage. Since the application folder is a well-known location created during git clone ..., it's simple and convenient to just create a local folder for application local file storage. Adding local/ to .gitignore assures that the contents of local remain local. This convention can also work for NodeJs libraries that store information in the calling application's local folder. JustSimple.LOCAL_DIR returns the application's local folder for a NodeJs library or application.

const { LOCAL_DIR } = require('just-simple').JustSimple;