huskygpt

huskygpt

Node.js CLI-Tools zur auto review Ihres Codes oder auto generate von Unit-Tests über OpenAI chatgpt3.5 und GPT-4 Plus-Konto! ✅

Demo

• ? Generieren Sie unit tests nach dem GPT-4-Modell:
• Das unit test Ergebnis:
• ? Translate der Quelldatei behalten Sie das gleiche Format und die gleiche Struktur bei:
• Modify vorhandenen Code entsprechend Ihren Eingabeanforderungen, z

  Bitte beheben Sie Fehler oder optimieren Sie meinen Code. Wenn die Funktion komplex ist, teilen Sie sie bitte auf. Wenn es sich um eine Funktionskomponente handelt, optimieren Sie sie mit Hooks. Und fügen Sie en- und zh-Kommentare für Komplexitätslogikschritte hinzu, z. B. // EN: einige Kommentare, // ZH: 一些评论.

Hauptmerkmale

• ? AI : KI-gestützte review , modify , translate und Generierung von Unit- test
• Free : Kostenlose Nutzung mit einem OpenAI Session Token , genießen Sie chatgpt-3.5 oder gpt-4 (Plus-Konto).
• ?️ Security : Sicherheitsbewusste Funktion und Klassenextraktion, passen Sie Ihren SECURITY_REGEX an.
• ? Customizing : Anpassbare Eingabeaufforderungen und Modellauswahl.
• File Reader : Unterstützt das Lesen von Dateien aus directories oder git staged files .

Installation

Um huskygpt zu installieren, führen Sie den folgenden Befehl aus:

 npm install -g huskygpt

Konfiguration

OpenAI-Schlüssel (Wählen Sie einen aus)

• Legen Sie den OpenAI-API-Schlüssel mit npm config set -g fest

   npm config set OPENAI_API_KEY <YOUR_OPENAI_KEY> -g
  

• Legen Sie den OpenAI Session Token kostenlos mit chatgpt fest
  • OpenAI-Sitzungstoken, 2 Schritte, um das Token zu erhalten
  • Wenn Sie dies nicht festlegen, wird OPENAI_API_KEY verwendet
  1. Besuchen Sie https://chat.openai.com/chat und melden Sie sich an
  2. Besuchen Sie https://chat.openai.com/api/auth/session, um ein Token zu erhalten

  npm config set OPENAI_SESSION_TOKEN < YOUR_OPENAI_SESSION_TOKEN > -g

  3. Kopieren Sie .env Datei in Ihr Projektstammverzeichnis und legen Sie OPENAI_PROXY_URL fest.

Verfahren	Frei?	Robust?	Qualität?
OpenAI Session Token	✅ Ja	☑️ Vielleicht	✅️ Echter ChatGPT
OpenAI API Key	NEIN	✅ Ja	✅ Echte ChatGPT-Modelle

Lokale Eingabeaufforderung

1. Erstellen Sie ein prompt im Stammverzeichnis Ihres Projekts.
2. Fügen Sie review.txt oder tests.txt im prompt hinzu.

Vorab festlegen

1. Husky und Fusselstadium

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

.gitignore :

 # review
.huskygpt_review.md
.env.local

Verwendung

• Führen Sie den folgenden Befehl aus, um Ihre von Git bereitgestellten Dateien review :

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

• Führen Sie den folgenden Befehl aus, um Ihren vorhandenen Code modify :

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

• Führen Sie den folgenden Befehl aus, um einen test zu generieren:

   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
  

• Führen Sie den folgenden Befehl aus, um Ihre von Git bereitgestellten Dateien zu translate :

   huskygpt translate -d example/i18n/test.json
  

Optionen

• -k, --api-key <key> : Legt den OpenAI-API-Schlüssel fest.
• -t, --openai-session-token <token> : OpenAI-Sitzungstoken, 2 Schritte zum Erhalten des Tokens. Wenn Sie dies nicht festlegen, wird OPENAI_API_KEY verwendet, es wird eine Gebühr nach API-Schlüssel erhoben.
• -pu, --openai-proxy-url <url> : Proxy-URL zur Verwendung für OpenAI-API-Anfragen.
• -m, --model <model> : Zu verwendendes OpenAI-Modell.
• -p, --prompt <prompt> : Zu verwendende OpenAI-Eingabeaufforderung.
• -mt, --max-tokens <tokens> : Maximal zu verwendende OpenAI-Token.
• -e, --file-extensions <extensions> : Zu lesende Dateierweiterungen, Beispiel: .ts,.tsx
• -r, --read-type <type> : Liest Dateien aus dem Verzeichnis oder der Git-Stufe, Beispiel: dir oder git.
• -s, --read-git-status <name> : Liest Dateien von der Git-Stufe nach Statusstandard: A,R,M.
• -d, --read-dir-name <name> : Stammname des Verzeichnisses, aus dem Dateien gelesen werden sollen, Beispiel: src.
• -f, --test-file-type <type> : Testdateityp generieren, Beispiel: Test oder Spezifikation.
• -n, --test-file-dir-name <name> : Generiert den Namen des Testdateiverzeichnisses, Beispiel: Tests .
• -o, --test-file-overwrite <value> : Testdateiüberschreibung generieren, Standardwert ist „true“.
• -w, --review-report-webhook <url> : Webhook-URL zum Senden des Überprüfungsberichts.

Optionen für Umgebungsvariablen

Siehe .env Datei.

Notiz

1. Außerdem können alle Optionen in .env oder .env.local festgelegt werden, die als Standardoptionen verwendet werden. Befehlsoptionen überschreiben die Standardoptionen.
2. Webhook wird derzeit nur in seaTalk getestet. Wenn Sie einen anderen Kanal verwenden müssen, erhöhen Sie bitte PR selbst oder bitten Sie mich um Hilfe.