Simple utilities for diagnostics and logging
Installation
git clone https://github.com/oyamist/just-simple.gitcd just-simplenpm installnpm run test
simpleString(value)
Example Use js.simpleString
to generate a simple string for a data value:
const js = JustSimple;var addr = city: "SFO");js; // {city:SFO}
You can override the toString
method of a class to print it simply:
{ thistag = tag; // an important attribute thisvalue = value; // an important attribute thistext = text; // annotational attribute } { var tag value = this; return `<:>`; } var ob1 = 'size' 42 'a universal dimension'; js; // <size:42>
Here is a simple string for a complex value:
var ob2 = 'address' addr 'an object'; js;// [[<size:42>], <address:{city:SFO}>]
logger
Example Setting up Winston consistently across different packages is tedious. JustSimple.logger provides a bare-bones utilitarian Winston logger instance.
const logger = JustSimple; logger;// 20190926 08:40:17 I Hello world
LOCAL_DIR
Example 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 = JustSimple;