huskygpt

хаскиgpt

Инструменты CLI Node.js для auto review вашего кода или auto generate модульных тестов с помощью учетной записи chatgpt3.5 и GPT-4 Plus! ✅

Демо

• ? Создайте unit tests по модели gpt-4:
• Результат unit test :
• ? Исходный файл Translate сохраняет тот же формат и структуру:
• Modify существующий код в соответствии с вашими требованиями к вводу, например

  Пожалуйста, исправьте ошибки или оптимизируйте мой код. если функция сложная, пожалуйста, разбейте ее на части. Если это функциональный компонент, используйте хуки, чтобы оптимизировать его. И добавьте комментарии en и zh для логических шагов сложности, например, // EN: некоторые комментарии, // ZH: 一些评论.

Ключевые особенности

• ? AI : review кода на базе искусственного интеллекта, modify , translate и создание модульных test .
• Free : бесплатно для использования с OpenAI Session Token , наслаждайтесь чатом gpt-3.5 или gpt-4 (учетная запись Plus).
• ?️ Security : функция безопасности и извлечение классов, настройте свой SECURITY_REGEX .
• ? Customizing : Настраиваемые подсказки и выбор модели.
• File Reader : поддерживает чтение файлов из directories или git staged files .

Установка

Чтобы установить huskygpt , выполните следующую команду:

 npm install -g huskygpt

Конфигурация

Ключ OpenAI (выберите один)

• Установите ключ API OpenAI с помощью 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	✅ Да	☑️ Возможно	✅️ Реальный чатGPT
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> : установить ключ API OpenAI.
• -t, --openai-session-token <token> : токен сеанса OpenAI, 2 шага для получения токена. Если вы не установите это значение, будет использоваться OPENAI_API_KEY, взимается плата по ключу API.
• -pu, --openai-proxy-url <url> : URL-адрес прокси-сервера, используемый для запросов API OpenAI.
• -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> : URL-адрес веб-перехватчика для отправки отчета о проверке.

Параметры переменных среды

См. файл .env .

Примечание

1. Также можно установить все параметры в .env или .env.local , которые будут использоваться как параметры по умолчанию. Параметры команды переопределяют параметры по умолчанию.
2. Webhook в настоящее время тестируется только в seaTalk . Если необходимо использовать другой канал, поднимите PR самостоятельно или обратитесь ко мне за помощью.