vuejs-logger

Provides customizable logging functionality for Vue.js. Compatible with Vue2.

Table of Contents

• Demo
• Introduction
• Install
• Usage
• Properties
• Code example
• Production tips
• Maintainers
• Contribute
• License

Demo

@ https://codepen.io/justinkames/pen/BwGOVQ

Introduction

vuejs-logger is a tool that enables configurable logging for Vue applications. Features include :

• Output restriction based on selected loglevel.
• Automatically JSON.stringify() the (reactive) properties passed to the logger.
• Configurable options to customize output for a log messages.
• Colored console messages for $log.warning and $log.error.

logLevels :  ['debug', 'log', 'info', 'warn', 'error']

Install

This project uses node and npm.

https://www.npmjs.com/package/vuejs-logger

$ npm install vuejs-logger --save-exact

Usage

Below you can find an example of how to use vuejs-logger :

Properties

Name	Required	Type	Default	Description
isEnabled	false	Boolean	true	Enables the vuejs-logger plugin, useful toggle for production/development.
logLevel	false	String	'debug'	Choose between ['debug', 'log', 'info', 'warn', 'error']. Read production tips.
stringifyArguments	false	Boolean	false	If true, all input will go through JSON.stringify(). Useful when printing reactive properties.
showLogLevel	false	Boolean	false	If true, the loglevel will be shown.
showMethodName	false	Boolean	false	If true, the method name of the parent function will be shown in the console.
separator	false	String	' l '	The seperator between parts of the output ( see screenshot.
showArgumentInTable	false	Boolean	false	If true, argument are put in a table

Code example

import VueLogger from 'vuejs-logger';
const isProduction = process.env.NODE_ENV === 'production';
 
const options = {
    isEnabled: true,
    logLevel : isProduction ? 'error' : 'debug',
    stringifyArguments : false,
    showLogLevel : true,
    showMethodName : true,
    separator: '|',
    showConsoleColors: true
};

Vue.use(VueLogger, options);

new Vue({
    data() {
        return {
            a : 'a',
            b : 'b'
        }
    },
    created() {
        this.$log.debug('test', this.a, 123)
        this.$log.log('test', this.a, 123)
        this.$log.info('test', this.b)
        this.$log.warn('test')
        this.$log.error('test')
        externalFunction()
    }
});

function externalFunction() {
   // log from external function
   Vue.$log.debug('log from function outside component.');
}

Screenshot

Production tips

The plugin can be disabled for production or a lower logLevel can be set to minimize output (as shown in usage ).

    function foo() {
        // these statements will print nothing if the logLevel is set to 'error'. But they will compile just fine. 
        this.$log.debug('test', 'bar')
        this.$log.info('test')
        this.$log.warn('test')
        // this statement will print if the logLevel is set to 'error'
        this.$log.error('test', 'foo')
    }

Maintainers

@justinkames.

Contribute

Feel free to dive in! Open an issue or submit PRs.

vuejs-logger follows the Contributor Covenant Code of Conduct.

License

MIT © Justin Kames