@alu0101048239/addlogging v0.2.3

ESPREE LOGGING

Este módulo incluye el método addLogging, que permite crear un árbol de análisis sintáctico (AST) a partir de un código JavaScript de entrada, e insertar logs cada vez que se detecta una función. Para ello, se recorre el árbol y se comprueba si el tipo de nodo actual es FunctionDeclaration, FunctionExpression o ArrowFunctionExpression. Posteriormente, se llama a la función addBeforeCode, que inserta un console.log cada vez que detecta uno de estos tipos de nodo. En el console.log se incluye el nombre de la función, los parámetros que recibe y la línea en que se encuentra.

Instalation

npm install @alu0101048239/addlogging

Para instalar globalmente, ejecute el siguiente comando:

npm install -g @alu0101048239/addlogging

Usage

  const logging = require('index')
  addLogging = logging.addLogging
  
  let input = `function foo(a, b) {   
      var x = 'blah';   
      var y = (function () {
        return 3;
      })();
    }     
    foo(1, 'wut', 3);`;
  
  console.log(addLogging(input));

Para probar el ejecutable, si el módulo ha sido instalado localmente, escriba el siguiente comando:

    npx add-logging --output <outputFile> --pattern <pattern> <inputFile> 

Para mostrar la ayuda del programa, ejecutar el siguiente comando:

    npx add-logging --help

Contributing

Añada test unitarios en caso de añadir cualquier funcionalidad al módulo.

Los test se encuentran en el fichero tests/test.js

Para ejecutarlos, escriba el siguiente comando:

npm test

Documentation

El código estará comentado en formato JSDoc. Para generar la documentación, primero instalamos globalmente documentation:

npm install -g documentation

A continuación, generamos la documentación mediante el comando:

documentation build index.js logging-cli.js -f md -o docs/docs.md

El fichero de documentación será de tipo MarkDown. Para generar directamente la documentación, ejecutamos:

npm doc

License

MIT

Release History

* 0.1.0 Versión inicial
* 0.1.1 Arreglo del informe
* 0.2.0 Añadida opción --pattern
* 0.2.1 Corrección de errores
* 0.2.2 Corrección de errores
* 0.2.3 Corrección de errores