isabelroman-mdlinks v0.1.0

Markdown Links

Índice

• 1. Sobre MD-Links
• 2. Resumen del proyecto
• 3. Instalación
• 4. Instrucciones de Uso
• 5. Objetivos de aprendizaje
• 6. Autora

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, etc.) 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 afecta el valor de la información que se quiere compartir.

2. Resumen del proyecto

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 el estatus de los links que contengan y reportar algunas estadísticas.

Para ello se crea una herramienta de línea de comando (CLI) con su correspondiente librería (o biblioteca - library) en JavaScript.

Cabe resaltar que diseñar una librería es una experiencia fundamental para cualquier desarrollador porque que lo obliga a pensar en la interfaz (API) de los módulos y cómo será usado por otros developers. Se debe tener especial consideración en peculiaridades del lenguaje, convenciones y buenas prácticas.

• Diagrama MD-Links

3. Instalación

Puedes instalar la librería a través de npm:

npm i isabelroman-mdlinks

Para acceder se debe importar con require('isabelroman-mdlinks')

4. Instrucciones de Uso

Para comenzar con la ejecución del programa:

mdLinks

Posteriormente ingrese la ruta del archivo.md en el cual quiere verificar el estado de los links. Si no agrega ningún comando, arrojará los links disponibles en el archivo sin ninguna validación ni estadística.

mdLinks <path>

Para conocer el status de los links:

mdLinks <path> --validate

Para conocer el total de links que tiene el archivo y, además, cuantos son únicos:

mdLinks <path> --stats

Para conocer el total de estadísticas disponibles:

mdLinks <path> --validate --stats o mdLinks <path> --stats --validate

5. Objetivos de aprendizaje

JavaScript

• Diferenciar entre tipos de datos primitivos y no primitivos

• Arrays (arreglos)

• Objetos (key, value)

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

• Funciones (params, args, return)

• Recursión o recursividad

• Módulos de CommonJS

• Diferenciar entre expresiones (expressions) y sentencias (statements)

• Callbacks

• Promesas

• Pruebas unitarias (unit tests)

• Pruebas asíncronas

• Uso de mocks y espías

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

• Uso de linter (ESLINT)

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

Node.js

• Instalar y usar módulos con npm

• Configuración de package.json

• Configuración de npm-scripts

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

• File system (fs, path)

Control de Versiones (Git y GitHub)

• Git: Instalación y configuración

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

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

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

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

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

HTTP

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

• Códigos de status de HTTP

6. Autora

Isabel Cristina Román Ospina