huskygpt

huskygpt

Ferramentas CLI Node.js para auto review de seu código ou auto generate de testes de unidade por OpenAI chatgpt3.5 e conta GPT-4 Plus! ✅

Demonstração

• ? Gere unit tests por modelo gpt-4:
• O resultado unit test :
• ? O arquivo de origem Translate mantém o mesmo formato e estrutura:
• Modify o código existente de acordo com seus requisitos de entrada, por exemplo

  Por favor, corrija bugs ou otimize meu código. se a função for complexa, por favor, fragmente-a. Se for um componente de função, use ganchos para otimizá-lo. E adicione comentários en e zh para etapas lógicas de complexidade, por exemplo // EN: alguns comentários, // ZH: 一些评论.

Principais recursos

• ? AI : review de código, modify , translate e geração test de unidade com tecnologia de IA
• Free : Gratuito para usar com um OpenAI Session Token , aproveite chatgpt-3.5 ou gpt-4 (conta Plus).
• ?️ Security : função consciente de segurança e extração de classe, personalize seu SECURITY_REGEX .
• ? Customizing : prompts personalizáveis ​​e seleção de modelo.
• File Reader : suporta a leitura de arquivos de directories ou git staged files .

Instalação

Para instalar huskygpt , execute o seguinte comando:

 npm install -g huskygpt

Configuração

Chave OpenAI (escolha uma)

• Defina a chave da API OpenAI por npm config set -g

   npm config set OPENAI_API_KEY <YOUR_OPENAI_KEY> -g
  

• Defina o OpenAI Session Token gratuitamente usando chatgpt
  • Token de sessão OpenAI, 2 setp para obter token
  • Se você não definir isso, usará OPENAI_API_KEY
  1. visite https://chat.openai.com/chat e faça login
  2. Visite https://chat.openai.com/api/auth/session para obter o token

  npm config set OPENAI_SESSION_TOKEN < YOUR_OPENAI_SESSION_TOKEN > -g

  3. Copie o arquivo .env para o diretório raiz do seu projeto e defina OPENAI_PROXY_URL .

Método	Livre?	Robusto?	Qualidade?
OpenAI Session Token	✅ Sim	☑️ Talvez	✅️ Bate-papo realGPT
OpenAI API Key	Não	✅ Sim	✅ Modelos reais de ChatGPT

Solicitação local

1. Crie um diretório prompt no diretório raiz do seu projeto.
2. Adicione review.txt ou tests.txt no diretório prompt .

Pré-comprometimento

1. rouco e em estágio de fiapos

    "husky": {
     "hooks": {
       "pre-commit": "huskygpt review && huskygpt test && lint-staged --allow-empty"
     }
   },
   

.gitignore :

 # review
.huskygpt_review.md
.env.local

Uso

• Execute o seguinte comando para review seus arquivos preparados do git:

   huskygpt review --model gpt-4 --max-tokens 2048
  

• Execute o seguinte comando para modify seu código existente:

   huskygpt modify -r dir -d src/pages/UserRegister/RegisterList.tsx -m gpt-4
  

• Execute o seguinte comando para gerar test de unidade:

   huskygpt test --model gpt-3.5-turbo --max-tokens 2048 --file-extensions .ts,.tsx --read-type dir --read-dir-name src --test-file-type test --test-file-extension .ts --test-file-dir-name tests
  

• Execute o seguinte comando para translate seus arquivos git testados:

   huskygpt translate -d example/i18n/test.json
  

Opções

• -k, --api-key <key> : Defina a chave da API OpenAI.
• -t, --openai-session-token <token> : token de sessão OpenAI, 2 etapas para obter o token. Se você não definir isso, usará OPENAI_API_KEY, causará taxa por chave API.
• -pu, --openai-proxy-url <url> : URL do proxy a ser usado para solicitações da API OpenAI.
• -m, --model <model> : modelo OpenAI a ser usado.
• -p, --prompt <prompt> : prompt do OpenAI para usar.
• -mt, --max-tokens <tokens> : máximo de tokens OpenAI a serem usados.
• -e, --file-extensions <extensions> : Extensões de arquivo para leitura, exemplo: .ts,.tsx
• -r, --read-type <type> : lê arquivos do diretório ou estágio git, exemplo: dir ou git.
• -s, --read-git-status <name> : lê arquivos do estágio git por status padrão: A,R,M.
• -d, --read-dir-name <name> : Nome raiz do diretório de onde ler os arquivos, exemplo: src.
• -f, --test-file-type <type> : Gera o tipo de arquivo de teste, exemplo: teste ou especificação.
• -n, --test-file-dir-name <name> : Gera o nome do diretório do arquivo de teste, exemplo: testes .
• -o, --test-file-overwrite <value> : Gera a substituição do arquivo de teste, o padrão é verdadeiro.
• -w, --review-report-webhook <url> : URL do webhook para enviar o relatório de revisão.

Opções de variáveis ​​de ambiente

Consulte o arquivo .env .

Observação

1. Também é possível definir todas as opções em .env ou .env.local , que serão usadas como opções padrão. As opções de comando substituirão as opções padrão.
2. Atualmente, o webhook é testado apenas no seaTalk . Se outro canal precisar ser usado, aumente PR sozinho ou peça ajuda.