huskygpt

허스키

OpenAI chatgpt3.5 및 GPT-4 Plus 계정을 통해 코드를 auto review 하거나 단위 테스트를 auto generate 위한 Node.js CLI 도구! ✅

데모

• ? gpt-4 모델로 unit tests 생성합니다.
• unit test 결과:
• ? 소스 파일 Translate 동일한 형식과 구조를 유지합니다.
• 입력 요구 사항에 따라 기존 코드를 Modify . 예:

  버그를 수정하거나 내 코드를 최적화해 주세요. 기능이 복잡하다면 청크(chunk)해 주세요. 함수 구성 요소인 경우 후크를 사용하여 최적화하세요. 복잡한 논리 단계에 대해 en 및 zh 주석을 추가합니다(예: // EN: 일부 주석, // ZH: 一些评论).

주요 특징

• ? AI : AI 기반 코드 review , 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 키(하나 선택)

• npm config set -g로 OpenAI API 키 설정

   npm config set OPENAI_API_KEY <YOUR_OPENAI_KEY> -g
  

• chatgpt를 사용하여 OpenAI Session Token 무료로 설정하세요.
  • 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	✅ 예	✔️아마도	✅️ 실시간 채팅GPT
OpenAI API Key	아니요	✅ 예	✅ 실시간 채팅GPT 모델

로컬 프롬프트

1. 프로젝트의 루트 디렉터리에 prompt 디렉터리를 만듭니다.
2. prompt 디렉터리에 review.txt 또는 tests.txt 추가합니다.

사전 커밋

1. 허스키 및 보푸라기 단계

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

.gitignore :

 # review
.huskygpt_review.md
.env.local

용법

• 다음 명령을 실행하여 git staged 파일을 review .

   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
  

• 다음 명령을 실행하여 git staged 파일을 translate :

   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> : OpenAI API 요청에 사용할 프록시 URL입니다.
• -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> : 기본 상태: A,R,M으로 git 단계에서 파일을 읽습니다.
• -d, --read-dir-name <name> : 파일을 읽을 디렉터리의 루트 이름입니다. 예: src.
• -f, --test-file-type <type> : 테스트 파일 형식을 생성합니다(예: test 또는 spec).
• -n, --test-file-dir-name <name> : 테스트 파일 디렉터리 이름을 생성합니다(예: 테스트) .
• -o, --test-file-overwrite <value> : 테스트 파일 덮어쓰기를 생성합니다. 기본값은 true입니다.
• -w, --review-report-webhook <url> : 리뷰 보고서를 보낼 웹훅 URL입니다.

환경 변수 옵션

.env 파일을 참조하세요.

메모

1. 또한 기본 옵션으로 사용되는 .env 또는 .env.local 의 모든 옵션을 설정할 수 있습니다. 명령 옵션은 기본 옵션을 재정의합니다.
2. 웹훅은 현재 seaTalk 에서만 테스트됩니다. 다른 채널을 사용해야 하는 경우 직접 PR 올리거나 도움을 요청하세요.