Práctica Espree logging

API

Table of Contents

• transpile
  • Parameters
• addLogging
  • Parameters
• addBeforeCode
  • Parameters

transpile

Parameters

• inputFile string path to input file
• outputFile string path to output file

addLogging

Parameters

• code string to log

Returns string logged code

addBeforeCode

Parameters

• node object of the AST

Ejecutable

El ejecutable bin/log.js puede ser utilizado de la siguiente forma:

Arguments:
  filename                 file with the original code

Options:
  -V, --version            output the version number
  -o, --output <filename>  file in which to write the output
  -h, --help               display help for command

Ejemplo de ejecución:

npx funlog test/data/test1.js -o output.txt

Instalación

Para instalar utilizar el siguiente comando:

npm i

Resumen de lo aprendido

Estructura de el arbol AST

Un nodo FunctionDeclaration tiene un una propiedad body, una propiedad params y una propiedad args y el body suele ser un BlockStatement cuyo body es un array. Dentro de ese array podemos meter otros nodos que queramos, capacidad que aplicamos para incluir un nodo CallStatement equivalente a console.log(...)

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);

Para ello se modificó la función addBeforeCode() para que incluya un binding params en el string de salida del console.log(). Dicho binding es un array de elementos String construido a partir de la propiedad params del nodo FunctionDeclaration.

CLI con Commander.js

Se importa commander y se obtiene el objeto program del mismo. Se invoca sobre ese objeto la configuración que queremos que tenga el ejecutable CLI. Luego invocamos su método program.parse(process.argv) para que procese la entrada de CLI y haga lo que lo hemos configurado para hacer.

• .option() para poder utilizar la opción -o
• .argument() para tener un argumento obligatorio.
• .version() recibe la versión del package.json
• .action() recibe un callback que tendrá tantos parámetros como argumento, salvo el último, que es un objeto options con los valores de cada opción.

Reto 1: Soportar funciones flecha

Lo que hacemos es utilizar estraverse.traverse(ast, {enter:(node, parents) => {...}}) para recorrer el árbol de sintaxis abstracto (AST) nodo por nodo. Si se detecta que el corresponde a una declaración de función se le agrega una nueva sentencia a la misma. Es ahí donde entra addBeforeCode() para agregar dicho nodo.

    (...)
    estraverse.traverse(ast, {
        enter: function(node, parent) {
            if (/* si nodo declaración de función */) {
                addBeforeCode(node);
            }
        }
    });
    (...)

El problema está en que las funciones flecha son de tipo ArrowFunctionDeclaration, y ese nodo no está originalmente en la función, por lo que se le agrega.

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

Espree permite obtener un objeto loc que contiene como propiedades start y end, los cuales tienen a su vez la propiedad line y column. Basta con utilizar loc.start.line en la función addBeforeCode():

(...)
var beforeCode = "console.log(`Entering " + name + `(${params})` +
      ` at line ${node.loc.start.line}\`);`;
(...)

Tras haber activado el objeto en la configuración de espree.parse():

const ast = espree.parse(code, {ecmaVersion: 6, loc: true /* activamos el objeto loc */});

Tests and Covering

Test results with mocha

Code coverage using nyc