Markdown Links

Índice

• Markdown Links
  • Índice
  • 1. Preámbulo
  • 2. Resumen del desarrollo del proyecto
  • 3. Diagrama de flujo
  • 4. Instalación
  • 5. Uso de Cli
  • 6. Objetivos de aprendizaje
    • JavaScript
    • Node
    • Testing
    • Estructura del código y guía de estilo
    • Git y GitHub
    • HTTP
    • Fundamentos de programación
  • 7. Checklist
    • General
    • README.md
    • API mdLinks(path, opts)
    • CLI
    • Pruebas / tests

1. Preámbulo

Este es el cuarto proyecto que desarrollamos en el Bootcamp de [Laboratoria]. El objetivo principal de aprendizaje en este proyecto es crear una herramienta de línea de comando (CLI) así como una libreria propia (o biblioteca - library) en JavaScript.

2. Resumen del desarrollo del proyecto

Tras leer el [README]Comencé la planeación de la función principal con su respectivo diagrama de flujo, donde se llevó a cabo una sesión de feedback todos los dias donde tuvimos la oportunidad de hacer mejoras y mostrar los avances. Forkeamos el proyecto base, lo desarrollamos localmente, desarrollamos la estructura básica en index.js, luego me enfoque en la función mientras generaba recursos con node.js e interactuábamos con git y asi mismo me enfoque en manipular las funciones para testearlas.

3. Diagrama de flujo

4. Instalación

$ npm install -g loregunner/bog001-md-links

5. Uso de Cli

Recibe como comandos el nombre mdlinks y el nombre de una archivo ".md" o una carpeta que contenga un archivo ".md".

Al ejecutar el siguiente comando, te imprime un arreglo de objetos con href, el titulo dado al enlace, el archivo donde se encontró el enlace

$ mdlinks <path>

 {
    text: 'marked',
    href: 'https://github.com/markedjs/marked',
    file: 'C:\\Users\\Asus\\Documents\\bog001-md-links\\ArchivosMD\\testREADME.md'
  },

Al ejecutar el siguiente comando, te imprime un arreglo de objetos con href, el titulo dado al enlace, el archivo donde se encontró el enlace, pero le agregamos la validación con status

$ mdlinks <path> --validate

{
    href: 'http://kissmanga.com/',
    text: ' 5. Kissmanga',
    file: 'C:\\Users\\Asus\\Documents\\bog001-md-links\\ArchivosMD\\testREADME.md',
    status: 404,
    validate: 'fail'
  }

Si ejecutas el siguiente comando con --stats, te muestra cuantos enlaces hay en total y cuantos son únicos

$ mdlinks <path> --stats

  Total: 70
  unique: 65

Si ejecutas el siguiente comando con --validate --stats, verifica el status de los links y te imprime cuantos enlaces hay en total, cuantos son únicos y cuantos están rotos

$ mdlinks <path> --stats --validate

     {
    href: 'http://kissmanga.com/',
    text: ' 5. Kissmanga',
    file: 'C:\\Users\\Asus\\Documents\\bog001-md-links\\ArchivosMD\\testREADME.md',
    status: 404,
    validate: 'fail'
    }
   Total: 70
   unique: 65
   broken: 12

6. Objetivos de aprendizaje

Diseñar tu propia librería es una experiencia fundamental para cualquier desarrollador porque que te obliga a pensar en la interfaz (API) de tus módulos y cómo será usado por otros developers. Debes tener especial consideración en peculiaridades del lenguaje, convenciones y buenas prácticas.

A continuación puedes ver los objetivos de aprendizaje de este proyecto:

JavaScript

• Uso de condicionales (if-else | switch | operador ternario)
• Uso de funciones (parámetros | argumentos | valor de retorno)
• Manipular arrays (filter | map | sort | reduce)
• Manipular objects (key | value)
• Uso ES modules (import | export)
• Diferenciar entre expression y statements.
• Diferenciar entre tipos de datos atómicos y estructurados.
• Uso de callbacks.
• Consumo de Promesas.
• Creación de Promesas.

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

• Testeo unitario.
• Testeo asíncrono.
• Uso de librerias de Mock.
• Uso de Mocks manuales.
• Testeo para múltiples Sistemas Operativos.

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.

---

Agrego la checklist para complementar

7. Checklist

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