GithubHelp home page GithubHelp logo

anhernandezolvera / cdmx010-md-links Goto Github PK

View Code? Open in Web Editor NEW

This project forked from laboratoria/cdmx010-md-links

0.0 1.0 0.0 369 KB

https://github.com/AnHernandezOlvera/CDMX010-md-links.git

License: MIT License

JavaScript 100.00%

cdmx010-md-links's Introduction

MD LINKS

Módulo, librería y CLI para la búsqueda de links en archivos markdown con implementación para validar y generar estadísticas.

Descripción del módulo

  • Implementa soporte para un archivo individual
  • Implementa soporte para directorios
  • Verifica si el archivo es markdown
  • Encuentra archivos markdown en un directorio (a partir de la ruta que recibe como argumento obtenido desde la CLI).
  • Realiza peticiones HTTP
  • Output de validaciones
  • Output de estadísticas

Diagrama de flujo enter image description here

Implementación

El usuario puede seleccionar desde la CLI las siguientes opciones:

Ver links

Obtiene información de los links y los retorna en una array de objetos, donde cada objeto representa un un link y contiene las siguientes propiedades: href: URL encontrada text: Texto que aparecía dentro del link file: nombre del archivo path: ruta del archivo donde encontró el link

—validate

Ejecuta una petición HTTP para averiguar si el link está activo o no. Si el status de la petición es 200 considera al link como ok, de otro modo lo considera como fail. El output de —validate incluye la palabra ok o fail, el status de la respuesta recibida a la petición HTTP y la ruta del archivo donde se encuentra el link.

--stats El output es un texto con estadísticas básicas de los links, ejemplo:

Total: 10 Unique: 8

—stats —validate

El output es un texto con estadísticas de los resultados de validación:

Total: 10 Unique: 8 Active: 7 Broken: 3

Instalación

Módulo instalable vía npm install https://github.com/AnHernandezOlvera/CDMX010-md-links.git

Dependencias

Test

Las pruebas se implementan con jest.

Licencia

Copyright (c) 2021, Anahí Hernández Olvera. (MIT License)

cdmx010-md-links's People

Contributors

anhernandezolvera avatar reloadercf avatar

Watchers

 avatar

cdmx010-md-links's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.