mysticbel-mdlinks

Markdown Links 🔗 ✨

`
█████████████████████████████████████████████████████████████
███████████             Welcome to             ██████████████
███████████ █▀▄▀█ █▀▀▄ ░░ █░░ ░▀░ █▀▀▄ █░█ █▀▀ ██████████████
███████████ █░▀░█ █░░█ ▀▀ █░░ ▀█▀ █░░█ █▀▄ ▀▀█ ██████████████
███████████ ▀░░░▀ ▀▀▀░ ░░ ▀▀▀ ▀▀▀ ▀░░▀ ▀░▀ ▀▀▀▒██████████████
█████████████████████████████████████████████████████████████
░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░
░░░░░░░░░░░░░░░░░░▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄░░░░░░░░░░░░░░░░░░░░░░░░░░░░
░░░░░░░░░░░▄▄▄▄█▀▀▀░░░░░░░░░░░░▀▀██░░░░░░░░░░░░░░░░░░░░░░░░░░
░░░░░░░░▄███▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄█▄▄▄░░░░░░░░   . . .   ░░░
░░░░░░▄▀▀░█░░░░▀█▄▀▄▀██████░▀█▄▀▄▀████▀░░░░░░░░   aw      ░░░
░░░░░░█░░░█░░░░░░▀█▄█▄███▀░░░░▀▀▀▀▀▀▀░▀▀▄░░░░░░ yeaah !!  ░░░
░░░░░░█░░░█░▄▄▄░░░░░░░░░░░░░░░░░░░░░▀▀░░░█░░░░░   . . .   ░░░
░░░░░░█░░░▀█░░█░░░░▄░░░░▄░░░░░▀███▀░░░░░░░█░░░░░░░░░░░░░░░░░░
░░░░░░█░░░░█░░▀▄░░░░░░▄░░░░░░░░░█░░░░░░░░█▀▄░░░░░░░░░░░░░░░░░
░░░░░░░▀▄▄▀░░░░░▀▀▄▄▄░░░░░░░▄▄▄▀░▀▄▄▄▄▄▀▀░░█░░░░░░░░░░░░░░░░░
░░░░░░░█▄░░░░░░░░░░░░▀▀▀▀▀▀▀░░░░░░░░░░░░░░█░░░░░░░░░░░░░░░░░░
░░░░░░░░█░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░▄██░░░░░░░░░░░░░░░░░░░
░░░░░░░░▀█▄░░░░░░░░░░░░░░░░░░░░░░░░░▄▀▀░░░▀█░░░░░░░░░░░░░░░░░`

Index

• 1. About md-links
• 2. How to install mdLinks?
• 3. Flowchart
• 4. Backlog & Planning
• 5. Learning goals

---

1. About md-links

Markdown is a very popular lightweight markup language among developers. It is used in many platforms that handle plain text (GitHub, forums, blogs, ...), and it is very common to find several files in that format in any type of repository (starting with the traditional README.md).

These Markdown files usually contain links that are often broken or no longer valid and that greatly damages the value of the information that you want to share.

In this project, md-links is an executable that reads and analyzes files in Markdown format, to verify the links they contain and report some statistics.

Options:

• --validate (OK, Fail)
• --stats (total, unique, broken)

2. How to install mdLinks?

⬇️Install :

Install this library with this command :

npm install mysticbel-mdlinks

or you can also download it from github:

npm install mysticbel/LIM015-md-links

🔍Usage:

// Usage: 
  md-links <path-to-file> [options]

// Commands:
  --v, --validate       Show validate links, makes an HTTP request to find out if the link works or not
  --s, --stats          Show basic statistics about links
  --v --s               Show statistics about links : total, unique, broken
  --validate --stats    Show statistics about links : total, unique, broken
  
// Global options:
  -h, --help            display help for command

Options:

--validate

If we pass the --validate option, the module must make an HTTP request to find out if the link works or not. If the link results in a redirect to a URL that responds ok, then we will treat the link as ok.

Example:

--stats

If we pass the --stats option, the output will be a text with basic statistics about the links.

Example:

We can also combine --stats and --validate to obtain needed statistics from the validation results.

--help

If we pass the --help option, the output will be a help menu with all commands.

other option

If we pass a non existant option, the output will be a help menu with an 'invalid command' message.

What if we put a wrong path or a non-existance file?

the output will be a 'links not found' message and the path doesn't exist.

What if we put a path without an option?

the output will be a an array with all the links extrated fro the file.

3. Flowchart

4. Backlog & Planning

I love using Github Projects !! 😍

5. Learning Objectives

...

Checklist

General

• [ ] Can be installed via npm install --global <github-user>/md-links

README.md

• [✔️🐳] A board with the backlog for the implementation of the library.
• [✔️🐳] Technical documentation of the library.
• [✔️🐳] Library installation and use guide.

API mdLinks(path, opts)

• [✔️🐼] The module exports a function with the expected interface (API).
• [✔️🐼] Implement single file support.
• [✔️🐼] Implement directory support.
• [✔️🐼] Implement options.validate

CLI

• [✔️🦄] Exposes executable md-links in the path (configured in package.json)
• [✔️🦄] Runs without errors / expected output
• [✔️🦄] Implement --validate
• [✔️🦄] Implement --stats

Unit tests

• [✔️🐱] Unit tests cover a minimum of 70% of statements, functions, lines, and branches.
• [✔️🐱] Pass tests (and linters) (npm test).

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

'md-links' is a project done by Maribel Maza for Laboratoria ,
October 2021 🤗