Code Monkey home page Code Monkey logo

lim010-fe-md-links's Introduction

ayauri29@mdlinks

Build Status Coverage Status npm dependents

Md-links es una librería que brinda estadísticas sobre los links que se encuentren dentro de todos los archivos .md de una ruta dada.

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

Instalación

Instale ayauri29@mdlinks desde npm.

npm i @ayauri29/md-links

Uso

API mdLinks(path, opts)

La función tiene 2 parámetros:

  • Path: Ruta absoluta o relativa al archivo o directorio.
  • Opts: Un objeto con las siguientes propiedades:
    • validate: Booleano que determina si se desea validar los links encontrados.

El valor de retorno es una promesa (Promise) que resuelve un arreglo de objetos, donde cada objeto representa un link y contiene las siguientes propiedades:

  • href: URL encontrada.
  • text: Texto que aparecía dentro del link (<a>).
  • file: Ruta del archivo donde se encontró el link.
Ejemplo

Importe ayauri29@mdlinks desde su proyecto.

const fn = require('ayauri29@mdlinks');

Para validación de los links:

mdLinks.mdLinks('src', {validate: true}).then((data) => console.log(data));

image

Para validate false:

const mdLinks = require('@ayauri29/md-links');
mdLinks.mdLinks('src', {validate: false}).then((data) => console.log(data));

image

CLI

Uso de comandos
md-links <path-to-file> [options]
  • El ejecutable implementa --validate.

image

  • El ejecutable implementa --stats.

  • El ejecutable implementa --validate y --stats juntos.

  • El ejecutable no implementa ninguna opción.

  • Para ayuda puede ejecutar el comando md-links --help


Objetivos de aprendizaje

Objetivos de aprendizaje pendientes
  • Uso de callbacks
Javascript
  • Consumo de Promesas
  • Creacion de Promesas
  • Modulos de Js
  • Recursión

Node

  • Sistema de archivos
  • package.json
  • crear modules
  • Instalar y usar modules
  • npm scripts
  • CLI (Command Line Interface - Interfaz de Línea de Comando)

Testing

  • Testeo de tus funciones
  • Testeo asíncrono
  • Uso de librerias de Mock
  • Mocks manuales
  • Testeo para multiples Sistemas Operativos

Git y Github

  • Organización en Github

Buenas prácticas de desarrollo

  • Modularización
  • Nomenclatura / Semántica
  • Linting

Referencias

lim010-fe-md-links's People

Contributors

ayauri29 avatar danielalab avatar

Watchers

James Cloos avatar

lim010-fe-md-links's Issues

Code review

const isDirectory = (route) => {
if (fs.statSync(route).isDirectory()) {
return true;
}
return false;
};

Podrías refactorizar las funciones que retornen valores booleanos y dependan de una condición; para esto puedes intentar retornar directamente la condicion que evaluas dentro de if(condition) ya esta siempre resultara en un valor booleano.

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.