espree-logging v0.3.0

Lab Espree logging

Resumen de lo aprendido

...

Opciones en línea de comandos (-o, -V, -h, etc.)

La implementación de estas opciones vienen dada gracias al módulo Commander. Un ejemplo de como añadirlas sería incluyendo el siguiente bloque al archivo:

program
  .version(version)  
  .option("-o, --output <filename>", 'file in which to write the output', "output.js")
  .option('-a, --ast <file>', 'file to output the AST in JSON format')
  .option('-j, --js <file>', 'file to output the resulting javascript')
  .argument("<filename>", 'file with the original code')
  .action((filename, options) => {
    transpile(filename, options.output);
  });

program.parse(process.argv);

Ejecutable

Muestra las opciones proporcionadas por CommanderJS.

Usage: log [options] <filename>

Arguments:
  filename                 file with the original code

Options:
  -V, --version            output the version number
  -o, --output <filename>  file in which to write the output (default: "output.js")
  -a, --ast <file>         file to output the AST in JSON format
  -j, --js <file>          file to output the resulting javascript
  -h, --help               display help for command

Scripts en package.json

Añadiendo el apartado scripts, es posible ejecutar:

npm run <script>

Sustituyendo 'script' por una palabra clave que representa un comando.

"scripts": {
  "test": "mocha",
  "cov": "nyc npm run test",
  "extracov": "c8 --reporter=html --reporter=text --report-dir docs npm run test",
  "clean": "rm -f /.abc"
}

Reto 1: Soportar funciones flecha

Para añadir la posibilidad de soportar funciones flecha, se añade un nuevo tipo de nodo 'ArrowFunctionExpression' en la comprobación de la función 'addLogging', quedando de la siguiente manera:

...
  if (node.type === 'FunctionDeclaration'||
      node.type === 'FunctionExpression' || 
      node.type === 'ArrowFunctionExpression') {
    addBeforeCode(node);
  }
...

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

Para poder incluir el número de línea a la llamada a console.log, se ha utilizado la propiedad:

  node.loc.start.line

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

Tests

El directorio 'test' contiene a su vez una serie de subdirectorios que contienen los componentes para llevar a cabo los tests:

1. Directorio 'tests': Archivos con código JavaScript. Usados como entrada.

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

2. Directorio 'correct-logged': Archivos con código JavaScript. Resultado esperado de transpilar el archivo de entrada.

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

3. Directorio 'output': Archivos con código JavaScript. Resultado de transpilar el archivo de entrada, con lo cual su contenido debería ser idéntico a los del directorio 'correct-logged'.

4. Directorio 'logged-out': Archivos de texto plano. Información mostrada por consola durante la ejecución de las funciones.

  Entering foo(1, wut) at line 1
  Entering <anonymous function>() at line 3

Coverage

Mediante la ejecución del comando 'npm run cov' se genera un estudio de cubrimiento.

Para generar el reporte HTML se debe ejecutar 'npm run extracov'

NPM

Tras la creación de una cuenta en la web de NPM, ejecutamos 'npm login' en nuestra consola. Una vez loggeado, debemos añadir una nueva línea en