huskygpt

哈士奇gpt

Node.js CLI 工具可通过 OpenAI chatgpt3.5和GPT-4 Plus 帐户auto review代码或auto generate单元测试！ ✅

演示

• ？通过gpt-4模型生成unit tests ：
• unit test结果：
• ？ Translate源文件保持相同的格式和结构：
• 根据您的输入要求Modify现有代码，例如

  请修复错误或优化我的代码。如果函数很复杂，请将其分块。如果是函数组件，可以使用hooks来优化。并为复杂的逻辑步骤添加 en 和 zh 注释，例如 // EN：一些注释，// ZH：一些评论。

主要特点

• ？ 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获取token

  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. 在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

用法

• 运行以下命令来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 key 产生费用。
• -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> : 从 git stage 读取文件，默认状态：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或者找我帮忙。