Markdown Links 📄🔗

About the project

Welcome to my first library! This the Markdown Links Library which will help you to extract the links of all the markdown links of a path. It also give the information:

• Validate Links(OK, FAIL)
• Stats Links(total, unique, broken)

Flow Chart

• To create this library first we need to understand how we can built everything from the start, that's why we used:
  • Flow Chart.
  • Git hub projects.

Flow Chart API


Flow Chart CLI

How to install mdLinks?

• Install this library with this command: npm install GiovandYG/LIM013-fe-md-links

API mdLinks(path, opts)

Example of how to use it:

const mdLinks = require("md-links");

mdLinks("./some/example.md")
  .then(links => {
    // => [{ href, text, file }]
  })
  .catch(console.error);

mdLinks("./some/example.md", { validate: true })
  .then(links => {
    // => [{ href, text, file, status, ok }]
  })
  .catch(console.error);

mdLinks("./some/dir")
  .then(links => {
    // => [{ href, text, file }]
  })
  .catch(console.error);

CLI (Command Line Interface - Interfaz de Línea de Comando)

Remember that to use this library you need to insert:
👉 md-links <path-to-file>
👉 md-links <path-to-file> [valid arguments]
*****************Valid Arguments*****************
⭐md-links <path-to-file> --validate   --stats
⭐md-links <path-to-file> -v   -s
⭐md-links <path-to-file> -s   -Sv
⭐md-links <path-to-file> --validate
⭐md-links <path-to-file> --stats
************************************************* 

Data Lovers learning goals

• [⭐] Entender la diferencia entre expression y statements.
• [⭐] Entender el uso de bucles (for | forEach).
• [⭐] Manipular arrays (filter | map | sort | reduce).
• [😅] Entender como funciona flexbox en CSS. *Este objetivo se queda para Red Social
• [⭐] Entender la diferencia entre tipos de datos atómicos y estructurados.
• [⭐] Utilizar linter para seguir buenas prácticas (ESLINT)

Javascript

• [⭐] Uso de callbacks
• [😅] Consumo de Promesas
• [⭐] Creacion de Promesas
• [⭐] Modulos de Js
• [⭐] Recursión

Node

• [⭐] Sistema de archivos
• [⭐] package.json
• [⭐] crear modules
• [⭐] Instalar y usar modules
• [⭐] npm scripts
• [⭐] CLI (Command Line Interface - Interfaz de Línea de Comando)

Testing

• [⭐] Testeo de tus funciones
• [😅] Testeo asíncrono
• [ ] Uso de librerias de Mock
• [ ] Mocks manuales
• [ ] Testeo para multiples Sistemas Operativos

Git y Github

• [⭐] Organización en Github

Buenas prácticas de desarrollo

• [⭐] Modularización
• [⭐] Nomenclatura / Semántica
• [ ] Linting

The End :shipit:

So this was mdLinks! I suffer a lot during this project but learn JS for real!

• Thank you to everyone who help and give the opportunity to learn and ask during this process. I know I would be a great Front End Developer!!

• **See you on Red Social!!

Pistas / Tips

FAQs

¿Cómo hago para que mi módulo sea instalable desde GitHub?

Para que el módulo sea instalable desde GitHub solo tiene que:

• Estar en un repo público de GitHub
• Contener un package.json válido

Con el comando npm install githubname/reponame podemos instalar directamente desde GitHub. Ver docs oficiales de npm install acá.

Por ejemplo, el course-parser que usamos para la currícula no está publicado en el registro público de NPM, así que lo instalamos directamente desde GitHub con el comando npm install Laboratoria/course-parser.

Sugerencias de implementación

La implementación de este proyecto tiene varias partes: leer del sistema de archivos, recibir argumentos a través de la línea de comando, analizar texto, hacer consultas HTTP, ... y todas estas cosas pueden enfocarse de muchas formas, tanto usando librerías como implementando en VanillaJS.

Por poner un ejemplo, el parseado (análisis) del markdown para extraer los links podría plantearse de las siguientes maneras (todas válidas):

• Usando un módulo como markdown-it, que nos devuelve un arreglo de tokens que podemos recorrer para identificar los links.
• Siguiendo otro camino completamente, podríamos usar expresiones regulares (RegExp).
• También podríamos usar una combinación de varios módulos (podría ser válido transformar el markdown a HTML usando algo como marked y de ahí extraer los link con una librería de DOM como JSDOM o Cheerio entre otras).
• Usando un custom renderer de marked (new marked.Renderer()).

Tutoriales / NodeSchool workshoppers

• learnyounode
• how-to-npm
• promise-it-wont-hurt

Otros recursos

• Acerca de Node.js - Documentación oficial
• Node.js file system - Documentación oficial
• Node.js http.get - Documentación oficial
• Node.js - Wikipedia
• What exactly is Node.js? - freeCodeCamp
• ¿Qué es Node.js y para qué sirve? - drauta.com
• ¿Qué es Nodejs? Javascript en el Servidor - Fazt en YouTube
• ¿Simplemente qué es Node.js? - IBM Developer Works, 2011
• Node.js y npm
• Módulos, librerías, paquetes, frameworks... ¿cuál es la diferencia?
• Asíncronía en js
• NPM
• Publicar packpage
• Crear módulos en Node.js
• Leer un archivo
• Leer un directorio
• Path
• Linea de comando CLI
• Promise
• Comprendiendo Promesas en Js
• Pill de recursión - video
• Pill de recursión - repositorio

Markdown Links

Índice

• 1. Preámbulo
• 2. Resumen del proyecto
• 3. Objetivos de aprendizaje
• 4. Consideraciones generales
• 5. Criterios de aceptación mínimos del proyecto
• 6. Entregables
• 7. Pistas, tips y lecturas complementarias
• 8. Checklist

1. Preámbulo

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. Resumen del proyecto

Node.js es un entorno de ejecución para JavaScript construido con el motor de JavaScript V8 de Chrome. Esto nos va a permitir ejecutar JavaScript en el entorno del sistema operativo, ya sea tu máquina o un servidor, lo cual nos abre las puertas para poder interactuar con el sistema en sí, archivos, redes, ...

En este proyecto nos alejamos un poco del navegador para construir un programa que se ejecute usando Node.js, donde aprenderemos sobre cómo interactuar con el sistema archivos, con el entorno (proceso, env, stdin/stdout/stderr), ...

En este proyecto crearás una herramienta de línea de comando (CLI) así como tu propia librería (o biblioteca - library) en JavaScript.

3. Objetivos de aprendizaje

Diseñar tu propia librería es una experiencia fundamental para cualquier desarrollador porque que te obliga a pensar en la interfaz (API) de tus módulos y cómo será usado por otros developers. Debes tener especial consideración en peculiaridades del lenguaje, convenciones y buenas prácticas.

A continuación puedes ver los objetivos de aprendizaje de este proyecto:

JavaScript

• [ ] Uso de condicionales (if-else | switch | operador ternario)
• [ ] Uso de funciones (parámetros | argumentos | valor de retorno)
• [ ] Manipular arrays (filter | map | sort | reduce)
• [ ] Manipular objects (key | value)
• [ ] Uso ES modules (import | export)
• [ ] Diferenciar entre expression y statements.
• [ ] Diferenciar entre tipos de datos atómicos y estructurados.
• [ ] Uso de callbacks.
• [ ] Consumo de Promesas.
• [ ] Creación de Promesas.

Node

• [ ] Uso de sistema de archivos. (fs, path)
• [ ] Instalar y usar módulos. (npm)
• [ ] Creación de modules. (CommonJS)
• [ ] Configuración de package.json.
• [ ] Configuración de npm-scripts
• [ ] Uso de CLI (Command Line Interface - Interfaz de Línea de Comando)

Testing

• [ ] Testeo unitario.
• [ ] Testeo asíncrono.
• [ ] Uso de librerias de Mock.
• [ ] Uso de Mocks manuales.
• [ ] Testeo para múltiples Sistemas Operativos.

Estructura del código y guía de estilo

• [ ] Organizar y dividir el código en módulos (Modularización)
• [ ] Uso de identificadores descriptivos (Nomenclatura | Semántica)
• [ ] Uso de linter (ESLINT)

Git y GitHub

• [ ] Uso de comandos de git (add | commit | pull | status | push)
• [ ] Manejo de repositorios de GitHub (clone | fork | gh-pages)
• [ ] Colaboración en Github (branches | pull requests | |tags)
• [ ] Organización en Github (projects | issues | labels | milestones)

HTTP

• [ ] Verbos HTTP (http.get)

Fundamentos de programación

• [ ] Recursión.

4. Consideraciones generales

• Este proyecto se debe "resolver" de manera individual.

• La librería y script ejecutable (herramienta de línea de comando - CLI) debe estar implementada en JavaScript para ser ejecutada con Node.js. Está permitido usar librerías externas.

• Tu módulo debe ser instalable via npm install <github-user>/md-links. Este módulo debe incluir tanto un ejecutable que podamos invocar en la línea de comando como una interfaz que podamos importar con require para usarlo programáticamente.

• Los tests unitarios deben cubrir un mínimo del 70% de statements, functions, lines y branches. Te recomendamos explorar Jest para tus pruebas unitarias.

• Los tests unitarios deben cubrir un mínimo del 70% de statements, functions, lines y branches., ademas de pasar los test y el linter. Te recomendamos utilizar Jest para tus pruebas unitarias.

• Para este proyecto no está permitido utilizar async/await.

• Para este proyecto es opcional el uso de ES Modules (import/export), en el caso optes utilizarlo deberás de crear un script de build en el package.json que los transforme en requires y module.exports con ayuda de babel.

5. Criterios de aceptación mínimos del proyecto

Para comenzar este proyecto tendrás que hacer un fork y clonar este repositorio.

Antes de comenzar a codear, es necesario que pensemos en la arquitectura y boilerplate del proyecto, por lo que antes de que empieces tu planificacion y a trabajar en la funcionalidad de tu proyecto deberás de haber creado tu boilerplate y tus tests. Esto debería quedar detallado en tu repo y haberte asegurado de haber recibido feedback de uno de tus coaches. Una vez hayas terminado de definir la arquitectura y los tests de tu proyecto estarás lista para iniciar con tu planificacion por lo cual deberas de hacer uso de una serie de issues y milestones para priorizar tus tareas y crear un project para organizar el trabajo y poder hacer seguimiento de tu progreso.

Dentro de cada milestone se crearán y asignarán los issues que cada quien considere necesarios.

Archivos del proyecto

Estos son los criterios de lo que debe ocurrir para que se satisfagan las necesidades del usuario:

• Instalar la libreria via npm install --global <github-user>/md-links

README.md

• Encontrar el pseudo codigo o diagrama de flujo con el algoritmo que soluciona el problema.
• Encontrar un board con el backlog para la implementación de la librería.
• Encontrar la documentación técnica de la librería.
• Encontrar la Guía de uso e instalación de la librería.

API mdLinks(path, opts)

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

CLI

• Expone ejecutable md-links en el path (configurado en package.json)
• Se ejecuta sin errores / output esperado.
• El ejecutable implementa --validate.
• El ejecutable implementa --stats.
• El ejecutable implementa --validate y --stats juntos.

JavaScript API

El módulo debe poder importarse en otros scripts de Node.js y debe ofrecer la siguiente interfaz:

mdLinks(path, options)

Argumentos

• path: Ruta absoluta o relativa al archivo o directorio. Si la ruta pasada es relativa, debe resolverse como relativa al directorio desde donde se invoca node - current working directory).
• options: Un objeto con las siguientes propiedades:
  • validate: Booleano que determina si se desea validar los links encontrados.

Valor de retorno

La función debe retornar una promesa (Promise) que resuelva a un arreglo (Array) de objetos (Object), donde cada objeto representa un link y contiene las siguientes propiedades:

• href: URL encontrada.
• text: Texto que aparecía dentro del link (<a>).
• file: Ruta del archivo donde se encontró el link.

Ejemplo

const mdLinks = require("md-links");

mdLinks("./some/example.md")
  .then(links => {
    // => [{ href, text, file }]
  })
  .catch(console.error);

mdLinks("./some/example.md", { validate: true })
  .then(links => {
    // => [{ href, text, file, status, message }]
  })
  .catch(console.error);

mdLinks("./some/dir")
  .then(links => {
    // => [{ href, text, file }]
  })
  .catch(console.error);

CLI (Command Line Interface - Interfaz de Línea de Comando)

El ejecutable de nuestra aplicación debe poder ejecutarse de la siguiente manera a través de la terminal:

md-links <path-to-file> [options]

Por ejemplo:

$ md-links ./some/example.md
./some/example.md http://algo.com/2/3/ Link a algo
./some/example.md https://otra-cosa.net/algun-doc.html algún doc
./some/example.md http://google.com/ Google

El comportamiento por defecto no debe validar si las URLs responden ok o no, solo debe identificar el archivo markdown (a partir de la ruta que recibe como argumento), analizar el archivo Markdown e imprimir los links que vaya encontrando, junto con la ruta del archivo donde aparece y el texto que hay dentro del link (truncado a 50 caracteres).

Options

--validate

Si pasamos la opción --validate, el módulo debe hacer una petición HTTP para averiguar si el link funciona o no. Si el link resulta en una redirección a una URL que responde ok, entonces consideraremos el link como ok.

Por ejemplo:

$ md-links ./some/example.md --validate
./some/example.md http://algo.com/2/3/ ok 200 Link a algo
./some/example.md https://otra-cosa.net/algun-doc.html fail 404 algún doc
./some/example.md http://google.com/ ok 301 Google

Vemos que el output en este caso incluye la palabra ok o fail después de la URL, así como el status de la respuesta recibida a la petición HTTP a dicha URL.

--stats

Si pasamos la opción --stats el output (salida) será un texto con estadísticas básicas sobre los links.

$ md-links ./some/example.md --stats
Total: 3
Unique: 3

También podemos combinar --stats y --validate para obtener estadísticas que necesiten de los resultados de la validación.

$ md-links ./some/example.md --stats --validate
Total: 3
Unique: 3
Broken: 1

6. Entregables

Módulo instalable via npm install <github-user>/md-links. Este módulo debe incluir tanto un ejecutable como una interfaz que podamos importar con require para usarlo programáticamente.

7. Pistas, tips y lecturas complementarias

FAQs

¿Cómo hago para que mi módulo sea instalable desde GitHub?

Para que el módulo sea instalable desde GitHub solo tiene que:

• Estar en un repo público de GitHub
• Contener un package.json válido

Con el comando npm install githubname/reponame podemos instalar directamente desde GitHub. Ver docs oficiales de npm install acá.

Por ejemplo, el course-parser que usamos para la currícula no está publicado en el registro público de NPM, así que lo instalamos directamente desde GitHub con el comando npm install Laboratoria/course-parser.

Sugerencias de implementación

La implementación de este proyecto tiene varias partes: leer del sistema de archivos, recibir argumentos a través de la línea de comando, analizar texto, hacer consultas HTTP, ... y todas estas cosas pueden enfocarse de muchas formas, tanto usando librerías como implementando en VanillaJS.

Por poner un ejemplo, el parseado (análisis) del markdown para extraer los links podría plantearse de las siguientes maneras (todas válidas):

• Usando un módulo como markdown-it, que nos devuelve un arreglo de tokens que podemos recorrer para identificar los links.
• Siguiendo otro camino completamente, podríamos usar expresiones regulares (RegExp).
• También podríamos usar una combinación de varios módulos (podría ser válido transformar el markdown a HTML usando algo como marked y de ahí extraer los link con una librería de DOM como JSDOM o Cheerio entre otras).
• Usando un custom renderer de marked (new marked.Renderer()).

No dudes en consultar a tus compañeras, coaches y/o el foro de la comunidad si tienes dudas existenciales con respecto a estas decisiones. No existe una "única" manera correcta :wink:

Tutoriales / NodeSchool workshoppers

• learnyounode
• how-to-npm
• promise-it-wont-hurt

Otros recursos

• Acerca de Node.js - Documentación oficial
• Node.js file system - Documentación oficial
• Node.js http.get - Documentación oficial
• Node.js - Wikipedia
• What exactly is Node.js? - freeCodeCamp
• ¿Qué es Node.js y para qué sirve? - drauta.com
• ¿Qué es Nodejs? Javascript en el Servidor - Fazt en YouTube
• ¿Simplemente qué es Node.js? - IBM Developer Works, 2011
• Node.js y npm
• Módulos, librerías, paquetes, frameworks... ¿cuál es la diferencia?
• Asíncronía en js
• NPM
• Publicar packpage
• Crear módulos en Node.js
• Leer un archivo
• Leer un directorio
• Path
• Linea de comando CLI

• Promise
• Comprendiendo Promesas en Js
• Pill de recursión - video
• Pill de recursión - repositorio

8. Checklist

General

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

README.md

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

API mdLinks(path, opts)

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

CLI

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

Pruebas / tests

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