CLI Made

CLI Made é uma ferramenta de linha de comando desenvolvida pela MadeInWeb para auxiliar no gerenciamento e configuração de projetos. Atualmente, a ferramenta oferece as seguintes funcionalidades:

• 🔐 Autenticação integrada com o sistema MadeInWeb
• 📝 Geração automática de arquivos .env baseados na configuração do projeto
• 🔄 Gerenciamento de configurações de projeto via package.json
• 🛠️ Interface interativa via linha de comando

A ferramenta é projetada para simplificar o processo de configuração e manutenção de projetos, garantindo consistência e segurança no ambiente de desenvolvimento.

Tech Stacks

• Inquirer.js
• c12

Requisitos

• Node.js na versão 22.14.0

🚀 Desenvolvendo

Instale as dependências

  npm install

Builde o projeto

  npm run build

📖 Guia de Uso

Instalação Global

Para utilizar o CLI Made em qualquer projeto, primeiro instale-o globalmente:

npm install -g @madeinweb/cli-made-front

Gerando o arquivo .env

O CLI Made oferece uma forma simples e segura de gerar arquivos de ambiente (.env) para seus projetos. Siga os passos:

1. Configure o projeto

   • Adicione a chave do projeto:

   package.json

   {
     "name": "seu-projeto",
     "projectKey": "chave-do-seu-projeto"
     // ... outras configurações
   }

   pyproject.toml

    projectKey = "chave-do-seu-projeto"
   
    [tool.poetry]
    name = "seu-projeto"

2. Execute o CLI

   made-cli

3. Autenticação

   • Na primeira execução, você será solicitado a fazer login
   • Informe seu email MadeInWeb
   • Digite sua senha
   • O token de acesso será armazenado automaticamente

4. Menu de Opções

   • Selecione "Gerador de ENV" no menu interativo
   • O CLI irá:
     • Validar suas credenciais
     • Buscar as configurações do projeto
     • Gerar o arquivo .env com as variáveis necessárias
     • Posicionar o arquivo na raiz do projeto

5. Verificação

   • Confira se o arquivo .env foi gerado corretamente
   • As variáveis estarão prontas para uso no seu projeto

✔️ Pre-Commit e Pre-Push Hooks

🔒 Sobre os Hooks

Este projeto utiliza hooks de pre-commit e pre-push para garantir a qualidade e a consistência do código. Antes de cada commit/push, o código passa por um processo de formatação e verificação de lint. Isso ajuda a manter um padrão de código e reduzir a possibilidade de erros.

⚙️ Fluxo de Trabalho

Antes de realizar um commit ou um push, é importante executar os seguintes comandos para garantir que seu código esteja de acordo com as diretrizes do projeto:

  npm run lintfix

Idealizado por @RobertoC-fly 🚀🤖

API e revisão por @cpvasques 🎸🦇🤘