Markdown Links

Índice

• 1. Sobre MD-Links
• 2. Objetivos de aprendizaje
• 3. Diagramas de flujo
• 4. Instrucciones de Uso
• 5. Checklist
• 6. Autor

1. Sobre MD-Links

Markdown es un lenguaje de marcado ligero muy popular entre developers. Es usado en muchísimas plataformas que manejan texto plano (GitHub, foros, blogs, ...) y es muy común encontrar varios archivos en ese formato en cualquier tipo de repositorio (empezando por el tradicional README.md).

Estos archivos Markdown normalmente contienen links (vínculos/ligas) que muchas veces están rotos o ya no son válidos y eso perjudica mucho el valor de la información que se quiere compartir.

Dentro de una comunidad de código abierto, nos han propuesto crear una herramienta usando Node.js, que lea y analice archivos en formato Markdown, para verificar los links que contengan y reportar algunas estadísticas.

2. Objetivos de aprendizaje

Reflexiona y luego marca los objetivos que has llegado a entender y aplicar en tu proyecto. Piensa en eso al decidir tu estrategia de trabajo.

JavaScript

• [x] Diferenciar entre tipos de datos primitivos y no primitivos

• [x] Arrays (arreglos)

  • Arreglos
  • Array - MDN
  • Array.prototype.sort() - MDN
  • Array.prototype.forEach() - MDN
  • Array.prototype.map() - MDN
  • Array.prototype.filter() - MDN
  • Array.prototype.reduce() - MDN

• [x] Objetos (key, value)

  • Objetos en JavaScript

• [x] Uso de condicionales (if-else, switch, operador ternario, lógica booleana)

  • Estructuras condicionales y repetitivas
  • Tomando decisiones en tu código — condicionales - MDN

• [x] Funciones (params, args, return)

  • Funciones (control de flujo)
  • Funciones clásicas
  • Arrow Functions
  • Funciones — bloques de código reutilizables - MDN

• [x] Recursión o recursividad

  • Píldora recursión - YouTube Laboratoria Developers
  • Recursión o Recursividad - Laboratoria Developers en Medium

• [x] Módulos de CommonJS

  • Modules: CommonJS modules - Node.js Docs

• [x] Diferenciar entre expresiones (expressions) y sentencias (statements)

• [x] Callbacks

  • Función Callback - MDN

• [x] Promesas

  • Promise - MDN
  • How to Write a JavaScript Promise - freecodecamp (en inglés)

• [x] Pruebas unitarias (unit tests)

  • Empezando con Jest - Documentación oficial

• [x] Pruebas asíncronas

  • Tests de código asincrónico con Jest - Documentación oficial

• [x] Uso de mocks y espías

  • Manual Mocks con Jest - Documentación oficial

• [x] Pruebas de compatibilidad en múltiples entornos de ejecución

• [x] Uso de linter (ESLINT)

• [x] Uso de identificadores descriptivos (Nomenclatura y Semántica)

Node.js

• [x] Instalar y usar módulos con npm

  • Sitio oficial de npm (en inglés)

• [x] Configuración de package.json

  • package.json - Documentación oficial (en inglés)

• [x] Configuración de npm-scripts

  • scripts - Documentación oficial (en inglés)

• [x] process (env, argv, stdin-stdout-stderr, exit-code)

  • Process - Documentación oficial (en inglés)

• [x] File system (fs, path)

  • File system - Documentación oficial (en inglés)
  • Path - Documentación oficial (en inglés)

Control de Versiones (Git y GitHub)

• [x] Git: Instalación y configuración

• [x] Git: Control de versiones con git (init, clone, add, commit, status, push, pull, remote)

• [x] Git: Integración de cambios entre ramas (branch, checkout, fetch, merge, reset, rebase, tag)

• [x] GitHub: Creación de cuenta y repos, configuración de llaves SSH

• [x] GitHub: Colaboración en Github (branches | forks | pull requests | code review | tags)

• [x] GitHub: Organización en Github (projects | issues | labels | milestones | releases)

HTTP

• [x] Consulta o petición (request) y respuesta (response).

  • Generalidades del protocolo HTTP - MDN
  • Mensajes HTTP - MDN

• [x] Códigos de status de HTTP

  • Códigos de estado de respuesta HTTP - MDN
  • The Complete Guide to Status Codes for Meaningful ReST APIs - dev.to

3. Diagramas de flujo

• Diagrama MD-Links

• Diagrama CLI

4. Instrucciones de Uso

Instalación de MD-Links

npm i md-links-andreaflo

Implementación

Para solicitar ayuda:

md-links <path> --help

Para solicitar el estado de los links:

md-links <path> --validate

Para solicitar el total de links exitosos y unicos:

md-links <path> --stats

Para solicitar el total de links exitosos, unicos y rotos:

md-links <path> --validate --stats

5. Checklist

General

• [x] Puede instalarse via npm install --global <github-user>/md-links

README.md

• [x] Un board con el backlog para la implementación de la librería.
• [x] Documentación técnica de la librería.
• [x] Guía de uso e instalación de la librería

API mdLinks(path, opts)

• [x] El módulo exporta una función con la interfaz (API) esperada.
• [x] Implementa soporte para archivo individual
• [x] Implementa soporte para directorios
• [x] Implementa options.validate

CLI

• [x] Expone ejecutable md-links en el path (configurado en package.json)
• [x] Se ejecuta sin errores / output esperado
• [x] Implementa --validate
• [x] Implementa --stats

Pruebas / tests

• [x] Pruebas unitarias cubren un mínimo del 70% de statements, functions, lines, y branches.
• [x] Pasa tests (y linters) (npm test).

6. Autor

Mercedes Andrea Flores Catro

• Repositorio Github
• LinkedIn