1.0.0 • Published 6 years ago

cmg-url-of-string v1.0.0

Weekly downloads
3
License
ISC
Repository
github
Last release
6 years ago

Biblioteca - Extrair links de arquivo markdown/string

Descrição

Implementa um módulo de Node.js que receba uma string (em formato Markdown) e extraia todos os links encontrados. A implementação é uma função que recebe uma string e devolve um vetor de objetos.

Documentação

  • Função getLinksFromMd sendo string o texto que será analisado. A função irá retornar uma array de objetos com os links e os nomes dos mesmos.

Instalação

  • É necessário ter o node + npm instalados. Para guia de instalação, visite o site oficial.
  • A seguir, instale $npm install cmg-url-of-string
Versão 1.0.0
  1. Testes: A biblioteca será testada através da função getLinksFromMd()
  • Quando não houver parâmetro lançar um erro.
  • Quando o texto for um numero deve lançar um erro.
  • Quando o texto for uma string e não houver url deve retornar um array vazio.
  • Quando o texto for uma string e houver uma url deve retornar um array com o objeto com a url e o link do markdown.
  • Quando o texto for uma string e houver três urls diferentes deve retornar o objeto dentro do array.
  1. README.md com
    • descrição do módulo
    • instruções de instalação
    • instruções de uso
    • documentação da API.
  2. index.js:
    • Biblioteca exportar uma função ou objeto no escopo global (window) e
    • usa features de ES6 onde é apropriado.
  3. package.json com
    • nome,
    • versão,
    • descrição,
    • autores,
    • licença,
    • dependências,
    • scripts (pretest, test, ...)
  4. test/index.spec.js: com as rotinas de teste escritas para esta biblioteca. Os testes devem ser implementado
    • com Mocha
    • [] e NYC
  5. .gitignore - x para ignorar node_modules ou outras pastas que não devem ser incluídas no controle de versões (git). teste
  6. .eslintrc
    • com configuração para linter (com guia de estilo de JavaScript)