# ipp-mdlinks

> * [1. Preámbulo](#1-preámbulo) * [2. md-Links](#2-md-Links) * [3. Instalación](#3-instalación) * [4. Opciones de uso](#4-opciones-de-uso) * [5. Consideraciones](#5-consideraciones) * [6. Plan de acción para el desarrollo](#6-plan-de-acción-para-el-de

Latest version **0.1.1** (published 2023-05-31) · 0 weekly downloads

## Install

```sh
npm install ipp-mdlinks
pnpm add ipp-mdlinks
yarn add ipp-mdlinks
bun add ipp-mdlinks
```

Provides the command `md-links`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.1 |
| Published | 2023-05-31 |
| First published | 2023-05-30 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=16.x |
| Dependencies | 2 |
| Unpacked size | 396.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Maintainers | indirapp |

## Links

- npm: https://www.npmjs.com/package/ipp-mdlinks
- Repository: https://github.com/IndiraPe/DEV005-md-links
- Homepage: https://github.com/IndiraPe/DEV005-md-links#readme
- Issues: https://github.com/IndiraPe/DEV005-md-links/issues
- npm.io page: https://npm.io/package/ipp-mdlinks

## Dependencies (2)

- [axios](https://npm.io/package/axios.md) ^1.4.0
- [colors](https://npm.io/package/colors.md) ^1.4.0

## Recent versions

- 0.1.1 (latest) — 2023-05-31
- 0.1.0 — 2023-05-30

## README

# ipp-mdlinks

## Índice

* [1. Preámbulo](#1-preámbulo)
* [2. md-Links](#2-md-Links)
* [3. Instalación](#3-instalación)
* [4. Opciones de uso](#4-opciones-de-uso)
* [5. Consideraciones](#5-consideraciones)
* [6. Plan de acción para el desarrollo](#6-plan-de-acción-para-el-desarrollo)
* [7. Checklist](#7-checklist)

***

## 1. Preámbulo

[Markdown](https://es.wikipedia.org/wiki/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`).

## 2. ipp-mdlinks

`md-Links`, es una librería que te permite extraer los _links_ de tus archivos 
Markdown, detectar cuáles ya no son válidos y reportar algunas estadísticas.

## 3. Instalación

`npm install IndiraPe/DEV005-md-links`

## 4. Opciones de uso

Se ejecuta en la terminal de la siguiente manera:

### Uso 1

`md-links <path-to-file-or-directory>`

Los valores retornados son:
* `href`: URL encontrada.
* `text`: Texto que aparecía dentro del link.
* `file`: Ruta del archivo donde se encontró el link.

Ejemplo: 
![md-links-Empty](./img/validateFalse.jpg)

### Uso 2

`md-links <path-to-file-or-directory> --validate`

Los valores retornados son:
* `href`: URL encontrada.
* `text`: Texto que aparecía dentro del link.
* `file`: Ruta del archivo donde se encontró el link.
* `status`: Código de respuesta HTTP.
* `statusText`: Mensaje `fail` en caso de fallo u `ok` en caso de éxito.

Ejemplo: 
![md-links-Validate](./img/validateTrue.jpg)

### Uso 3

`md-links <path-to-file-or-directory> --stats`

Los valores retornados son:
* `total`: Número de links encontrados.
* `unique`: Número de links que no se repiten.

Ejemplo: 
![md-links-Stats](./img/stats.jpg)

### Uso 4

`md-links <path-to-file-or-directory> --stats --validate`

también

`md-links <path-to-file-or-directory> --validate --stats`

Los valores retornados son:
* `total`: Número de links encontrados.
* `unique`: Número de links que no se repiten.
* `broken`: Número de links que no son válidos.

Ejemplo: 
![md-links-ValidateStats](./img/validateStats.jpg)

### Uso 5

`md-links --help`

Te retornará un pequeño cuadro donde te indica que opciones están disponibles para su uso.

Ejemplo: 
![md-links-Help](./img/help.jpg) 

### Uso opcional

También puedes importar el módulo de la siguiente manera: 

```js
const mdLinks =  require('md-links')

mdLinks('<path-to-file-or-directory>', { validate: false })

.then(elem => {
    console.log(elem);
})
.catch(error => {
    console.error(error);
}); 
```

`{ validate: false }`: URL del link, texto y ruta del archivo .md

`{ validate: true }`: URL del link, texto, ruta del archivo .md, status y el texto del status('ok' o 'fail')

## 5. Consideraciones

* Se usaron librerías externas como: [Colors](https://www.npmjs.com/package/colors) y [Axios](https://www.npmjs.com/package/axios).
* El color por defecto en la consola no es morado, es azul, si deseas
  el mismo visual de los ejemplos, usa el tema `Dracula` en tu Visual
  Studio Code.
* Si tu sistema operativo es Windows, te sugiero que trabajes con la 
  consola `Windows PowerShell`.

## 6. Plan de acción para el desarrollo

Antes de comenzar, organicé las primeras tareas en [GitHub-projects](https://github.com/users/IndiraPe/projects/4/views/1), que engloba al desarrollo del diagrama de flujo, organización del boilerplate e instalación de las dependencias.

### Diagrama de flujo

![md-links](./img/mdLinks.jpg)

Teniendo el diagrama de flujo plasmado, procedí a organizarlo en pequeñas tareas, dividiendo el camino en dos [Milestones](https://github.com/IndiraPe/DEV005-md-links/milestones): `Path`(para el trabajo de las rutas y extracción de links) y `Option` (para el trabajo de las opciones disponibles para el usuario y sus validaciones).

## 7. Checklist

### General

* [:ballot_box_with_check:] Puede instalarse via `npm install --global <github-user>/md-links`

### `README.md`

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

### API `mdLinks(path, opts)`

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

### CLI

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

### Pruebas / tests

* [:ballot_box_with_check:] Pruebas unitarias cubren un mínimo del 70% de statements, functions,
  lines, y branches.inte
* [:ballot_box_with_check:] Pasa tests (y lrs) (`npm test`).

---
_Source: https://npm.io/package/ipp-mdlinks · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._