huskygpt

แหบแห้ง

เครื่องมือ Node.js CLI สำหรับ auto review หรือ auto generate โดยบัญชี OpenAI chatgpt3.5 และ GPT-4 Plus!

สาธิต

• - สร้าง unit tests ตามรุ่น gpt-4:
• ผล unit test :
• - Translate ไฟล์ต้นฉบับจะมีรูปแบบและโครงสร้างเหมือนเดิม:
• Modify รหัสที่มีอยู่ตามความต้องการอินพุตของคุณเช่น

  โปรดแก้ไขข้อบกพร่องหรือเพิ่มประสิทธิภาพโค้ดของฉัน หากฟังก์ชันมีความซับซ้อน โปรดแบ่งเป็นส่วนๆ หากเป็นส่วนประกอบของฟังก์ชัน ให้ใช้ hooks ปรับให้เหมาะสม และเพิ่มความคิดเห็น en และ zh สำหรับขั้นตอนตรรกะที่ซับซ้อน เช่น // EN: ความคิดเห็นบางส่วน // ZH: 一些评论

คุณสมบัติที่สำคัญ

• - AI : review โค้ดที่ขับเคลื่อนด้วย AI modify translate และการสร้าง test หน่วย
• Free : ใช้งานฟรีด้วย OpenAI Session Token เพลิดเพลินกับ chatgpt-3.5 หรือ gpt-4 (บัญชี Plus)
• ️ Security : ฟังก์ชั่นที่คำนึงถึงความปลอดภัยและการแยกคลาส ปรับแต่ง SECURITY_REGEX ของคุณ
• - Customizing : ข้อความแจ้งที่ปรับแต่งได้และการเลือกรุ่น
• File Reader : รองรับการอ่านไฟล์จาก directories หรือ git staged files

การติดตั้ง

หากต้องการติดตั้ง huskygpt ให้รันคำสั่งต่อไปนี้:

 npm install -g huskygpt

การกำหนดค่า

คีย์ OpenAI (เลือกอย่างใดอย่างหนึ่ง)

• ตั้งค่าคีย์ OpenAI API โดย npm config set -g

   npm config set OPENAI_API_KEY <YOUR_OPENAI_KEY> -g
  

• ตั้งค่า OpenAI Session Token ฟรีโดยใช้ chatgpt
  • โทเค็นเซสชัน OpenAI, 2 setp เพื่อรับโทเค็น
  • หากคุณไม่ได้ตั้งค่านี้ จะใช้ OPENAI_API_KEY
  1. ไปที่ https://chat.openai.com/chat และเข้าสู่ระบบ
  2. ไปที่ https://chat.openai.com/api/auth/session เพื่อรับโทเค็น

  npm config set OPENAI_SESSION_TOKEN < YOUR_OPENAI_SESSION_TOKEN > -g

  3. คัดลอกไฟล์ .env ไปยังไดเร็กทอรีรากของโปรเจ็กต์ของคุณ และตั้งค่า OPENAI_PROXY_URL

วิธี	ฟรี?	แข็งแกร่ง?	คุณภาพ?
OpenAI Session Token	✅ใช่	☑️อาจจะ	✅️ ChatGPT จริง
OpenAI API Key	เลขที่	✅ใช่	✅ รุ่น ChatGPT จริง

พรอมต์ท้องถิ่น

1. สร้างไดเร็กทอรี prompt ในไดเร็กทอรีรากของโครงการของคุณ
2. เพิ่ม review.txt หรือ tests.txt ในไดเร็กทอรี prompt

กระทำล่วงหน้า

1. แหบแห้งและขุยเวที

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

.gitignore :

 # review
.huskygpt_review.md
.env.local

การใช้งาน

• เรียกใช้คำสั่งต่อไปนี้เพื่อ review ไฟล์ที่จัดฉาก git ของคุณ:

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

• เรียกใช้คำสั่งต่อไปนี้เพื่อ modify โค้ดที่มีอยู่ของคุณ:

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

• รันคำสั่งต่อไปนี้เพื่อสร้าง test หน่วย:

   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
  

• รันคำสั่งต่อไปนี้เพื่อ translate ไฟล์ git ที่จัดฉากของคุณ:

   huskygpt translate -d example/i18n/test.json
  

ตัวเลือก

• -k, --api-key <key> : ตั้งค่าคีย์ OpenAI API
• -t, --openai-session-token <token> : โทเค็นเซสชัน OpenAI, 2 ขั้นตอนในการรับโทเค็น หากคุณไม่ได้ตั้งค่านี้ จะใช้ OPENAI_API_KEY จะทำให้เสียค่าธรรมเนียมตามคีย์ api
• -pu, --openai-proxy-url <url> : URL พร็อกซีที่จะใช้สำหรับคำขอ OpenAI API
• -m, --model <model> : โมเดล OpenAI ที่จะใช้
• -p, --prompt <prompt> : OpenAI แจ้งให้ใช้
• -mt, --max-tokens <tokens> : โทเค็น OpenAI สูงสุดที่จะใช้
• -e, --file-extensions <extensions> : นามสกุลไฟล์ที่จะอ่าน เช่น .ts,.tsx
• -r, --read-type <type> : อ่านไฟล์จากไดเร็กทอรีหรือระยะ git เช่น: dir หรือ git
• -s, --read-git-status <name> : อ่านไฟล์จากระยะ git ตามค่าเริ่มต้นสถานะ: A,R,M
• -d, --read-dir-name <name> : ชื่อรูทของไดเร็กทอรีที่จะอ่านไฟล์ ตัวอย่าง: src
• -f, --test-file-type <type> : สร้างประเภทไฟล์ทดสอบ เช่น test หรือ spec
• -n, --test-file-dir-name <name> : สร้างชื่อไดเร็กทอรีไฟล์ทดสอบ ตัวอย่าง: tests .
• -o, --test-file-overwrite <value> : สร้างไฟล์ทดสอบเขียนทับ ค่าเริ่มต้นคือ true
• -w, --review-report-webhook <url> : Webhook URL เพื่อส่งรายงานการตรวจสอบ

ตัวเลือกตัวแปรสภาพแวดล้อม

ดูไฟล์ . .env

บันทึก

1. ยังสามารถตั้งค่าตัวเลือกทั้งหมดใน .env หรือ .env.local ซึ่งจะใช้เป็นตัวเลือกเริ่มต้น ตัวเลือกคำสั่งจะแทนที่ตัวเลือกเริ่มต้น
2. ปัจจุบัน Webhook ทดสอบเฉพาะใน seaTalk เท่านั้น หากจำเป็นต้องใช้ช่องทางอื่นกรุณา PR ด้วยตนเองหรือขอความช่วยเหลือจากผม