# md-links-lim015

> Node.js library that validates links of markdown files

Latest version **0.1.0** (published 2021-10-13) · ISC license · 0 weekly downloads

## Install

```sh
npm install md-links-lim015
pnpm add md-links-lim015
yarn add md-links-lim015
bun add md-links-lim015
```

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.0 |
| Published | 2021-10-13 |
| First published | 2021-10-13 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 316.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Gina |
| Maintainers | gina_gonzales |
| Keywords | javascript, mdLinks, nodejs |

## Links

- npm: https://www.npmjs.com/package/md-links-lim015
- Repository: https://github.com/GinaFlores/LIM015-md-links
- Homepage: https://github.com/GinaFlores/LIM015-md-links#readme
- Issues: https://github.com/GinaFlores/LIM015-md-links/issues
- npm.io page: https://npm.io/package/md-links-lim015

## Dependencies (3)

- [jest](https://npm.io/package/jest.md) ^27.2.0
- [chalk](https://npm.io/package/chalk.md) ^4.1.2
- [node-fetch](https://npm.io/package/node-fetch.md) ^2.6.0

## Alternatives

- [@mdxeditor/editor](https://npm.io/package/@mdxeditor/editor.md) — 962.4K weekly downloads
- [mmdb-lib](https://npm.io/package/mmdb-lib.md) — 680.9K weekly downloads
- [playcanvas](https://npm.io/package/playcanvas.md) — 36.2K weekly downloads
- [@glw907/cairn-cms](https://npm.io/package/@glw907/cairn-cms.md) — 967 weekly downloads
- [markdown-to-confluence](https://npm.io/package/markdown-to-confluence.md) — 103 weekly downloads

## Recent versions

- 0.1.0 (latest) — 2021-10-13

## README

# Markdown Links

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.

## 2. Diagrama de Flujo

Para poder realizar esta librería, se realizaron 2 diagramas de flujo para cada tipo.

### 1) API

![Diagrama api](./img/api.png)

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

![Diagrama cli](./img/cli.png)

## 3. Instalación

Por npm:

`$ npm i md-links-lim015`

Por repo de github:

`npm i --global GinaFlores/LIM015-md-links`

## 4. Guía de Uso

### API

Para acceder a `mdLinks`, debemos importarla con

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

Esta es una promesa que recibe dos parámetros: `path` (ruta absoluta o relativa) y `option`, retornando un array de objetos por cada link encontrado con sus propiedades (href, text y file).

#### Ejemplos de uso:
```js
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

En la línea de interfaz de comando (CLI), se coloca lo siguiente:

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

- Si pasamos la ruta sin opciones, retornará el href, text, file de cada uno de los links encontrados.

![Ruta sin opciones](./img/sin-opciones.png)

- Si pasamos la opción `--validate`, retornará el href, texto y file de los links encontrados, además del status (200, 404) y su mensaje respectivo (ok o fail).

![Ruta con opción validate](./img/opcion-validate.png)

- Si pasamos la opción `--stats`, el resultado serán el total de links encontrados y los links únicos (sin repetir).

![Ruta con opción stats](./img/opcion-stats.png)

- Si pasamos la opción (`--stats --validate`) o (`--validate --stats`) arrojará la cantidad total de links, así como de los links sin repetir y de los que estén rotos

![Ruta con opción validate y stats](./img/opcion-validate-y-stats.png)

- Si pasamos la ruta que no contiene links, la consola arrojará el mensaje siguiente:

![Ruta sin links](./img/no-hay-links.png)

- Si pasamos la ruta mal escrita, la consola arrojará el mensaje siguiente:

![Ruta no exite](./img/no-existe-la-ruta.png)

- Si pasamos la ruta bien escrita con alguna opción no válida, la consola arrojará lo siguiente:

![Mensaje de ayuda](./img/mensaje-ayuda.png)

## 5. Autora
Gina Gonzales Flores - Lim015 Laboratoria

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