# sj-mdlinks

> Validator of links contained only in md files

Latest version **1.1.1** (published 2020-10-16) · MIT license · 0 weekly downloads

## Install

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

Provides the command `mdlinks`.

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.1 |
| Published | 2020-10-16 |
| First published | 2020-10-13 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.10.0 |
| Dependencies | 4 |
| Unpacked size | 15.1 KB |
| Known vulnerabilities | 0 (+3 in 1 direct dependencies) |
| Install scripts | no |
| Author | Stephanie Jolianis |
| Maintainers | stephaniejolianis |
| Keywords | cli, cli-app, mdlinks, markdown, validate, links, javascript, npm |

## Links

- npm: https://www.npmjs.com/package/sj-mdlinks
- Repository: https://github.com/StephanieJolianis/bog001-md-links
- Homepage: https://github.com/StephanieJolianis/bog001-md-links#readme
- Issues: https://github.com/StephanieJolianis/bog001-md-links/issues
- npm.io page: https://npm.io/package/sj-mdlinks

## Dependencies (4)

- [jsdom](https://npm.io/package/jsdom.md) ^16.4.0
- [yargs](https://npm.io/package/yargs.md) ^16.0.3
- [marked](https://npm.io/package/marked.md) ^1.2.0
- [node-fetch](https://npm.io/package/node-fetch.md) ^2.6.1

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

- 1.1.1 (latest) — 2020-10-16
- 1.1.0 — 2020-10-15
- 1.0.6 — 2020-10-14
- 1.0.5 — 2020-10-14
- 1.0.4 — 2020-10-14
- 1.0.3 — 2020-10-13
- 1.0.2 — 2020-10-13

## README

# Markdown Links
<div align="center"> <img src="https://raw.githubusercontent.com/StephanieJolianis/bog001-md-links/mdLinks/img/links.png"></div>

**Índice**
- [Descripción](#id1)
- [Homepage](#id2)
- [Diagrama de flujo](#id3)
- [Instalación y uso (CLI)](#id4)
  - [Ejecución de comandos](#id6)
- [Instalación y uso (MÓDULO)](#id5)
- [Objetivos de aprendizaje](#id7)
- [Checklist](#id8)

## Descripción<div id='id1'/>
sj-mdlinks es una libreria que usa [Node.js](https://nodejs.org/) Contiene una función  `recursiva` que recibe como parámetro una ruta, localiza todos los archivos con extensión .md que esten dentro de la ruta proporcionada (incluyendo subdirectorios), verifica los links que contenga cada archivo, valida su status (ok, fail) y calcula estadisticas básicas sobre los links (totales, únicos y rotos).
***

## Homepage<div id='id2'/>
[Github StephanieJolianis](https://github.com/StephanieJolianis/bog001-md-links/tree/master)
***

## Diagrama de flujo<div id='id3'/>
<p align="center"> <img src="https://raw.githubusercontent.com/StephanieJolianis/bog001-md-links/mdLinks/img/diagrama.png" width="1000"></p>


***
## Instalación y uso (CLI)<div id='id4'/>

Linux o MacOS
```sh
$ sudo npm i -g sj-mdlinks
```

Microsoft Windows
```sh
$ npm i -g sj-mdlinks
```
***
### Ejecución de comandos:<div id='id6'/>

Puedes ejecutar la aplicación de la siguiente manera a través de la terminal
md-links <path-to-file> [options]

##### Por ejemplo: 

- Para obtener links

Aquí puedes utilizar una ruta de un archivo con una extensión .md o una ruta de un directorio.

`Comando:`
```sh
$ mdlinks hola.md
```
`Retorno:` 
```sh
[ { file: '/home/stephanie/Escritorio/pruebas-mdlinks/hola.md',
    href: 'https://www.npmjs.com/package/sj-mdlinks',
    text: 'Stephanie' },
  { file: '/home/stephanie/Escritorio/pruebas-mdlinks/hola.md',
    href: 'https://otra-cosa.net/algun-doc.html',
    text: 'Link roto' } ]
```

- Options

##### `--validate`

Si pasas la opción `--validate`, el módulo hace 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 se considera el link como ok.

`Comando:`
```sh
$ mdlinks hola.md --validate
```
`Retorno:` 
```sh
[ { href: 'https://www.npmjs.com/package/sj-mdlinks',
    text: 'Stephanie',
    file: '/home/stephanie/Escritorio/pruebas-mdlinks/hola.md',
    code: 200,
    status: 'OK' },
  { href: 'https://otra-cosa.net/algun-doc.html',
    text: 'Link roto',
    file: '/home/stephanie/Escritorio/pruebas-mdlinks/hola.md',
    code: 404,
    status: 'FAIL' } ]
```


##### `--stats`
Si pasas la opción --stats el output será un texto con estadísticas básicas sobre los links.

`Comando:` 
```sh
$ mdlinks hola.md --stats
```
`Retorno:`

```sh
[ total: 2, unique: 2 ]
```

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

`Comando:` 
```sh
$ mdlinks hola.md --validate --stats
```
`Retorno:`

```sh
[ total: 2, unique: 2, broken: 1, ok: 1 ]
```
***
## Instalación y uso (MÓDULO)<div id='id5' />
Instalar como dependencia npm
```sh
$ npm i sj-mdlinks
```

#### Ejemplo uso del módulo

```js

const mdlinks = require("sj-mdlinks");

//Obtener datos de un archivo .md [{ href, text, file }]
mdlinks("./some/example.md", { validate: false, stats: false})
  .then(links => {
    console.log(links)
  })
  .catch(console.error);

//Obtener links validados [{ href, text, file, status, ok }]
mdlinks("./some/example.md", { validate: true, stats: false })
  .then(links => {
    console.log(links)
  })
  .catch(console.error);

//Obtener estadísticas [{ total, unique }]
mdlinks("./some/example.md", { validate: false, stats: true })
  .then(links => {
    console.log(links)
  })
  .catch(console.error);

//Obtener estadísticas y validación de links [{ total, unique, broken, ok }]
mdlinks("./some/example.md", { validate: true, stats: true })
  .then(links => {
    console.log(links)
  })
  .catch(console.error);

```

## Objetivos de aprendizaje<div id='id7'/>

### JavaScript

* [x] Uso de condicionales (if-else | switch | operador ternario)
* [x] Uso de funciones (parámetros | argumentos | valor de retorno)
* [x] Manipular arrays (filter | map | sort | reduce)
* [x] Manipular objects (key | value)
* [x] Uso ES modules ([`import`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/import)
| [`export`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/export))
* [x] Diferenciar entre expression y statements.
* [x] Diferenciar entre tipos de datos atómicos y estructurados.
* [x] [Uso de callbacks.](https://developer.mozilla.org/es/docs/Glossary/Callback_function)
* [x] [Consumo de Promesas.](https://scotch.io/tutorials/javascript-promises-for-dummies#toc-consuming-promises)
* [x] [Creación de Promesas.](https://www.freecodecamp.org/news/how-to-write-a-javascript-promise-4ed8d44292b8/)

### Node

* [x] Uso de sistema de archivos. ([fs](https://nodejs.org/api/fs.html), [path](https://nodejs.org/api/path.html))
* [x] Instalar y usar módulos. ([npm](https://www.npmjs.com/))
* [x] Creación de modules. [(CommonJS)](https://nodejs.org/docs/latest-v0.10.x/api/modules.html)
* [x] [Configuración de package.json.](https://docs.npmjs.com/files/package.json)
* [x] [Configuración de npm-scripts](https://docs.npmjs.com/misc/scripts)
* [x] Uso de CLI (Command Line Interface - Interfaz de Línea de Comando)

### Testing

* [x] [Testeo unitario.](https://jestjs.io/docs/es-ES/getting-started)
* [x] [Testeo asíncrono.](https://jestjs.io/docs/es-ES/asynchronous)
* [ ] [Uso de librerias de Mock.](https://jestjs.io/docs/es-ES/manual-mocks)
* [x] Uso de Mocks manuales.
* [x] Testeo para múltiples Sistemas Operativos.

### Estructura del código y guía de estilo

* [x] Organizar y dividir el código en módulos (Modularización)
* [ ] Uso de identificadores descriptivos (Nomenclatura | Semántica)
* [ ] Uso de linter (ESLINT)

### Git y GitHub

* [x] Uso de comandos de git (add | commit | pull | status | push)
* [x] Manejo de repositorios de GitHub (clone | fork | gh-pages)
* [ ] Colaboración en Github (branches | pull requests | |tags)
* [x] Organización en Github (projects | issues | labels | milestones)

### HTTP

* [x] Verbos HTTP ([http.get](https://nodejs.org/api/http.html#http_http_get_options_callback))

### Fundamentos de programación

* [x] [Recursión.](https://www.youtube.com/watch?v=lPPgY3HLlhQ)


***


## Checklist<div id='id8'/>

### General

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

### `README.md`

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

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

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

### CLI

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

### Pruebas / tests

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

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