Giter Club home page Giter Club logo

lee-fs-utility-debugger's Introduction

Lee FS Utility Debugger

This is a simple NPM package that uses Winston to create a custom logging utility for my Node app. The purpose is to defer logging from the console.log() function.

Installation

To install, npm install lee-fs-utility-debugger

Setup

To set up the logs, create them in src/logs/app.log and src/logs/error.log

Use

Info Logging

To log to the info log, use

logger.info('Logged Text');

which will return

info: Logged Text

in the console.

Error Logging

To log to the info log, use

logger.error('Logged Text');

which will return

error: Logged Text

in the console.

Unit Testing

To unit test the package, run mocha

Version Increaser

This application uses a version increaser.

.updateVersion(current, release)

This method receives a semantically incremented version number.

.updateVersion('1.2.3', 'major')

This will return 2.0.0. It resets minor and patch to 0 and increments the major version

.updateVersion('1.2.3', 'minor')

This will return 1.3.0. It resets patch to 0 and increments the minor version.

.updateVersion('1.2.3', 'patch')

This will return 1.2.4. It increments only the patch version.

Entering an invalid version number will return Invalid version number!. Entering an invalid release will return Invalid release type!.

Code Deploy

Codeship Status for codeship/documentation

The repo will auto deploy to Codeship once the master branch is pushed.

lee-fs-utility-debugger's People

Contributors

leesaenz avatar

Watchers

 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.