Giter Club home page Giter Club logo

lim015-md-links's Introduction

MarkLink

Índice


1. Resumen del proyecto

Este proyecto consta en la creación de una herramienta de línea de comando (CLI) así como una propia librería (o biblioteca - library) en JavaScript.

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

2. Diagrama de Flujo

3. Instalación y guía de uso de la librería

La libreria se instala usando la siguiente vía:

npm i marklink

Una vez que el usuario tenga instalada la librería marklink, va a tener las siguientes herramientas:

  • En el terminal ingresamos el comando global md-link seguido de la dirección de la ubicación del archivo y/o carpeta de la cual queremos saber cuales son los links existentes en ese archivo y su texto descriptivo. Ejemplo:

file

  • Si ingresamos el comando global md-link seguido de la dirección de la ubicación del archivo y seguido del comando --validate obtendremos las propiedades de los links que encontramos en ese archivo. Ejemplo:

validate

  • Si ingresamos el comando global md-link seguido de la dirección de la ubicación del archivo y seguido del comando --stats obtendremos la cantidad total de links que encontremos en ese archivo y el total de links unicos encontrados:

stats

  • Si ingresamos el comando global md-link seguido de la dirección de la ubicación del archivo y seguido de los comandos --stats --validate obtendremos la cantidad total de links que encontremos en ese archivo, el total de links unicos encontrados y el total de links rotos:

stats y validate

  • Si ingresamos el comando global md-link seguido de la dirección de la ubicación del archivo y seguido del comando --help obtendremos un texto de ayuda como el siguiente:

help

Para mayor información visite MarkLink.

4. Características técnicas

El proyecto se realizó bajo estas características técnicas de javascript y node:

JavaScript

Node.js

Control de Versiones (Git y GitHub)

  • Git: Instalación y configuración

  • Git: Control de versiones con git (init, clone, add, commit, status, push, pull, remote)

  • Git: Integración de cambios entre ramas (branch, checkout, fetch, merge, reset, rebase, tag)

  • GitHub: Creación de cuenta y repos, configuración de llaves SSH

  • GitHub: Despliegue con GitHub Pages

    Links

  • GitHub: Colaboración en Github (branches | forks | pull requests | code review | tags)

  • GitHub: Organización en Github (projects | issues | labels | milestones | releases)

HTTP

5. Autora

Dafne Aquino Manyari - LIM015 Laboratoria.

lim015-md-links's People

Contributors

dafneaquino avatar genesismauries avatar

Stargazers

 avatar

lim015-md-links's Issues

Creación de archivo cli.js

  • Agregar condición en caso el usuario escriba un comando o argumento
  • Si el usuario pone 2 comandos
  • Si el usuario pone 3 comandos

Test de los métodos de FS y path

  • routeExistence
  • pathValidate
  • convertRoute
  • routeState
  • routeIsDir
  • routeIsFile
  • routeExtension
  • readDir
  • joinPaths
  • mdFilesPath
  • propsLink
  • getStatusLink

Acciones de path y FS (FileSystem)

  • Crear archivos de prueba
  • Validar si existe la ruta
  • Validar si la ruta es absoluta y si es relativa convertirla a absoluta
  • Validar si es una carpeta, directorio
  • Validar si es un archivo
  • Validar en que extensión acaba la ruta (ejem: .md, .txt, .js)
  • Leer o Recorrer los archivos en caso sea una carpeta
  • Unir dos rutas para conocer la ubicación de los archivos de una carpeta o directorio
  • Función para Leer contenido de archivos .md
  • Función recursiva para obtener rutas absolutas de archivos .md y ponerlos en un array.
  • Función para extraer cada link de archivos .md con sus propiedades y meterlos en un array(con regex)
  • Función con promesas devuelto por el comando global "fetch" para obtener el estatus de los links mark-down.

Creación del archivo options

  • Función para obtener la cantidad total de links encontrados(cada objeto)
  • Función para obtener links únicos (unique)
  • Función para obtener links rotos (broken)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.