md-links-juciele-gomes v0.1.0
mdLinks Library
Índice
- 1. Prefácio
- 2. Resumo do projeto
- 3. Fluxograma
- 4. Instalação
- 5.Comando do terminal
- 6. Testes unitários
- 7. CheckList
- 10. Desenvolvedora
1. Prefácio
O Markdown é uma linguagem de marcação leve e popular que foi criada para simplificar a formatação de texto em documentos, especialmente para a web. Foi desenvolvido por John Gruber e Aaron Swartz em 2004, e desde então, tornou-se amplamente adotado por sua simplicidade e facilidade de uso.
O principal objetivo do Markdown é permitir que as pessoas escrevam documentos com formatação de maneira rápida e intuitiva, sem a necessidade de aprender linguagens de marcação complexas, como HTML. Com o Markdown, você pode criar facilmente títulos, listas, links, citações, tabelas e muito mais, usando uma sintaxe simples baseada em texto.
A simplicidade do Markdown o torna uma escolha popular entre escritores, blogueiros, desenvolvedores e qualquer pessoa que queira criar conteúdo na web sem se preocupar com detalhes técnicos. Neste prefácio, exploraremos os conceitos básicos do Markdown e forneceremos exemplos para ajudá-lo a começar a usar essa linguagem de marcação de forma eficaz.
2. Resumo do projeto
Este é o projeto 4 do bootcamp Laboratória turma SAP-011, o projeto tem como objetivo a criação de ferramenta de linha de comando (CLI) assim como a sua própria biblioteca (library) em Javascript e executada com Node.js.
Neste projeto temos como foco aprender sobre processos, como interagir com sistemas de arquivos, como fazer consultas de rede, etc.
Desenvolver sua própria biblioteca é uma experiência fundamental para qualquer desenvolvedora, pois te obriga a pensar na interface (API) dos seus módulos e como ela será usada por outras desenvolvedoras.
3. Fluxograma
4. Instalação
Para instalçao da biblioteca utilize o comando:
npm install mdLinks
5. Comandos no terminal
5.1 Extração dos links:
Para extração e leitura dos links do arquivo .md, utilize o comando:
mdLinks <caminho-do-arquivo>
5.2 Gerar dados estátisticos:
Para gerar dados estátisticos dos links contidos no arquvivo .md utilize o comando:
mdLinks <caminho-do-arquivo> --stats
5.3 Validação:
Para validar os links contidos no arquvivo .md utilize o comando:
mdLinks <caminho-do-arquvivo> --validate
5.4 Validar e gerar dados estátisticos:
Para validar os links e gerar dados estaticos dos links, utilize o comando:
mdLinks <caminho-do-arquivo> --validate --stats
5.6 Mensagens de erro:
A partir dos comandos inseridos no terminal podem ser geradas algumas mensagens de erro.
Caso o caminho do arquivo inserido não seja .md a seguinte mensagem de erro será mostrada no terminal:
Caso o arquivo não possua links ou esteja vazio sera mostrada a seguinte mensagem de erro no terminal:
6. Testes unitários
🗹 7. CheckList
- Poder instalar via npm install
- Guia de uso e instalação da biblioteca
- Possuir o executável md-links no path (configurado no package.json)
- Executar sem erros e ter o resultado esperado
- Implementar --validate
- Implementar --stats
- Os testes unitários devem cobrir no mínimo 70% dos statements, functions, lines e branches.
Ferramentas e tecnologias utilizadas
👩💻 Desenvolvedora
6 months ago