@alu0101124896/addlogging


AddLogging
==========

Program that adds loggings whenever a js function has been entered

Installation

npm install @alu0101124896/addlogging

Usage

* JavaScript
``javascript
const addLogging = require('../src/index.js');

const inputProgram = function foo(x) { return x * x; };
const optionalFunctionNamePattern = 'fo';
const outputProgram = addLogging(inputProgram, optionalFunctionNamePattern);
`

* CLI
`bash
npx add-logging [options]

Options:
-d, --debug Outputs debugging information
-p, --pattern Only adds the logging to fuctions with a name that matches the pattern
-o, --output Redirects the output to the given filename
-v, --version Outputs the current module version
-h, --help Display help for command
`

Tests

`bash
npm test # To execute the unit tests made with mocha and chai.

npm run test-input # To execute the program with all the input test files.
npm run test-input-x # To execute the program with a specific input test file.

npm run test-output # To execute all the test files recieved as output from the program.
npm run test-output-x # To execute a specific test file recieved as output from the program.

npm run test-pattern # To execute the program with 'fo' as a function name pattern.
``

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

* 1.0.0 First release
* 1.1.0 Added pattern filter