❤
npm
Sign UpSign In

fabiolafc-md.links

0.1.0 • Public • Published


Índice

1. Descripción

Md-links, tu aliado para el control de enlaces en archivos Markdown. Esta potente herramienta de línea de comandos (CLI) se encarga de analizar tus archivos Markdown en busca de enlaces, verificando su validez y brindándote datos relevantes. Con Md-links, puedes asegurarte de que todos tus enlaces estén activos y funcionales, evitando enlaces rotos y mejorando la calidad de tus documentos. Simplifica la gestión de enlaces Markdown y obtén estadísticas útiles para mantener tus proyectos siempre actualizados y profesionales.

2. Instalación

Antes de comenzar a utilizar Md-links, necesitarás instalarlo en tu entorno de desarrollo. Sigue los pasos a continuación para completar la instalación:

Abre tu terminal o línea de comandos. Ejecuta el siguiente comando para instalar Md-links:

npm install kellyfabiolafc/DEV004-md-links

o

npm i fabiolafc-md.links

Una vez finalizada la instalación, estarás listo para utilizar Md-links y aprovechar todas sus funcionalidades para analizar y verificar los enlaces en tus archivos Markdown. ¡Comencemos!

3. Uso

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).

md-links archivoPruebaa


El mensaje de ayuda describe las instrucciones de uso de md-links y proporciona información sobre cómo ejecutarlo correctamente. Utiliza la librería chalk para imprimir texto en colores y estilos diferentes para resaltar la información clave.

md-links --help


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.

md-links archivoPruebaa --validate


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

md-links archivoPruebaa --stats


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

md-links archivoPruebaa --stats --validate


4. Planificación

5. Diagrama de flujo

6. Pruebas unitarias


7. 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

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

  • [✔] Callbacks

    Links

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

  • [✔] Uso de linter (ESLINT)

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

Node.js

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

8. Archivos del proyecto

  • README.md con descripción del módulo, instrucciones de instalación/uso, documentación del API y ejemplos. Todo lo relevante para que cualquier developer que quiera usar tu librería pueda hacerlo sin inconvenientes.
  • index.js: Desde este archivo debes exportar una función (mdLinks).
  • package.json con nombre, versión, descripción, autores, licencia, dependencias, scripts (pretest, test, ...), main, bin
  • .editorconfig con configuración para editores de texto. Este archivo no se debe cambiar.
  • .eslintrc con configuración para linter. Este archivo contiene una configuración básica para ESLint, si deseas agregar reglas adicionales como Airbnb deberás modificar este archivo.
  • .gitignore para ignorar node_modules u otras carpetas que no deban incluirse en control de versiones (git).
  • test/md-links.spec.js debe contener los tests unitarios para la función mdLinks(). Tu inplementación debe pasar estos tets.

9. Este proyecto consta de DOS partes

1) 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 únicamente la siguiente propiedad:
    • 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

Con validate:false :

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

Con validate:true :

  • href: URL encontrada.
  • text: Texto que aparecía dentro del link (<a>).
  • file: Ruta del archivo donde se encontró el link.
  • status: Código de respuesta HTTP.
  • ok: Mensaje fail en caso de fallo u ok en caso de éxito.

Ejemplo (resultados como comentarios)

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);

2) 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

10. 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).

11. Contribuciones

Si deseas contribuir a md-links, sigue estos pasos:

Haz un fork de este repositorio. Crea una rama con tu nueva funcionalidad: git checkout -b nueva-funcionalidad. Realiza tus modificaciones y realiza commit de tus cambios: git commit -m "Añadir nueva funcionalidad". Envía tus cambios al repositorio remoto: git push origin nueva-funcionalidad. Abre una pull request en este repositorio.

12. Créditos

md-links ha sido desarrollado por Fabiola Flores

13. Licencia

Este proyecto está licenciado bajo la Licencia MIT. Consulta el archivo LICENSE para obtener más detalles.

¡Gracias por usar md-links

Readme

Keywords

Package Sidebar

Install

npm i fabiolafc-md.links

Repository

github.com/kellyfabiolafc/DEV004-md-links

Homepage

github.com/kellyfabiolafc/DEV004-md-links#readme

Weekly Downloads

0

Version

0.1.0

License

ISC

Unpacked Size

6.83 MB

Total Files

460

Last publish

Collaborators

  • fabiola.fc
Try on RunKit
Report malware