Práctica Espree logging

Resumen de lo aprendido

Principalmente nos hemos apoyado en el uso de la libraria espree, hemos adquirido habilidades importantes en el uso de Estraverse para recorrer los nodos del árbol de análisis sintáctico, modificanco el árbol generado, los nodos y en sí el propio código también con una pequeña funcionalidad de escribir un 'console.log' seguidamente de la llamada a 3tipos de funciones indicando la línea y los argumentos que se le pasan.

Además, hemos aprendido cómo publicar un paquete en npm, lo que nos permite compartir nuestro código con otros desarrolladores de todo el mundo.

Finalmente, hemos repasado herramientas de desarrollo fundamentales para mejorar nuestra eficiencia, como los tests, el cubrimiento de código y la integración continua. También hemos explorado cómo estas herramientas pueden ayudarnos a detectar errores y mejorar la calidad del código que producimos.

Indicar los valores de los argumentos

Se ha modificado el código de logging-espree.js para que el log también indique los valores de los argumentos que se pasaron a la función. Ejemplo:

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

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

CLI con Commander.js

Con esta herramienta podemos hacer que la entrada por linea de comandos sea más sencilla. Para este caso, tenemos vaios parámetros que le podemos indicar al programa:
filename Indica el archivo que queremos pasar al spreen logger
--ouput Indica en que fichero acabara la salida
--help Parametro para ver los tipos de parámetros que acepta el programa\

program
  .version(version)
  .argument("<filename>", 'file with the original code')
  .option("-o, --output <filename>", "file in which to write the output")
  .action((filename, options) => {
    transpile(filename, options.output);
  });
program.parse(process.argv);

Reto 1: Soportar funciones flecha

Para detectar los distintos tipos de funciones hemos implementado el siguiente código dentro de la función addLogging()

const functionTypes = ['FunctionDeclaration', 'ArrowFunctionExpression', 'FunctionExpression'];
. . .
enter(node) {
  functionTypes.includes(node.type) ? addBeforeCode(node) : null;
}

Reto 2: Añadir el número de línea

Para esta característica hemos aprovechado la información que nos viene del propio nodo, desde allí podemos acceder a la línea y si tiene argumentos o no, el tipo de argumentos etc.

 const line = node.loc.start.line;

Tests and Covering

Se han realizado 10 tipos de tests, en los que podemos ver distintos tipos de salida segun el tipo de función.

Algunos ejemplos: Test5:

function outerFunction(a) {
    console.log(`Entering outerFunction(${ a }) at line 1\n`);
    function innerFunction(b) {
        console.log(`Entering innerFunction(${ b }) at line 2\n`);
        return a + b;
    }
    return innerFunction(3);
}
outerFunction(2);

Test6:

const calculateSumOfMultiples = (a, b, n) => {
    console.log(`Entering <anonymous function>(${ a }, ${ b }, ${ n }) at line 1\n`);
    let sum = 0;
    for (let i = 1; i <= n; i++) {
        if (isMultiple(i, a) || isMultiple(i, b)) {
            sum += i;
        }
    }
    console.log(`Sum of multiples of ${ a } and ${ b } up to ${ n } is ${ sum }`);
    return sum;
};
function isMultiple(number, multipleOf) {
    console.log(`Entering isMultiple(${ number }, ${ multipleOf }) at line 12\n`);
    return number % multipleOf === 0;
}
calculateSumOfMultiples(3, 5, 10);

También hemos hecho lo necesario para hacer el covering durante el dersarrollo:

Scripts

Puede ejecutar los siguientes scrips:

$npm run cov
$npm run test
$npm run docs