Giter VIP home page Giter VIP logo

loglady's Introduction

view on npm Dependency Status

loglady

One Day the Sadness Will End - Log Lady - Art Print - 8x10, by DecisionandRevision at Etsy

Utility for logging categorized and formatted output in cli apps or when debugging.

Installation

npm install loglady

Usage

const loglady = require('loglady');

loglady.setMuted(isMuted);
loglady.setVerbose(isVerbose);
loglady.setLogFunc(logFunc);
loglady.setIgnoreFuncRegex(regex);
loglady.clearHistory();
loglady.log(...args);
loglady.logVerbose(...args);
loglady.json(json);
loglady.error(err);
loglady.pipeStdout(data);
loglady.section(heading);
loglady.action(heading);
loglady.command(cmd);
loglady.fncall(fn);
loglady.intermediate(message);
loglady.showIntroHeader(title, barChar = '#');
loglady.endWithABang(msg);
loglady.endInTotalDespair(err);
loglady.spyOn(obj, name = null);

Examples

Get a taste of loglady by running node examples/log-all-the-things.js and you'll see something like:

Roadmap

  • Some sort of (configurable) timestamps
  • Log data sets as ascii tables
  • Customizable styling (colors and text-decoration)
  • Customizable ascii images
  • Browser support
  • Log history
  • Saving log history to a file
  • Option to buffer output and log later
  • Smart logging based on type of input (string, error etc)
  • Spy on an object and log all its function calls
  • Styled boolean logging
  • Ability to theme output using TextMate/Sublime/Atom color schemes

Developing

Tasks

Building the distributed version

npm run dist

Releasing a new version

npm run release -- (major|minor|patch|x.x.x)

Todo

  • Watch -> build
  • JS linting
  • Visual examples in README
  • Interactive tryout

loglady's People

Contributors

alexanderwallin avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.