Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/luffy-xu/huskygpt
Auto review or Auto generate unit tests form your code using openAI model gpt3 gpt4, support CLI command line tool
https://github.com/luffy-xu/huskygpt
chatgpt chatgpt-api chatgpt3 chatgpt4 front-end git-staged gpt-4 huskygpt jest openai react review test test-automation typescript unit
Last synced: 2 months ago
JSON representation
Auto review or Auto generate unit tests form your code using openAI model gpt3 gpt4, support CLI command line tool
- Host: GitHub
- URL: https://github.com/luffy-xu/huskygpt
- Owner: luffy-xu
- Created: 2023-03-26T13:33:11.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-05-05T09:21:59.000Z (over 1 year ago)
- Last Synced: 2024-10-30T01:30:56.635Z (2 months ago)
- Topics: chatgpt, chatgpt-api, chatgpt3, chatgpt4, front-end, git-staged, gpt-4, huskygpt, jest, openai, react, review, test, test-automation, typescript, unit
- Language: TypeScript
- Homepage:
- Size: 565 KB
- Stars: 50
- Watchers: 3
- Forks: 8
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# huskygpt
> Node.js CLI tools for `auto review` your code or `auto generate` unit tests by OpenAI `chatgpt3.5` and `GPT-4` Plus Account! ✅
[](https://www.npmjs.com/package/huskygpt) [](https://prettier.io)
## Demo
- 🤖 Generate `unit tests` by gpt-4 model:
- ✨ The `unit test` result:
- 🌍 `Translate` source file keep the same format and structure:
- 🖊️ `Modify` exist code by your input requirements e.g.
> Please fix bugs or optimize my code. if the function is complexity, please chunk it. If it's function component, use hooks optimize it. And add en and zh comments for complexity logic steps e.g. // EN: some comments, // ZH: 一些评论.
## Key Features
- 🤖 `AI`: AI-powered code `review`, `modify`, `translate` and unit `test` generation
- ✨ `Free`: Free to use with an `OpenAI Session Token`, enjoy chatgpt-3.5 or gpt-4 (Plus Account).
- 🛡️ `Security`: Security-conscious function and class extraction, customize your `SECURITY_REGEX`.
- 🧠 `Customizing`: Customizable prompts and model selection.
- 📂 `File Reader`: Supports reading files from `directories` or `git staged files`.
## Installation
To install `huskygpt`, run the following command:
```
npm install -g huskygpt
```
## Configuration
### OpenAI Key (Choose one)
- Set the [OpenAI API Key](https://platform.openai.com/account/api-keys) by npm config set -g
```
npm config set OPENAI_API_KEY -g
```
- Set the `OpenAI Session Token` for free using chatgpt
- OpenAI session token, 2 setp to get token
- If you don't set this, will use OPENAI_API_KEY
1. visit https://chat.openai.com/chat and login
2. Visit https://chat.openai.com/api/auth/session to get token
```bash
npm config set OPENAI_SESSION_TOKEN -g
```
3. Copy [`.env`](https://github.com/luffy-xu/huskygpt/blob/main/.env) file to your project root directory, and set `OPENAI_PROXY_URL`.
| Method | Free? | Robust? | Quality? |
| --------------------------- | ------ | -------- | ----------------------- |
| `OpenAI Session Token` | ✅ Yes | ☑️ Maybe | ✅️ Real ChatGPT |
| `OpenAI API Key` | ❌ No | ✅ Yes | ✅ Real ChatGPT models |
### Local prompt
1. Create `prompt` directory in the root directory of your project.
1. Add `review.txt` or `tests.txt` in the `prompt` directory.
### Pre-Commit
1. [husky](https://github.com/typicode/husky) and [lint-stage](https://github.com/okonet/lint-staged)
```
"husky": {
"hooks": {
"pre-commit": "huskygpt review && huskygpt test && lint-staged --allow-empty"
}
},
```
### `.gitignore`:
```
# review
.huskygpt_review.md
.env.local
```
## Usage
- Run the following command to `review` your git staged files:
```
huskygpt review --model gpt-4 --max-tokens 2048
```
- Run the following command to `modify` your exist code:
```
huskygpt modify -r dir -d src/pages/UserRegister/RegisterList.tsx -m gpt-4
```
- Run the following command to generate unit `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
```
- Run the following command to `translate` your git staged files:
```
huskygpt translate -d example/i18n/test.json
```
### Options
- `-k, --api-key `: Set the OpenAI API key.
- `-t, --openai-session-token `: OpenAI session token, 2 step to get token, If you don't set this, will use OPENAI_API_KEY, will cause fee by api key.
- `-pu, --openai-proxy-url `: Proxy URL to use for OpenAI API requests.
- `-m, --model `: OpenAI model to use.
- `-p, --prompt `: OpenAI prompt to use.
- `-mt, --max-tokens `: OpenAI max tokens to use.
- `-e, --file-extensions `: File extensions to read, example: .ts,.tsx
- `-r, --read-type `: Read files from directory or git stage, example: dir or git.
- `-s, --read-git-status `: Read files from git stage by status default: A,R,M.
- `-d, --read-dir-name `: Root name of the directory to read files from, example: src.
- `-f, --test-file-type `: Generate test file type, example: test or spec.
- `-n, --test-file-dir-name `: Generate test file directory name, example: __tests__.
- `-o, --test-file-overwrite `: Generate test file overwrite, default is true.
- `-w, --review-report-webhook `: Webhook URL to send review report.
### Environment Variables options
See [`.env`](https://github.com/luffy-xu/huskygpt/blob/main/.env) file.
## Note
1. Also can set all options in `.env` or `.env.local`, that will be used as default options. Command options will override the default options.
2. Webhook currently only test in `seaTalk`, if other channel need to use, please rise `PR` by yourself or ask [me]([email protected]) for help.