huskygpt

huskygpt

Alat CLI Node.js untuk auto review atau auto generate dengan OpenAI chatgpt3.5 dan Akun GPT-4 Plus! ✅

Demo

• ? Hasilkan unit tests dengan model gpt-4:
• Hasil unit test :
• ? Translate file sumber dengan format dan struktur yang sama:
• Modify kode yang ada berdasarkan kebutuhan input Anda, misalnya

  Harap perbaiki bug atau optimalkan kode saya. jika fungsinya rumit, silakan potong. Jika itu komponen fungsi, gunakan kait untuk mengoptimalkannya. Dan tambahkan komentar en dan zh untuk langkah logika kompleksitas misalnya // EN: beberapa komentar, // ZH: 一些评论.

Fitur Utama

• ? AI : review kode yang didukung AI, modify , translate , dan pembuatan test unit
• Free : Gratis untuk digunakan dengan OpenAI Session Token , nikmati chatgpt-3.5 atau gpt-4 (Akun Plus).
• ?️ Security : Fungsi sadar keamanan dan ekstraksi kelas, sesuaikan SECURITY_REGEX Anda.
• ? Customizing : Perintah dan pemilihan model yang dapat disesuaikan.
• File Reader : Mendukung pembacaan file dari directories atau git staged files .

Instalasi

Untuk menginstal huskygpt , jalankan perintah berikut:

 npm install -g huskygpt

Konfigurasi

Kunci OpenAI (Pilih salah satu)

• Setel Kunci API OpenAI dengan npm config set -g

   npm config set OPENAI_API_KEY <YOUR_OPENAI_KEY> -g
  

• Setel OpenAI Session Token secara gratis menggunakan chatgpt
  • Token sesi OpenAI, 2 setp untuk mendapatkan token
  • Jika Anda tidak menyetelnya, akan menggunakan OPENAI_API_KEY
  1. kunjungi https://chat.openai.com/chat dan masuk
  2. Kunjungi https://chat.openai.com/api/auth/session untuk mendapatkan token

  npm config set OPENAI_SESSION_TOKEN < YOUR_OPENAI_SESSION_TOKEN > -g

  3. Salin file .env ke direktori root proyek Anda, dan atur OPENAI_PROXY_URL .

Metode	Bebas?	Kokoh?	Kualitas?
OpenAI Session Token	✅ Ya	☑️ Mungkin	✅️ Obrolan NyataGPT
OpenAI API Key	TIDAK	✅ Ya	✅ Model ChatGPT nyata

Perintah lokal

1. Buat direktori prompt di direktori root proyek Anda.
2. Tambahkan review.txt atau tests.txt di direktori prompt .

Pra-Komitmen

1. tahap husky dan lint

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

.gitignore :

 # review
.huskygpt_review.md
.env.local

Penggunaan

• Jalankan perintah berikut untuk review file bertahap git Anda:

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

• Jalankan perintah berikut untuk modify kode yang ada:

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

• Jalankan perintah berikut untuk menghasilkan test unit:

   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
  

• Jalankan perintah berikut untuk translate file bertahap git Anda:

   huskygpt translate -d example/i18n/test.json
  

Pilihan

• -k, --api-key <key> : Menyetel kunci API OpenAI.
• -t, --openai-session-token <token> : Token sesi OpenAI, 2 langkah untuk mendapatkan token, Jika Anda tidak menyetelnya, akan menggunakan OPENAI_API_KEY, akan menyebabkan biaya berdasarkan kunci api.
• -pu, --openai-proxy-url <url> : URL proksi yang digunakan untuk permintaan OpenAI API.
• -m, --model <model> : Model OpenAI yang akan digunakan.
• -p, --prompt <prompt> : Perintah OpenAI untuk digunakan.
• -mt, --max-tokens <tokens> : Token maks OpenAI yang akan digunakan.
• -e, --file-extensions <extensions> : Ekstensi file yang akan dibaca, contoh: .ts,.tsx
• -r, --read-type <type> : Membaca file dari direktori atau tahap git, contoh: dir atau git.
• -s, --read-git-status <name> : Membaca file dari tahap git berdasarkan status default: A,R,M.
• -d, --read-dir-name <name> : Nama root direktori tempat file dibaca, contoh: src.
• -f, --test-file-type <type> : Menghasilkan tipe file pengujian, contoh: test atau spec.
• -n, --test-file-dir-name <name> : Menghasilkan nama direktori file pengujian, contoh: tes .
• -o, --test-file-overwrite <value> : Hasilkan penimpaan file uji, defaultnya benar.
• -w, --review-report-webhook <url> : URL webhook untuk mengirim laporan ulasan.

Opsi Variabel Lingkungan

Lihat file .env .

Catatan

1. Juga dapat mengatur semua opsi di .env atau .env.local , yang akan digunakan sebagai opsi default. Opsi perintah akan menggantikan opsi default.
2. Webhook saat ini hanya diuji di seaTalk , jika saluran lain perlu digunakan, silakan naikkan PR sendiri atau minta bantuan saya.