readme-cli-create, detalhes do projeto e minha primeira experiência desenvolvendo um projeto próprio e aberto ao público

Início da ideia

Depois de um bom tempo estudando JS, Node etc. e criando diversos repositórios no GitHub tive uma pequena ideia, algo que iria facilitar um pouco minha vida na hora de escrever os READMEs dos meus repositórios, surge então o readme-cli-create

O que é o projeto?

O projeto não é nada de mais, basicamente o que eu criei foi uma CLI (Command Line Interface) onde nela passamos alguns dados que vão melhor explicado mais a frente, com isso é gerado um arquivo README.md para ser usado no seu repositório GitHub, com uma estrutura já pré-definida e o suficiente para agilizar o processo e não ter que começar a escrever tudo do zero, a parte boa é que alem de tudo está CLI foi colocada no NPM, ou seja, você pode instalar ela na sua maquina de forma global e usa-lá em todas / grande maioria das pastas do seu PC.

Como funciona?

Depois de instalarmos ela basta usarmos o comando readme-cli-create no diretório que queremos criar o arquivo README.

Após rodarmos esse comando iremos receber algumas perguntas, onde as respostas que dermos vão ser usadas para já ajustar algumas partes do nosso arquivo.

A próxima etapa é com a CLI, ela irá verificar algumas coisas e se tudo der certo iremos ver uma tela parecida com essa dizendo que nosso arquivo foi gerado sem nenhum problema.

Após isso é podemos ver se realmente deu tudo certo vendo o arquivo em si.

Note que em algumas partes, como podemos ver na primeira imagem, que uma das nossas respostas foi usada para ser o título e a descrição do nosso arquivo README

E como está sendo a experiência de desenvolver isso?

Primeiro que esse projeto era pra ser algo particular, a ideia não era deixar ele público e muito menos publicar no NPM, então aqui temos a primeira grande mudança de como esta sendo desenvolver esse projeto, antes como era algo particular de certa forma eu não precisava me preocupar com alguns detalhes, agora com o projeto público isso já muda.

Em compensação a vontade agora é de expandir ainda mais essa ideia, melhorando a parte do usuário, colocando novos modelos para os READMEs, mas acima de tudo, conseguir aprender algo novo sempre, esse é outro ponto muito importante dessa jornada até aqui, aprender algo e realmente colocar isso em prática e até mesmo entendo melhor alguns conceitos ou ideias.

Confesso que já cai em alguns problemas durante o desenvolvimento que tive certa dificuldade para resolver, mas hoje já sei como posso passar por cima disso, um dos exemplos que mais me marcou foi a verificação para ver se já existe um arquivo "README.md" no diretório que o comando foi executado, tive sérios problemas nessa parte e resolvi isso depois com poucas linhas, talvez seja a melhor solução? Acho que com certeza não, mas por enquanto é o que da para ser feito.

Um detalhe importante que eu vejo que eu melhorei a na organização do que eu preciso fazer em relação ao projeto, realmente separar os problemas em partes menores, conseguir estruturar melhor as ideias e muito mais.

Essas são umas das coisas mais importantes que eu pude ver que aprendi fazendo esse projeto, além é claro do básico, que é entender mais a linguagem que usei e tudo mais.

Recomendações

Eu pessoalmente recomendo muito dar uma olhada no projeto no GitHub caso queira usa-lo, existem algumas coisas que não cheguei a explicar, como por exemplo o parâmetro "-y" na hora de executar o comando da CLI, isso pode fazer a diferença na hora de usar a CLI e lá também está tudo mais detalhado sobre o projeto, o que é necessário ter no PC para usar a CLI e muito mais.

GitHub: readme-cli-create

NPM: readme-cli-create

Linkedin: Luigi Belanda