huskygpt

huskygpt

Outils CLI Node.js pour auto review votre code ou auto generate des tests unitaires par le compte OpenAI chatgpt3.5 et GPT-4 Plus ! ✅

Démo

• ? Générez unit tests par le modèle gpt-4 :
• Le résultat unit test :
• ? Translate le fichier source conserve le même format et la même structure :
• Modify le code existant en fonction de vos exigences d'entrée, par exemple

  Veuillez corriger les bugs ou optimiser mon code. si la fonction est complexe, veuillez la décomposer. S'il s'agit d'un composant fonctionnel, utilisez des hooks pour l'optimiser. Et ajoutez des commentaires en et zh pour les étapes logiques de complexité, par exemple // EN : quelques commentaires, // ZH : 一些评论.

Principales fonctionnalités

• ? AI : review , modify , translate et génération test unitaires de code basé sur l'IA
• Free : Utilisation gratuite avec un OpenAI Session Token , profitez de chatgpt-3.5 ou gpt-4 (compte Plus).
• ?️ Security : fonction soucieuse de la sécurité et extraction de classe, personnalisez votre SECURITY_REGEX .
• ? Customizing : invites personnalisables et sélection de modèle.
• File Reader : prend en charge la lecture de fichiers à partir de directories ou git staged files .

Installation

Pour installer huskygpt , exécutez la commande suivante :

 npm install -g huskygpt

Configuration

Clé OpenAI (choisissez-en une)

• Définir la clé API OpenAI par npm config set -g

   npm config set OPENAI_API_KEY <YOUR_OPENAI_KEY> -g
  

• Définissez gratuitement le OpenAI Session Token à l'aide de chatgpt
  • Jeton de session OpenAI, 2 étapes pour obtenir le jeton
  • Si vous ne définissez pas cela, utilisera OPENAI_API_KEY
  1. visitez https://chat.openai.com/chat et connectez-vous
  2. Visitez https://chat.openai.com/api/auth/session pour obtenir un jeton

  npm config set OPENAI_SESSION_TOKEN < YOUR_OPENAI_SESSION_TOKEN > -g

  3. Copiez le fichier .env dans le répertoire racine de votre projet et définissez OPENAI_PROXY_URL .

Méthode	Gratuit?	Robuste?	Qualité?
OpenAI Session Token	✅ Oui	☑️ Peut-être	✅️ Chat réelGPT
OpenAI API Key	Non	✅ Oui	✅ De vrais modèles ChatGPT

Invite locale

1. Créez un répertoire prompt dans le répertoire racine de votre projet.
2. Ajoutez review.txt ou tests.txt dans le répertoire prompt .

Pré-engagement

1. stade husky et charpie

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

.gitignore :

 # review
.huskygpt_review.md
.env.local

Usage

• Exécutez la commande suivante pour review vos fichiers intermédiaires git :

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

• Exécutez la commande suivante pour modify votre code existant :

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

• Exécutez la commande suivante pour générer test unitaire :

   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
  

• Exécutez la commande suivante pour translate vos fichiers préparés par git :

   huskygpt translate -d example/i18n/test.json
  

Possibilités

• -k, --api-key <key> : définit la clé API OpenAI.
• -t, --openai-session-token <token> : jeton de session OpenAI, 2 étapes pour obtenir le jeton, si vous ne définissez pas cela, utilisera OPENAI_API_KEY, entraînera des frais par clé API.
• -pu, --openai-proxy-url <url> : URL du proxy à utiliser pour les requêtes API OpenAI.
• -m, --model <model> : modèle OpenAI à utiliser.
• -p, --prompt <prompt> : invite OpenAI à utiliser.
• -mt, --max-tokens <tokens> : nombre maximum de jetons OpenAI à utiliser.
• -e, --file-extensions <extensions> : Extensions de fichiers à lire, exemple : .ts,.tsx
• -r, --read-type <type> : Lit les fichiers à partir du répertoire ou de l'étape git, exemple : dir ou git.
• -s, --read-git-status <name> : Lit les fichiers de l'étape git par statut par défaut : A,R,M.
• -d, --read-dir-name <name> : Nom racine du répertoire à partir duquel lire les fichiers, exemple : src.
• -f, --test-file-type <type> : Génère un type de fichier de test, exemple : test ou spec.
• -n, --test-file-dir-name <name> : Génère le nom du répertoire du fichier de test, exemple : tests .
• -o, --test-file-overwrite <value> : Génère l'écrasement du fichier de test, la valeur par défaut est true.
• -w, --review-report-webhook <url> : URL du Webhook pour envoyer le rapport de révision.

Options des variables d'environnement

Voir le fichier .env .

Note

1. Vous pouvez également définir toutes les options dans .env ou .env.local , qui seront utilisées comme options par défaut. Les options de commande remplaceront les options par défaut.
2. Webhook ne teste actuellement que dans seaTalk , si un autre canal doit être utilisé, veuillez augmenter PR par vous-même ou demandez-moi de l'aide.