Espree Logging

Un módulo que proporciona un método que añade un mensaje mostrando el identificador de la función a la que se está accediendo mediante la manipulación del AST generado
a partir de un código de entrada. Además, se le ha implementado dos mejoras: mostrar información de los parámetros que recibe la función y mostrar la línea en la que se
realiza dicha llamada.

Instalación

npm install @alu0101014319/addlogging

Para instalar globalmente:

npm install -g @alu0101014319/addlogging

Ejecutable

El ejecutable del código se encuentra en el fichero _cli.js_. Para hacer uso de él, una vez se haya instalado el módulo, simplemente se debe ejecutar el siguiente comando:

npx add-logging --pattern 'functionNamePattern' --outFile salida.js input.js

Por el contrario, si está instalado globalmente, solo haría falta el siguiente comando:

add-logging --pattern 'functionNamePattern' --outFile salida.js input.js

Uso

Uso básico:
``js
const addLogging = require('./index.js');

let input =
function foo(a, b) {
var x = 'blah';
var y = function () {
return 3;
};
}
foo(1, 'wut', 3);;

let output = addLogging(input);

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

Uso del functionNamePattern:
`js
const addLogging = require('./index.js');

let input =
function foo(a, b) {
var x = 'blah';
var y = function chuchu() {
return 3;
};
}
foo(1, 'wut', 3);;

let pattern = 'foo';
let output = addLogging(input, pattern);

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

Contribuir

Para añadir nuevas funcionalidades, se ruega que se mantenga el mismo estilo de codificación.
Si se modifican o se agregan funcionalidades, genere las pruebas unitarias correspondientes
para comprobar el buen funcionamiento de estas.

Licencia

La licencia para este módulo se puede consultar en el siguiente archivo: MIT LICENSE

Documentación

Para documentar el módulo usamos el formato _Jsdoc_:

documentation build index.js -f md -o docs.md

O también mediante el comando:

npm run doc

Para instalarlo: npm install -g documentation

Historial de lanzamientos

- 0.1.0 Versión inicial
- 0.1.1 Corrección de información
- 0.1.2 Corrección de información
- 0.2.0 Adición de la funcionalidad functionNamePattern
- 0.2.1 Corrección de errores
- 0.2.2 Corrección de información