huskygpt

huskygpt

¡Herramientas CLI de Node.js para auto review su código o auto generate pruebas unitarias mediante OpenAI chatgpt3.5 y cuenta GPT-4 Plus! ✅

Manifestación

• ? Generar unit tests por modelo gpt-4:
• El resultado unit test :
• ? Translate el archivo fuente mantiene el mismo formato y estructura:
• Modify el código existente según sus requisitos de entrada, por ejemplo

  Corrija errores u optimice mi código. Si la función es compleja, fragmentela. Si es un componente de función, utilice ganchos para optimizarlo. Y agregue comentarios en y zh para pasos lógicos complejos, por ejemplo // EN: algunos comentarios, // ZH: 一些评论.

Características clave

• ? AI : review , modify , translate y generación test unitarias de código impulsadas por IA
• Free : Gratis para usar con un OpenAI Session Token , disfrute de chatgpt-3.5 o gpt-4 (Cuenta Plus).
• ?️ Security : extracción de clases y funciones conscientes de la seguridad, personalice su SECURITY_REGEX .
• ? Customizing : indicaciones personalizables y selección de modelo.
• File Reader : admite la lectura de archivos de directories o git staged files .

Instalación

Para instalar huskygpt , ejecute el siguiente comando:

 npm install -g huskygpt

Configuración

Clave OpenAI (elija una)

• Configure la clave API de OpenAI mediante npm config set -g

   npm config set OPENAI_API_KEY <YOUR_OPENAI_KEY> -g
  

• Configure el OpenAI Session Token de forma gratuita usando chatgpt
  • Token de sesión de OpenAI, 2 pasos para obtener el token
  • Si no configura esto, usará OPENAI_API_KEY
  1. visita https://chat.openai.com/chat e inicia sesión
  2. Visite https://chat.openai.com/api/auth/session para obtener el token

  npm config set OPENAI_SESSION_TOKEN < YOUR_OPENAI_SESSION_TOKEN > -g

  3. Copie el archivo .env al directorio raíz de su proyecto y configure OPENAI_PROXY_URL .

Método	¿Gratis?	¿Robusto?	¿Calidad?
OpenAI Session Token	✅ Sí	☑️ Quizás	✅️Chat realGPT
OpenAI API Key	No	✅ Sí	✅ Modelos reales de ChatGPT

aviso local

1. Cree un directorio prompt en el directorio raíz de su proyecto.
2. Agregue review.txt o tests.txt en el directorio prompt .

Compromiso previo

1. etapa ronca y pelusa

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

.gitignore :

 # review
.huskygpt_review.md
.env.local

Uso

• Ejecute el siguiente comando para review sus archivos preparados de git:

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

• Ejecute el siguiente comando para modify su código existente:

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

• Ejecute el siguiente comando para generar test unitaria:

   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
  

• Ejecute el siguiente comando para translate sus archivos preparados de git:

   huskygpt translate -d example/i18n/test.json
  

Opciones

• -k, --api-key <key> : establece la clave API de OpenAI.
• -t, --openai-session-token <token> : token de sesión de OpenAI, 2 pasos para obtener el token. Si no configura esto, usará OPENAI_API_KEY, generará una tarifa por clave API.
• -pu, --openai-proxy-url <url> : URL de proxy que se utilizará para las solicitudes de API de OpenAI.
• -m, --model <model> : modelo OpenAI a utilizar.
• -p, --prompt <prompt> : mensaje de OpenAI para usar.
• -mt, --max-tokens <tokens> : tokens máximos de OpenAI para usar.
• -e, --file-extensions <extensions> : Extensiones de archivo para leer, ejemplo: .ts,.tsx
• -r, --read-type <type> : lee archivos del directorio o etapa git, ejemplo: dir o git.
• -s, --read-git-status <name> : lee archivos desde git stage por estado predeterminado: A,R,M.
• -d, --read-dir-name <name> : nombre raíz del directorio desde el que leer archivos, ejemplo: src.
• -f, --test-file-type <type> : genera el tipo de archivo de prueba, ejemplo: prueba o especificación.
• -n, --test-file-dir-name <name> : genera el nombre del directorio del archivo de prueba, ejemplo: pruebas .
• -o, --test-file-overwrite <value> : Genera sobrescritura del archivo de prueba, el valor predeterminado es verdadero.
• -w, --review-report-webhook <url> : URL del webhook para enviar el informe de revisión.

Opciones de variables de entorno

Ver archivo .env .

Nota

1. También puede configurar todas las opciones en .env o .env.local , que se usarán como opciones predeterminadas. Las opciones de comando anularán las opciones predeterminadas.
2. Actualmente, el webhook solo se prueba en seaTalk ; si es necesario utilizar otro canal, aumente PR usted mismo o pídame ayuda.