@adrianepi/addlogging

Espree

A small library providing utility methods to addLogging functions. This searchs and prints information about the functions in the input code.

Installation

npm install @adrianepi/addlogging --save

Usage

    var addLogger = require('@adrianepi/addlogging')
        addLogging = addLogger.addLogging,
        addLoggingPattern = addLogger.addLoggingPattern;

    var inputCode = `
        function foo(a, b) {   
          var x = 'blah';   
          var y = (function () {
              return 3;
          })();
        }     
        foo(1, 'wut', 3);
        `;
    
    // Function call without pattern
    console.log('\nOriginal funcion\n', inputCode, '\nAdded function details: \n', addLogging(inputCode));

    // Function call with pattern
    var myPattern = "foo";
    console.log('\nOriginal funcion\n', inputCode, '\nAdded function details: \n', addLoggingPattern(inputCode, myPattern));

Tests

npm test

Use example

This program can be used just especifying the input, that will search all the functions in the input and print by console the extra information about the functions that has founded.

npx addLogging ./inputs/inputTest.js

Execution:

Pattern:  undefined
input:
function foo(a, b) {
    var x = 'blah';
    var y = (function () {
        return 3;
    })();
}
foo(1, 'wut', 3);
Output in file './outputs/output.js'

This program can also be used specifing the output and without especifying any search pattern, that will search all the functions in the input and the program will run for all the founded functions. The output instead of been printed by console as before, now will be saves in the output file.

npx addLogging ./inputs/inputTest.js -o ./outputs/output.js

Output:

function foo(a, b) {
    console.log(' Entering foo(${a},${b}) at line 1');
    var x = 'blah';
    var y = function () {
        console.log(' Entering <anonymous function>() at line 3');
        return 3;
    }();
} 
foo(1, 'wut', 3);

Also there's a search pattern flag than can be easily used, this will make the program to just print the information about the functions that containts teh search pattern.

npx addLogging ./inputs/inputTest.js -o ./outputs/output.js -p foo

Output:

function foo(a, b) {
    console.log(' Entering foo(${a},${b}) at line 1');
    var x = 'blah';
    var y = function () {
        return 3;
    }();
}
foo(1, 'wut', 3);

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code.

Release History

• 0.1.0 Initial release
• 1.0.3 Functional release
• 2.0.3 Improved documentation
• 2.0.4 Finished version