{"_id":"@alu0101237053/espree-logging","_rev":"1-3e0041ce48a2cb3832adbe55de235fc9","name":"@alu0101237053/espree-logging","dist-tags":{"latest":"0.4.0"},"versions":{"0.3.0":{"name":"@alu0101237053/espree-logging","author":{"name":"Julio Emanuel Ruzicka Ruzicka"},"description":"Adds logs to javascript code","type":"module","bin":{"funlog":"bin/log.js"},"scripts":{"test":"mocha test/test.mjs","cov":"c8 npm test","docs":"npx c8 --reporter=html --reporter=text --report-dir docs mocha"},"dependencies":{"acorn":"^8.8.2","commander":"^10.0.0","escodegen":"^2.0.0","espree":"^9.4.1","estraverse":"^5.2.0","underscore":"^1.12.0"},"version":"0.3.0","devDependencies":{"mocha":"^10.2.0"},"gitHead":"44dd37462018280f81d9376b294871be5bb2ba9c","_id":"@alu0101237053/espree-logging@0.3.0","_nodeVersion":"16.14.2","_npmVersion":"8.5.0","dist":{"integrity":"sha512-/U+5U2CzofSJ4/1t9GPgoZLu8HmbPlt6L5pDuKDCI0SCMMcTJNjUNptN9AnObL0PbpXLZPXpMDYKHfdkkq6n6Q==","shasum":"a6cf7003386c12d63e84edbc46244e6ff3807c4b","tarball":"https://registry.npmjs.org/@alu0101237053/espree-logging/-/espree-logging-0.3.0.tgz","fileCount":53,"unpackedSize":3076136,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIGH2L+4tVjd1zadNFKHeDEMF91RWfaAOhXKxDOd4E5f7AiBfuAFAuItOYTijkIoeUAI3sNT1tZEDzIQ24hHAPLHalw=="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJkAV9CACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmrMLw//RHNxy3ukqtNseK3Kwzp40PEOhaCuRtvqnOVFGL19GcymE+aV\r\nG/fslxa9VVMkPUfY9ilunCTywxPchXwgAJBVpd1KbsL1bp8Low7Jb7AspXmf\r\nW8uFC6PkFkX2w2DlHhqovNUZDfllFX6lcah/7J7WsvkT5MW1QRYRCclOztG2\r\nOU3Ocoi9mugPqyiWiSdfmalHAQmJqMI+FX8n4VLjgIT+ai6joERelY+MnS99\r\nz+e7bIv/7XPmT9xMPRUZTzsmwG0zUdUjFMOK9rkvtVk2kQt4XX0JY3YwyoQP\r\niTjUQ+4vRs3RUrXMVSKxKjVu8yJA/hdpxEx02ryg1f9UX5pplYug08vWsj4D\r\nNheoiz5ef1RXAoqT378XCtG0uZ1spD1b/ufgKfs1RvXAGjhEOBVkW6HpaWHR\r\nVPsOtEjO/2aEq3sSfXFXMdMdxGROtQsTkTVNTTBone5i1EjR2QSHN32/Pdtn\r\nZCU9Yjt4ewNlzZbqWv0QM6+M49xM3/jzjxo+bufOYYJskgqtlb1ipvIEq3hQ\r\nRSo8tXBINcmxbwB478NYs01mf3Uv/ZeO67hD6OJRmCxwfk0NonPsU+C2tJ8m\r\nJqp4EcvgNv9yUfZFLDaGwh7MlsLHN+kpjCyHJkEtZY848a46LOLRYn/yCiQZ\r\nrpJxykqe9gWI1qqnc3JDga0YDaQFzp44yII=\r\n=jvP8\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"alu0101237053","email":"alu0101237053@ull.edu.es"},"directories":{},"maintainers":[{"name":"alu0101237053","email":"alu0101237053@ull.edu.es"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/espree-logging_0.3.0_1677811522583_0.31561086650231984"},"_hasShrinkwrap":false},"0.4.0":{"name":"@alu0101237053/espree-logging","author":{"name":"Julio Emanuel Ruzicka Ruzicka"},"description":"Adds logs to javascript code","type":"module","bin":{"funlog":"bin/log.js"},"scripts":{"test":"mocha test/test.mjs","cov":"c8 npm test","docs":"npx c8 --reporter=html --reporter=text --report-dir docs mocha"},"dependencies":{"acorn":"^8.8.2","commander":"^10.0.0","escodegen":"^2.0.0","espree":"^9.4.1","estraverse":"^5.2.0","underscore":"^1.12.0"},"version":"0.4.0","devDependencies":{"mocha":"^10.2.0"},"gitHead":"85dc5ea5778bdddd1b36e0dc182264c96eb62300","_id":"@alu0101237053/espree-logging@0.4.0","_nodeVersion":"16.14.2","_npmVersion":"8.5.0","dist":{"integrity":"sha512-V0QLkGCCgKUO+USNuQBASiI8QcvXaE0R3EhjTKpKXm31lZJ9UKWcBQRM56YHEQyZB94t7UeuZvgqLATecnvN1w==","shasum":"b2015ecc18f8569ffae73f0a2df9f75794029f84","tarball":"https://registry.npmjs.org/@alu0101237053/espree-logging/-/espree-logging-0.4.0.tgz","fileCount":53,"unpackedSize":3079588,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCg2aZNckgSV62MpAPZlRq31qi2k0cTZsgWNHdreBjU7AIgL4Pf1d7N0bQvB14Jdee7GYl4DYjL2OZ1o78k25SjepI="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJkAWCtACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmrBhxAAj9CtlGJ0wCpa3xz5KSWq2kt2y94MfQErJoeoTqWgYaBgJQMX\r\nJ6xcM1iPmxXZqwD00/5VIPk8ryI7XLkkWE6TaUBltCxk/aqTjhTo34lioqiF\r\nBxCqtNsRPa/AMFwfiYAUqBNswcaV4hAoQ60TpkSv32y/AulOedqL0QjbFdvu\r\n3CE3joCXjzrmrx1hphqWiI+qiP8owRM1xIOO6OOIbX2MW05LoH/z3zoOO8Gn\r\ngF5t6azixtkL2srKh0nHfCSTquDeRHKYsILvFahDiGw+biG/nGXjkYIpEaUH\r\n/FvYs/H3/CWYc6k/X1rxn50Z8rdPtXuP9hDv7ChMLCP+h3n+g6v0mMq+dwy4\r\nIqszZ4LBQcTY+XfH4V3j9VFWw1QNzV28imHSkAlY4MDOD4iLbJmUnn06fZTB\r\nptOe4T1xj6VMYpgIaji7NwW8Z6OrI3Iv5ZVUFj4RSuaHoxyBDt2HH1Z8Moos\r\n2ZpQZCK8+ZYt6PU0sU9i55/bIZvicZmBAU0CPO3zmyVutQS+7skkxV7ll6CD\r\nLi8QmKb3QOkCtuFfxFiR+dxAnNINrecyAFNspiXQFXXunoz26IOTa8vhgOzs\r\nVyr75h0RmL1o4LPArVuPcY0cr3+UW4avRjTl3+LaEOF2jnVkTTxkJzsSU3Ky\r\nNj0mqMD/xgP+LxuvrUCL253IcdMGkWL2nIc=\r\n=HKbF\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"alu0101237053","email":"alu0101237053@ull.edu.es"},"directories":{},"maintainers":[{"name":"alu0101237053","email":"alu0101237053@ull.edu.es"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/espree-logging_0.4.0_1677811885113_0.9886907941227709"},"_hasShrinkwrap":false}},"time":{"created":"2023-03-03T02:45:22.475Z","0.3.0":"2023-03-03T02:45:22.838Z","modified":"2023-03-03T02:51:25.498Z","0.4.0":"2023-03-03T02:51:25.387Z"},"maintainers":[{"name":"alu0101237053","email":"alu0101237053@ull.edu.es"}],"description":"Adds logs to javascript code","author":{"name":"Julio Emanuel Ruzicka Ruzicka"},"readme":"[![Open in Codespaces](https://classroom.github.com/assets/launch-codespace-f4981d0f882b2a3f0472912d15f9806d57e124e0fc890972558857b51b24a6f9.svg)](https://classroom.github.com/open-in-codespaces?assignment_repo_id=10325734)\r\n# Práctica Espree logging\r\n\r\n## Resumen de lo aprendido\r\nPrincipalmente 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. \r\n\r\nAdemá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.\r\n\r\nFinalmente, 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.\r\n\r\n## Indicar los valores de los argumentos\r\n\r\nSe 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. \r\nEjemplo:\r\n\r\n```javascript\r\nfunction foo(a, b) {\r\n  var x = 'blah';\r\n  var y = (function (z) {\r\n    return z+3;\r\n  })(2);\r\n}\r\nfoo(1, 'wut', 3);\r\n```\r\n\r\n```javascript\r\nfunction foo(a, b) {\r\n    console.log(`Entering foo(${ a }, ${ b })`);\r\n    var x = 'blah';\r\n    var y = function (z) {\r\n        console.log(`Entering <anonymous function>(${ z })`);\r\n        return z + 3;\r\n    }(2);\r\n}\r\nfoo(1, 'wut', 3);\r\n```\r\n\r\n## CLI con [Commander.js](https://www.npmjs.com/package/commander)\r\nCon esta herramienta podemos hacer que la entrada por linea de comandos sea más sencilla. Para este caso, tenemos vaios parámetros\r\nque le podemos indicar al programa:\\\r\n filename Indica el archivo que queremos pasar al spreen logger\\\r\n --ouput  Indica en que fichero acabara la salida\\\r\n --help   Parametro para ver los tipos de parámetros que acepta el programa\\\r\n```js\r\nprogram\r\n  .version(version)\r\n  .argument(\"<filename>\", 'file with the original code')\r\n  .option(\"-o, --output <filename>\", \"file in which to write the output\")\r\n  .action((filename, options) => {\r\n    transpile(filename, options.output);\r\n  });\r\nprogram.parse(process.argv);\r\n```\r\n## Reto 1: Soportar funciones flecha\r\nPara detectar los distintos tipos de funciones hemos implementado el siguiente código dentro de la función `addLogging()`\r\n```js\r\nconst functionTypes = ['FunctionDeclaration', 'ArrowFunctionExpression', 'FunctionExpression'];\r\n. . .\r\nenter(node) {\r\n  functionTypes.includes(node.type) ? addBeforeCode(node) : null;\r\n}\r\n```\r\n## Reto 2: Añadir el número de línea\r\nPara 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.\r\n```js\r\n const line = node.loc.start.line;\r\n```\r\n\r\n## Tests and Covering\r\nSe han realizado 10 tipos de tests, en los que podemos ver distintos tipos de salida segun el tipo de función.\r\n![Tests](https://i.ibb.co/GkZWrfC/imagen-2023-03-03-020417632.png)\r\n\r\nAlgunos ejemplos:\r\nTest5:\r\n```js\r\nfunction outerFunction(a) {\r\n    console.log(`Entering outerFunction(${ a }) at line 1\\n`);\r\n    function innerFunction(b) {\r\n        console.log(`Entering innerFunction(${ b }) at line 2\\n`);\r\n        return a + b;\r\n    }\r\n    return innerFunction(3);\r\n}\r\nouterFunction(2);\r\n```\r\nTest6:\r\n```js\r\nconst calculateSumOfMultiples = (a, b, n) => {\r\n    console.log(`Entering <anonymous function>(${ a }, ${ b }, ${ n }) at line 1\\n`);\r\n    let sum = 0;\r\n    for (let i = 1; i <= n; i++) {\r\n        if (isMultiple(i, a) || isMultiple(i, b)) {\r\n            sum += i;\r\n        }\r\n    }\r\n    console.log(`Sum of multiples of ${ a } and ${ b } up to ${ n } is ${ sum }`);\r\n    return sum;\r\n};\r\nfunction isMultiple(number, multipleOf) {\r\n    console.log(`Entering isMultiple(${ number }, ${ multipleOf }) at line 12\\n`);\r\n    return number % multipleOf === 0;\r\n}\r\ncalculateSumOfMultiples(3, 5, 10);\r\n```\r\nTambién hemos hecho lo necesario para hacer el covering durante el dersarrollo:\r\n![Covering](https://i.ibb.co/FV45qXF/imagen-2023-03-03-020808345.png)\r\n\r\n## Scripts\r\nPuede ejecutar los siguientes scrips:\r\n```js\r\n$npm run cov\r\n$npm run test\r\n$npm run docs\r\n```\r\n\r\n","readmeFilename":"README.md"}