nangebav / lim014-mdlinks Goto Github PK

This project forked from laboratoria/lim014-mdlinks

0.0 0.0 0.0 153 KB

La librería MDLINKS014 permite acceder a los archivos markdown encontrando los links que contienen, así como permitir validar la cantidad , ubicación y estado de los links.

JavaScript 47.95% CSS 6.82% HTML 45.23%

lim014-mdlinks's Introduction

Markdown Links

Preámbulo

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).

Planteamiento del problema

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.

Resumen del proyecto

Crear una herramienta usando Node.js, que lea y analice archivos en formato Markdown, para verificar los links que contengan y reportar algunas estadísticas.

`Logo de md-links`

1. Diagramas de Flujo

Primer prototipo de diagrama de flujo API

A base de este primer prototipo se recibió los siguientes feedbacks y recomendaciones para la mejora del diagrama

FeedBacks:
    - "El diagrama no cuenta con la lectura de archivos al ingresar las rutas"
    - "En la condición de que si no es una ruta abasoluta y debería convertirse en una, es redundante volver a preguntar si lo es, lo más recomendable es            
    que es hacer la busqueda de directorios y archivos en ese momento"
    - "Agregar la lectura de archivos"

Diagrama de flujo API FINAL

Diagrama de flujo CLI FINAL

Guía de uso e instalación de la librería

Para la instalación se debe colocar el siguiente comando:

Linux:

sudo npm install -g nangebav/LIM014-mdlinks

El ejecutable de esta aplicación se ejecuta de la siguiente manera a través de la terminal:

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

Options

`not option`

Para extraer los links de una ruta de un archivo Markdown, se coloca lo siguiente:

$ md-links <path-to-file>

Ejemplo:

`--validate`

Si pasamos la opción --validate o -v o validate link, el módulo debe hacer 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 consideraremos el link como ok.

$ md-links <path-to-file> --validate

Por ejemplo:

Vemos que el output en este caso incluye la palabra ok o fail después de la URL, así como el status de la respuesta recibida a la petición HTTP a dicha URL.

`--stats`

Si pasamos la opción --stats o -s o statistic el output (salida) será un texto con estadísticas básicas sobre los links.

$ md-links <path-to-file> --stats

Por ejemplo:

`--stats --validate`

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

$ md-links <path-to-file> --stats --validate

Por ejemplo:

`--help`

Si deseas conocer sobre los comandos que puedes usar, ingresa este

$ md-links <path-to-file> --help

Por ejemplo:

Próximas Mejoras

Que la librería entregue estadisticas más completas en el comando de validate
Tal vez que los links estén ordenados según si están ok o fail

JavaScript

Node

Uso de sistema de archivos. (fs, path)
Instalar y usar módulos. (npm)
Creación de modules. (CommonJS)
Configuración de package.json.
Configuración de npm-scripts
Uso de CLI (Command Line Interface - Interfaz de Línea de Comando)

Testing

Estructura del código y guía de estilo

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

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

HTTP

Verbos HTTP (http.get)

Fundamentos de programación

Recursión.

General

Puede instalarse via npm install --global <github-user>/md-links

`README.md`

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

API `mdLinks(path, opts)`

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

CLI

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

Pruebas / tests

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

lim014-mdlinks's People

Contributors

lim014-mdlinks's Issues

Testear función para lectura de mi directorio

Función para retornar el arreglo con el status

Función CLI stats

Diagrama de Flujo

Hacer el diagrama de flujo para API y pedir feedback.
Modificar el diagrama de flujo API con las nuevas sugerencias y volver a pedir feedback
Hacer el diagrama de flujo para CLI y pedir feedback.
Modificar el diagrama de flujo CLI con las nuevas sugerencias y volver a pedir feedback

Crear diagrama de flujo

Creación de los milestones, issues y labels

Crear diagrama de flujo

Funciones para conseguir el total, broken y unique de links

Función para validar si el archivo es formato .md

**Testeo de la función

Función CLI stats validate

Función para validar si es directorio

stats.isFile():Devuelve verdadero si el objeto <fs.Stats> describe un directorio del sistema de archivos..

Testeo de la función

almacenar valores

href:,
text:,
file:

Reconocer el tipo de Ruta (Relativa o Absoluta)

[ ] Investigar el método path.is Absolute.
[ ] Armar la estructura de lo que quiero ingresar y lo que quiero recibir.

Historia de Usuario 1

Averiguar un metodo para que los links de los archivos md esten dentro de un mismo array

Crear comando md-links

Estilos a la terminal del CLI

Función para validar si una ruta es absoluta, de lo contrario convertirla en absoluta

El método path.isAbsolute () determina si la ruta es una ruta absoluta.
El método path.resolve () resuelve una secuencia de rutas o segmentos de ruta en una ruta absoluta.

Clonar repositorio

Redacción del Readme

Descripción del módulo
Estructura del diagrama de Flujo del módulo
Instrucciones de instalación/uso fácil de comprender

Ingresar Ruta

Función para validar si es un archivo

stats.isFile():Devuelve verdadero si el objeto <fs.Stats> describe un directorio del sistema de archivos..

**Testeo de la función

Función para traer solo los links en un archivo md con las expresiones regulares

Testear Función para lectura de mi archivo md

Estructura de carpetas del proyecto

Definir como se van a distribuir las carpetas del proyecto.

testeo de promesa

Investigación

Node
Es un entorno de ejecución de javascript, es decir interpreta el código js.

Markdown

¿Qué es un API?

Rutas absolutas y relativas

File System

Expresiones Regulares

Librerias y frameworks

Una librería nos proporciona una serie de funciones/métodos muy concretos para simplificar tareas complejas y no necesitamos alterar nuestra estructura. Un claro ejemplo es jQuery ya que nos da funciones sencillas para manejo del DOM, para comunicación AJAX y entre otros.

Un framework es más que una librería porque aporta una estructura completa en la que nosotros “encajamos” nuestro código, impone las condiciones y debemos respetarlas.

Es decir, en una librería tu código es el que está al mando y utiliza las funciones de la librería cuando y como quiere. En un framework, éste es el que está al mando y tu código debe encajarse en su estructura y normas.

Para saber si lo que estamos por usar es un framework o librería, podemos apoyarnos en su propia documentación y así utilizamos el término que le corresponde.

En cuanto a los paquetes y módulos encontré que:
Un paquete es un archivo o directorio que se describe en package.json
Un módulo es cualquier archivo o directorio que Node.js puede cargar con require()

path.extname():Reconoce la extención de un archivo ejm: "path.extname('uno.md') returns en .md"

Leer los directorios que estén dentro del directorio y extraer sus archivos .md
Leer los archivos que estén dentro del directorio, solo buscar los que son .md

Función para comprobar si el archivo o directorio existe

fs.statSync():Acepta la opción "throwIfNoEntry" para especificar si se debe lanzar una excepción si la entrada no existe

Testeo de la función

Nombre
Versión
Descripción
Autor

Scripts

pretest
test

Dependencias

Hacer la función para validar si una ruta existe

fs.existsSync()
Prueba sincrónicamente si existe o no la ruta dada comprobando con el sistema de archivos.

Si es relativa false
Si es absoluta true

nangebav / lim014-mdlinks Goto Github PK

lim014-mdlinks's Introduction

Markdown Links

Preámbulo

Planteamiento del problema

Resumen del proyecto

Logo de md-links

1. Diagramas de Flujo

Primer prototipo de diagrama de flujo API

Diagrama de flujo API FINAL

Diagrama de flujo CLI FINAL

Guía de uso e instalación de la librería

Options

not option

--validate

--stats

--stats --validate

--help

Próximas Mejoras

JavaScript

Node

Testing

Estructura del código y guía de estilo

Git y GitHub

HTTP

Fundamentos de programación

General

README.md

API mdLinks(path, opts)

CLI

Pruebas / tests

lim014-mdlinks's People

Contributors

lim014-mdlinks's Issues

Recommend Projects

Recommend Topics

Recommend Org

`Logo de md-links`

`not option`

`--validate`

`--stats`

`--stats --validate`

`--help`

`README.md`

API `mdLinks(path, opts)`