@karlaguaita/md-links
v1.0.0
Published
libreria para extraer rutas de archivos md
Downloads
14
Maintainers
Readme
1. Preámbulo
es un lenguaje 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.
Objetivos de aprendizaje
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)
- [ ] Manipular objects (key | value)
- [x] Uso ES modules ([
import
]| [export
] - [x] Diferenciar entre expression y statements.
- [x] 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.
- [x] Instalar y usar módulos.
- [ ] Creación de modules. [(CommonJS)]
- [x] [Configuración de package.json.]
- [x] [Configuración de npm-scripts]
- [ ] Uso de CLI (Command Line Interface - Interfaz de Línea de Comando)
Testing
- [x] [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)
- [x] Uso de identificadores descriptivos (Nomenclatura | Semántica)
- [x] 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)
- [ ] Organización en Github (projects | issues | labels | milestones)
HTTP
- [ ] Verbos HTTP ([http.get]
Fundamentos de programación
- [ ] Recursión.
9. 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 enpackage.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
).