huskygpt

huskygpt

أدوات Node.js CLI auto review للتعليمات البرمجية الخاصة بك أو auto generate بواسطة OpenAI chatgpt3.5 و GPT-4 Plus Account! ✅

تجريبي

• ؟ إنشاء unit tests بواسطة نموذج gpt-4:
• نتيجة unit test :
• ؟ Translate الملف المصدر يحتفظ بنفس التنسيق والبنية:
• Modify الكود الموجود حسب متطلبات الإدخال الخاصة بك على سبيل المثال

  الرجاء إصلاح الأخطاء أو تحسين الكود الخاص بي. إذا كانت الوظيفة معقدة، يرجى قطعها. إذا كان مكونًا وظيفيًا، فاستخدم الخطافات لتحسينه. وأضف تعليقات en وzh لخطوات منطق التعقيد، على سبيل المثال // EN: بعض التعليقات، // ZH: 一些评论.

الميزات الرئيسية

• ؟ AI : review التعليمات البرمجية المدعومة بالذكاء الاصطناعي modify translate وإنشاء test الوحدة
• Free : مجاني للاستخدام مع OpenAI Session Token ، واستمتع بـ chatgpt-3.5 أو gpt-4 (الحساب الإضافي).
• ️ 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 إعداد للحصول على الرمز المميز
  • إذا لم تقم بتعيين هذا، فسيتم استخدام 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، خطوتين للحصول على الرمز المميز، إذا لم تقم بتعيين هذا، فسوف تستخدم 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 max المراد استخدامها.
• -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> : إنشاء نوع ملف اختبار، على سبيل المثال: اختبار أو مواصفات.
• -n, --test-file-dir-name <name> : إنشاء اسم دليل ملف الاختبار، على سبيل المثال: الاختبارات .
• -o, --test-file-overwrite <value> : إنشاء الكتابة فوق ملف الاختبار، الافتراضي هو صحيح.
• -w, --review-report-webhook <url> : عنوان URL لـ Webhook لإرسال تقرير المراجعة.

خيارات متغيرات البيئة

راجع ملف .env .

ملحوظة

1. يمكن أيضًا تعيين جميع الخيارات في .env أو .env.local ، والتي سيتم استخدامها كخيارات افتراضية. ستتجاوز خيارات الأوامر الخيارات الافتراضية.
2. يتم اختبار Webhook حاليًا فقط في seaTalk ، إذا كانت هناك حاجة لاستخدام قناة أخرى، فيرجى رفع PR بنفسك أو اطلب مني المساعدة.