@alu0101056944/addlogging v3.0.3

Addlogging module

A small library for quickly logging function flow. Includes:

• function addLogging(code, pattern) that adds console.log calls on all function implementations whose name match the pattern.
• add-logging executable

Installation

npm install @alu0101056944/addlogging

Usage

Running the executable:

    add-logging --pattern 'functionNamePattern' --output <outputpath> <inputpath>

• functionNamePattern: Regular expression that the function name needs to match to be logged
• outputpath: path to the file where the logged code will be stored
• inputpath: path to the file with the original code

It first uses espree code parser to get a AST Tree of the code. Then, calling estraverse's traverse function,it surfs through every node checking its type. If its any function type we produce another AST Tree from the log message and then concatenate it to the function node's body.

API

Table of Contents

• logging.js
• addLogging
  • Parameters

Main file of the module. It's exports object includes everything when require(...) is called.

Meta

• author: Marcos Barrios Lorenzo
• license: ISC

logging.js

Contains functions for logging code.

Meta

• author: Marcos Barrios Lorenzo
• license: ISC

addLogging

Add console.log(...) calls to function definitions in given code. First processes the code. Result is the same code but including console.log(...) calls as first sentence inside every function definition whose name matches the given pattern, which is a regular expression.

Parameters

• code string Properly formatted string with code
• pattern string Regular Expression to match function names with

Returns string input code but with added console.log(...) calls

Tests

    npm test

License

The scripts and documentation in this project are released under the ISC LICENSE