@lcluber/mouettejs

Synopsis

Mouette.js is a lightweight logger written in Typescript.

Motivation

The purpose of this library is to provide a simple and easy way to log infos throughout your code.

Installation

NPM

$ npm install @lcluber/mouettejs

Yarn

$ yarn add @lcluber/mouettejs

Usage

ES6

import { Logger, Group } from "@lcluber/mouettejs";

// some variables to log
var string = 'test';
var number = 2345;
var array  = [1,2,3,4];
var object = {
  string: 'test',
  number: 2345,
  array: [1,2,3,4],
  object: {yo: 'yo', ye: 'ye'}
};

var newLogsGroup = Logger.addGroup("newLogsGroup");

newLogsGroup.setLevel("info");
newLogsGroup.displayConsole(true);

newLogsGroup.info(string);
newLogsGroup.trace(number);
newLogsGroup.warn(array);
newLogsGroup.error(object);

newLogsGroup.time("timing log");
for (i = 0; i < 100000; i++) {
  // some code
}
newLogsGroup.time("timing log");

var logs = Logger.getLogs();

console.log('logs', logs);

var sendLogs = Logger.sendLogs('http://httpbin.org/post');
sendLogs.then((responseData) => {
  console.log(responseData); //status response 
});

IIFE

<script src="node-modules/@lcluber/mouettejs/dist/mouette.iife.min.js"></script>

// some variables to log
var string = 'test';
var number = 2345;
var array  = [1,2,3,4];
var object = {
  string: 'test',
  number: 2345,
  array: [1,2,3,4],
  object: {yo: 'yo', ye: 'ye'}
};

var newLogsGroup = Mouette.Logger.addGroup("newLogsGroup");

newLogsGroup.setLevel("info");
newLogsGroup.displayConsole(true);

newLogsGroup.info(string);
newLogsGroup.trace(number);
newLogsGroup.warn(array);
newLogsGroup.error(object);

newLogsGroup.time("timing log");
for (i = 0; i < 100000; i++) {
  // some code
}
newLogsGroup.time("timing log");

var logs = Mouette.Logger.getLogs();

console.log('logs', logs);

var sendLogs = Mouette.Logger.sendLogs('http://httpbin.org/post');
sendLogs.then((responseData) => {
  console.log(responseData); //status response 
});

API Reference

type LevelName = "info" | "time" | "trace" | "warn" | "error" | "off";
type LogContent = string | number | any[] | Object;

static Logger.setLevel(name: LevelName): LevelName {} // set the minimum level at which logs can be stored and displayed into console. Note that this setting will propagate to every group. You can set a different level for a group AFTER setting the level for the entire logger.
static Logger.getLevel(): LevelName {} // get the general level of the logger. Note that groups can have a different level if changed afterwards at group level
static Logger.displayConsole(value: boolean): boolean {} // set wether or not to display logs into console at logger level. Note that this setting will propagate to every group. This option can be changed individually for each group if changed afterwards at group level
static Logger.addGroup(name: string): Group {} // create a new group of logs
static Logger.getLogs(): Log[] {} // get all the logs in 1 array
static Logger.sendLogs(url: string, headers: Headers): Promise<response> {} // sends all the logs to given backend API ans reset logs if success.
static Logger.resetLogs(): void {} // Delete every logs of every group 

Group.setLevel(name: LevelName): levelName {} // set the minimum level at which logs of this group can be stored and displayed into console
Group.getLevel(): LevelName {} // get the level at which logs of this group can be displayed
Group.displayConsole(value: boolean): boolean {} // set wether or not to display logs into console
Group.setMaxLength(length: number): number {} // set the maximum quantity of logs stored by this group
Group.getMaxLength(): number {} // get the maximum quantity of logs stored by this group

Group.info(log: LogContent): void {} // create an info log
Group.time(key: string | number): void {} // create a time log. Use the same method to start or stop the timer. Using the same key, first call will start it, second call will stop it and return the elapsed time between the two.
Group.trace(log: LogContent): void {} // create a trace log
Group.warn(log: LogContent): void {} // create a warn log
Group.error(log: LogContent): void {} // create an error log

LEVELS: Levels = {
  info:   { id:  1, name: "info",  color: "#28a745" },
  time:   { id:  2, name: "time",  color: "#28a745" },
  trace:  { id:  3, name: "trace", color: "#17a2b8" },
  warn:   { id:  4, name: "warn",  color: "#ffc107" },
  error:  { id:  5, name: "error", color: "#dc3545" },
  off:    { id: 99, name: "off",   color: null }
};

Tests

No tests to run yet

Contributors

There is still a lot of work to do on this project and I would be glad to get all the help you can provide. To contribute you can clone the project on GitHub and see NOTICE.md for detailed installation walkthrough of the project.

License

MIT License

Copyright (c) 2017 Ludovic CLUBER

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.