merge

Author: CiroMirkin

README.md

@@ -5,66 +5,66 @@ Escribo un apunte por mes mientras estudio.
 Con estos apuntes no busco compartir un conocimiento profundo, sino, busco compartir una idea clara sobre un tema, para que cada uno pueda profundizar en los temas que le llaman la atención.
 <!--lista_apuntes-->
 ## Lista de apuntes
+- [Algoritmos](apuntes/Algoritmos.md)
 - [Acoplamiento entre componentes](apuntes/Acoplamiento%20entre%20componentes.md)
 - [Análisis orientado a objetos (AOO)](apuntes/Analisis%20orientado%20a%20objetos%20(AOO).md)
 - [Arquitectura](apuntes/Arquitectura.md)
-- [Cohesión en componentes](apuntes/Cohesion%20en%20componentes.md)
-- [Algoritmos](apuntes/Algoritmos.md)
 - [Arreglos](apuntes/Arreglos.md)
-- [Cohesión y acoplamiento](apuntes/Cohesion%20y%20acoplamiento.md)
 - [Base de datos](apuntes/Base%20de%20datos.md)
+- [Cohesión en componentes](apuntes/Cohesion%20en%20componentes.md)
+- [Cohesión y acoplamiento](apuntes/Cohesion%20y%20acoplamiento.md)
 - [Complejidad ciclomática (CC)](apuntes/Complejidad%20ciclomatica%20(CC).md)
 - [Complejidad](apuntes/Complejidad.md)
-- [Desarrollo guiado por comportamiento (BDD)](apuntes/Desarrollo%20guiado%20por%20comportamiento%20(BDD).md)
 - [Desarrollo ágil](apuntes/Desarrollo%20agil.md)
+- [Desarrollo guiado por comportamiento (BDD)](apuntes/Desarrollo%20guiado%20por%20comportamiento%20(BDD).md)
 - [Desarrollo guiado por pruebas](apuntes/Desarrollo%20guiado%20por%20pruevas%20(TDD).md)
-- [Diagrama de contexto de sistema](apuntes/Diagrama%20de%20contexto%20de%20sistema.md)
 - [Diagrama de secuencia básico](apuntes/Diagrama%20de%20secuencia%20basico.md)
 - [Diseño por contrato](apuntes/Disenno%20por%20contrato.md)
 - [Documentación](apuntes/Documentacion.md)
 - [Diseño orientado a objetos (DOO)](apuntes/Disenno%20orientado%20a%20objetos%20(DOO).md)
+- [Documentos de diseño y documento de producto](apuntes/Documentos%20de%20disenno%20y%20documento%20de%20producto.md)
 - [Dominio y negocio](apuntes/Dominio%20y%20negocio.md)
 - [Estado y su gestión](apuntes/Estado%20y%20su%20gestion.md)
-- [Documentos de diseño y documento de producto](apuntes/Documentos%20de%20disenno%20y%20documento%20de%20producto.md)
 - [Estructuras de datos](apuntes/Estructuras%20de%20datos.md)
+- [Evita la herencia](apuntes/Evita%20la%20herencia.md)
 - [Funciones](apuntes/Funciones.md)
 - [GRASP](apuntes/GRASP.md)
 - [Historias de usuario](apuntes/Historias%20de%20usuario.md)
-- [Evita la herencia](apuntes/Evita%20la%20herencia.md)
 - [La ley de demeter](apuntes/La%20ley%20de%20demeter.md)
-- [Leyes en la evolución de aplicaciones](apuntes/Leyes_en_la_evolucion_de_aplicaciones.md)
-- [Más fácil de cambiar (ETC)](apuntes/Mas%20facil%20de%20cambiar%20(STR).md)
 - [Método de trabajo Kanban](apuntes/Metodo%20de%20trabajo%20Kanban.md)
 - [Método de priorización MoSCoW](apuntes/Metodo_de_priorizacion_MoSCoW.md)
 - [Modelo de arquitectura C4](apuntes/Modelo_de_arquitectura_C4.md)
 - [Modelo Kano](apuntes/Modelo_kano.md)
+- [No me hagas pensar ni me des sorpresas](apuntes/No%20me%20hagas%20pensar%20ni%20me%20des%20sorpresas.md)
 - [Niveles de abstracción](apuntes/Niveles%20de%20abstraccion.md)
 - [No te repitas (DRY)](apuntes/No%20te%20repitas%20(DRY).md)
-- [No me hagas pensar ni me des sorpresas](apuntes/No%20me%20hagas%20pensar%20ni%20me%20des%20sorpresas.md)
 - [No vas a necesitarlo (YANGI)](apuntes/No%20vas%20a%20necesitarlo%20(YANGI).md)
 - [Normalización](apuntes/Normalizacion.md)
-- [Notación Big O](apuntes/Notacion%20Big%20O.md)
 - [Ortogonalidad](apuntes/Ortogonalidad.md)
+- [Notación Big O](apuntes/Notacion%20Big%20O.md)
+- [Paradigmas de programación](apuntes/Paradigmas%20de%20programacion.md)
 - [Patrón MVC (Modelo, Vista y Controlador)](apuntes/Patron%20MVC%20(Modelo,%20vista%20y%20controlador).md)
 - [Patrón del objeto modesto](apuntes/Patron%20del%20objeto%20modesto.md)
-- [Paradigmas de programación](apuntes/Paradigmas%20de%20programacion.md)
 - [Patrón entidad-control-limite](apuntes/Patron%20entidad-control-limite.md)
-- [Patrones de diseño creacionales](apuntes/Patrones%20de%20diseño%20creacionales.md)
 - [Patrón repositorio](apuntes/Patron_repositorio.md)
-- [Principios SOLID](apuntes/Principios%20SOLID.md)
+- [Patrones de diseño creacionales](apuntes/Patrones%20de%20diseño%20creacionales.md)
+- [Principio KISS](apuntes/Principio%20KISS.md)
 - [Programa una interfaz antes que una implementación](apuntes/Programa%20una%20interfaz%20antes%20que%20una%20implementacion.md)
+- [Principios SOLID](apuntes/Principios%20SOLID.md)
 - [Programación básica](apuntes/Programacion%20basica.md)
-- [Pruebas unitarias](apuntes/Pruevas%20unitarias.md)
 - [Programación orientada a objetos (POO)](apuntes/Programacion%20orientada%20a%20objetos%20(POO).md)
-- [TDD y BDD diferencias](apuntes/TDD%20y%20BDD%20diferencias.md)
-- [Principio KISS](apuntes/Principio%20KISS.md)
+- [Pruebas unitarias](apuntes/Pruevas%20unitarias.md)
 - [Refactorización](apuntes/Refactorizacion.md)
-- [Tell don´t ask](apuntes/Tell%20dont%20ask.md)
 - [Sincronía y asincronía](apuntes/Sincronia%20y%20asincronia.md)
+- [TDD y BDD diferencias](apuntes/TDD%20y%20BDD%20diferencias.md)
+- [Tell don´t ask](apuntes/Tell%20dont%20ask.md)
 - [Teoría de conjuntos](apuntes/Teoria%20de%20conjuntos.md)
-- [Testing](apuntes/Testing.md)
 - [Tipos de relaciones entre clases](apuntes/Tipos%20de%20relaciones%20entre%20clases.md)
+- [Testing](apuntes/Testing.md)
 - [Tipos](apuntes/Tipos.md)
-- [Arquitectura por capas](apuntes/arquitectura%20por%20capas.md)
 - [Value object](apuntes/Value_object.md)
+- [Arquitectura por capas](apuntes/arquitectura%20por%20capas.md)
+- [Más fácil de cambiar (ETC)](apuntes/Mas%20facil%20de%20cambiar%20(STR).md)
+- [Diagrama de contexto de sistema](apuntes/Diagrama%20de%20contexto%20de%20sistema.md)
+- [Leyes en la evolución de aplicaciones](apuntes/Leyes_en_la_evolucion_de_aplicaciones.md)
 <!--lista_apuntes-->

generarListaDeApuntes.js

@@ -4,6 +4,7 @@ const fs = require('fs');
 
 const RELATIVE_PATH_OF_NOTES_FOLDER = 'apuntes/'
 
+// Gets the list of the notes inside the 'apuntes/' folder
 fs.readdir(RELATIVE_PATH_OF_NOTES_FOLDER, (err, listOfNoteFiles) => {
     if (err) {
         console.error('Error al leer directorio ', err)
@@ -13,9 +14,12 @@ fs.readdir(RELATIVE_PATH_OF_NOTES_FOLDER, (err, listOfNoteFiles) => {
     console.table(listOfNoteFiles);
 
     const notes = []
+    
+    listOfNoteFiles.sort()
     listOfNoteFiles.forEach((nameOfNoteFile, index) => {
         const RELATIVE_PATH_OF_NOTE_FILE = `${RELATIVE_PATH_OF_NOTES_FOLDER}${nameOfNoteFile}`;
 
+        // Gets the content of each note
         fs.readFile(RELATIVE_PATH_OF_NOTE_FILE, 'utf-8', (err, noteContent) => {
             if (err) {
                 console.error('Error al leer apunte (note) ', err);
@@ -32,6 +36,7 @@ fs.readdir(RELATIVE_PATH_OF_NOTES_FOLDER, (err, listOfNoteFiles) => {
 
                 let noteYear = noteContentPerLine[1].split('_').at(-1)
 
+                // We only use the title and RELATIVE_PATH attributes, but we may use the rest in the future
                 const note = {
                     title: noteTitle,
                     formattedDate,
@@ -44,13 +49,15 @@ fs.readdir(RELATIVE_PATH_OF_NOTES_FOLDER, (err, listOfNoteFiles) => {
 
                 notes.push(`- [${note.title}](${note.RELATIVE_PATH.split(' ').join('%20')})`)
 
+                // Checks if all the notes are in notes array
                 const isThisTheLastNote = (listOfNoteFiles.length - 1) === index;
                 if (isThisTheLastNote) {
-                    // Now the whole notes are in notes array
+                    // Modify the README.md file to include the list of notes
                     fs.readFile('README.md', 'utf-8', (err, readmeContent) => {
                         if (err) {
                             return console.error('Error al leer apunte (note) ', err);
                         } 
+                        
                         const readmeContentWithoutNoteList = readmeContent.split('<!--lista_apuntes-->')[0]
                         const content = `${readmeContentWithoutNoteList}<!--lista_apuntes-->\n## Lista de apuntes\n${notes.join('\n')}\n<!--lista_apuntes-->`
                         fs.writeFile('README.md', content, (err) => {