🚀 cursor-config

Configuração profissional do Cursor IDE com automação de commits atômicos, code review e Pull Requests

Automatize seu fluxo de trabalho Git no Cursor IDE com comandos inteligentes para commits atômicos, code review e Pull Requests.

✨ Features

• ✅ Commits Atômicos: Organiza alterações em commits isolados e bem estruturados
• ✅ Conventional Commits: Gera mensagens padronizadas automaticamente
• ✅ Code Review Inteligente: Revisa código e classifica problemas por severidade
• ✅ Pull Requests Automáticos: Cria PRs com GitHub CLI e templates
• ✅ Detecção de Erros: Encontra console.log, typos, problemas de segurança
• ✅ MCP Configurado: Git, Filesystem e GitHub MCPs prontos para usar
• ✅ Configuração Interativa de Tokens: Solicita tokens MCP durante instalação com validação e documentação integrada

🚀 Instalação Rápida

# Em qualquer projeto
npx cursor-config

Ou instale globalmente:

npm install -g cursor-config
cursor-config

📋 Pré-requisitos

• Node.js v18+
• Git
• GitHub CLI (opcional, para comando /PR): brew install gh

🎮 Comandos Disponíveis

CLI Commands

cursor-config              # Instala configuração no projeto atual
cursor-config create       # Cria novo projeto (Full-Stack ou React Native)
cursor-config --help       # Mostra ajuda
cursor-config --version    # Mostra versão
cursor-config --force      # Sobrescreve .cursor existente

Cursor IDE Commands

Após instalar, no chat do Cursor digite / para ver:

| Comando | Descrição | |---------|-----------| | /organize-commits | Analisa git status e organiza em commits isolados | | /commit | Gera commit atômico seguindo Conventional Commits | | /PR | Cria Pull Request com GitHub CLI | | /code review | Revisa código e classifica problemas (Crítico/High/Medium/Low) |

💡 Uso Rápido

Criar Novo Projeto

# Cria projeto Full-Stack ou React Native
npx cursor-config create

# Menu interativo pergunta:
# 1. Full-Stack Web (Next.js + NestJS)
# 2. React Native Mobile

Instalar Configuração em Projeto Existente

# 1. Instale no seu projeto
cd meu-projeto
npx cursor-config

# 2. Abra no Cursor
cursor .

# 3. Use os comandos
# No chat do Cursor:
# /code review      # Revisa código
# /organize-commits # Organiza commits
# /PR               # Cria Pull Request

📖 Exemplo Completo

# Trabalhe no código normalmente
vim src/feature.js

# No Cursor, revise antes de commitar
# /code review

# Organize as mudanças em commits atômicos
# /organize-commits

# Crie Pull Request
# /PR

🏗️ O que é Instalado

.cursor/
├── mcp.json              # Configuração MCP (Git, Filesystem, GitHub)
├── mcp.json.local        # Tokens MCP (criado durante instalação, não versionado)
├── rules.md              # Regras e padrões do projeto
├── commands/             # Comandos personalizados
│   ├── organize-commits.md
│   ├── commit.md
│   ├── PR.md
│   └── code-review.md
└── templates/
    └── pr-template.md    # Template de Pull Request

Nota: O arquivo mcp.json.local contém tokens sensíveis e está automaticamente no .gitignore. Nunca commite este arquivo!

🔐 Configuração de Tokens MCP

Durante a instalação, o cursor-config solicita interativamente os tokens necessários para os MCPs (Model Context Protocol). Isso permite que você configure tudo de uma vez, sem precisar editar arquivos manualmente.

Processo de Configuração

Quando você executa npx cursor-config, o CLI:

1. Verifica pré-requisitos (Node.js, Git, GitHub CLI)
2. Copia a configuração .cursor/ para seu projeto
3. Solicita tokens MCP (opcional, mas recomendado)
4. Cria mcp.json.local automaticamente com seus tokens

GitHub Personal Access Token

O GitHub MCP permite criar Pull Requests e interagir com repositórios. Para configurá-lo:

Durante a Instalação

O CLI mostra instruções passo a passo:

1. Acesse: https://github.com/settings/tokens/new
2. Dê um nome ao token (ex: "Cursor MCP")
3. Selecione os scopes necessários:
   • ✓ repo (acesso completo aos repositórios)
   • ✓ read:org (leitura de organizações)
4. Clique em "Generate token"
5. ⚠️ COPIE O TOKEN AGORA (você só verá uma vez!)
6. Cole o token quando solicitado pelo CLI

Validação Automática

O CLI valida automaticamente o formato do token:

• Tokens GitHub devem começar com ghp_ ou github_pat_
• Se o formato estiver incorreto, você pode confirmar mesmo assim

Configuração Manual (Depois)

Se você pulou a configuração durante a instalação, pode adicionar o token depois:

1. Crie o arquivo .cursor/mcp.json.local:

{
  "mcpServers": {
    "github": {
      "command": "npx",
      "args": ["-y", "@modelcontextprotocol/server-github"],
      "env": {
        "GITHUB_PERSONAL_ACCESS_TOKEN": "seu_token_aqui"
      }
    }
  }
}

2. Substitua seu_token_aqui pelo seu token GitHub

Segurança dos Tokens

🔒 Importante:

• O arquivo mcp.json.local está automaticamente no .gitignore
• NUNCA commite este arquivo no Git
• Tokens são salvos apenas localmente no seu projeto
• Cada desenvolvedor deve criar seu próprio token

Documentação Completa

Para mais informações sobre tokens GitHub:

• Criar Personal Access Token
• Scopes do GitHub API

📚 Documentação Completa

Para documentação completa, FAQ e troubleshooting, veja:

• Documentação Completa
• Guia de Uso
• FAQ

🔧 Opções

cursor-config              # Instala no projeto atual
cursor-config create       # Cria novo projeto
cursor-config --force      # Sobrescreve .cursor existente
cursor-config --help       # Mostra ajuda
cursor-config --version    # Mostra versão

🚀 Criar Projetos

O comando cursor-config create permite criar projetos inicializados com stacks modernas:

Full-Stack Web (Next.js + NestJS)

Inclui:

• Frontend: Next.js 14+ (App Router), TypeScript, Tailwind CSS, shadcn/ui, Zustand
• Backend: NestJS, TypeScript, Prisma, PostgreSQL, JWT Auth, Swagger
• DevOps: Docker Compose com PostgreSQL
• Arquitetura: SOLID, Clean Code, Atomic Design

Estrutura disponível:

• Monorepo: apps/frontend, apps/backend, packages/shared
• Separado: frontend/, backend/

React Native Mobile

Inclui:

• Framework: Expo com TypeScript
• Navigation: React Navigation
• State Management: Zustand
• Data Fetching: TanStack Query
• Storage: AsyncStorage
• Arquitetura: Atomic Design

Exemplo de Uso

$ npx cursor-config create

? Escolha o tipo de projeto:
  ❯ Full-Stack Web (Next.js + NestJS)
    React Native Mobile

? Estrutura do projeto Full-Stack:
  ❯ Monorepo (apps/ e packages/)
    Separado (frontend/ e backend/)

? Nome do projeto: meu-projeto

? Deseja instalar as dependências agora? (y/N) y

✅ Projeto criado em: ./meu-projeto
📦 Instalando dependências...
✅ Pronto! Execute: cd meu-projeto && npm run dev

🤝 Contribuindo

Contribuições são bem-vindas! Veja CONTRIBUTING.md para detalhes.

📝 Licença

MIT License - veja LICENSE para detalhes.

🔗 Links

• GitHub
• npm
• Cursor IDE

⭐ Star

Se este projeto te ajudou, considere dar uma ⭐ no GitHub!

Feito com ❤️ para automatizar seu fluxo de trabalho de desenvolvimento