@alibaba-group/open-code-review 1.1.4 → 1.1.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.zh-CN.md +26 -7
- package/bin/ocr.js +1 -1
- package/imgs/logo.svg +1 -0
- package/package.json +1 -1
package/README.zh-CN.md
CHANGED
|
@@ -1,10 +1,19 @@
|
|
|
1
|
-
<
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
</
|
|
6
|
-
|
|
7
|
-
|
|
1
|
+
<p align="center">
|
|
2
|
+
<a href="https://alibaba.github.io/open-code-review/">
|
|
3
|
+
<img src="imgs/logo.svg" alt="OpenCodeReview logo" width="240" height="240">
|
|
4
|
+
</a>
|
|
5
|
+
</p>
|
|
6
|
+
<p align="center">The open source AI code review agent.</p>
|
|
7
|
+
<p align="center">
|
|
8
|
+
<a href="https://www.npmjs.com/package/@alibaba-group/open-code-review"><img alt="npm" src="https://img.shields.io/npm/v/@alibaba-group/open-code-review?style=flat-square" /></a>
|
|
9
|
+
<a href="https://github.com/alibaba/open-code-review/actions/workflows/release.yml"><img alt="Build status" src="https://img.shields.io/github/actions/workflow/status/alibaba/open-code-review/release.yml?style=flat-square" /></a>
|
|
10
|
+
<a href="https://github.com/alibaba/open-code-review/blob/main/LICENSE"><img alt="License" src="https://img.shields.io/github/license/alibaba/open-code-review?style=flat-square" /></a>
|
|
11
|
+
</p>
|
|
12
|
+
<p align="center">
|
|
13
|
+
<a href="README.md">English</a> | 简体中文
|
|
14
|
+
</p>
|
|
15
|
+
|
|
16
|
+
---
|
|
8
17
|
|
|
9
18
|
AI 驱动的代码审查 CLI 工具,读取 Git diff,通过具备工具调用能力的 Agent 将变更文件发送至可配置的 LLM,生成具有行级精度的结构化审查意见。
|
|
10
19
|
|
|
@@ -103,6 +112,7 @@ ocr review --commit abc123
|
|
|
103
112
|
| 命令 | 别名 | 描述 |
|
|
104
113
|
|------|------|------|
|
|
105
114
|
| `ocr review` | `ocr r` | 开始代码审查 |
|
|
115
|
+
| `ocr rules check <file>` | — | 预览某个文件路径生效的审查规则 |
|
|
106
116
|
| `ocr config set <key> <value>` | — | 设置配置项 |
|
|
107
117
|
| `ocr llm test` | — | 测试 LLM 连通性 |
|
|
108
118
|
| `ocr viewer` | `ocr v` | 启动 WebUI 会话查看器,地址 `localhost:5483` |
|
|
@@ -116,6 +126,7 @@ ocr review --commit abc123
|
|
|
116
126
|
| `--from` | — | — | 源引用(如 `main`) |
|
|
117
127
|
| `--to` | — | — | 目标引用(如 `feature-branch`) |
|
|
118
128
|
| `--commit` | `-c` | — | 审查单个提交 |
|
|
129
|
+
| `--preview` | `-p` | `false` | 预览将被审查的文件列表,不调用 LLM |
|
|
119
130
|
| `--format` | `-f` | `text` | 输出格式:`text` 或 `json` |
|
|
120
131
|
| `--concurrency` | — | `8` | 最大并发文件审查数 |
|
|
121
132
|
| `--timeout` | — | `10` | 并发任务超时时间(分钟) |
|
|
@@ -126,6 +137,10 @@ ocr review --commit abc123
|
|
|
126
137
|
## 示例
|
|
127
138
|
|
|
128
139
|
```bash
|
|
140
|
+
# 预览将被审查的文件(不调用 LLM)
|
|
141
|
+
ocr review --preview
|
|
142
|
+
ocr review -c abc123 -p
|
|
143
|
+
|
|
129
144
|
# 使用默认设置审查工作区变更
|
|
130
145
|
ocr review
|
|
131
146
|
|
|
@@ -138,6 +153,10 @@ ocr review --commit abc123 --format json --audience agent
|
|
|
138
153
|
# 使用自定义审查规则
|
|
139
154
|
ocr review --rule /path/to/my-rules.json
|
|
140
155
|
|
|
156
|
+
# 预览某个文件路径生效的规则
|
|
157
|
+
ocr rules check src/main/java/com/example/Foo.java
|
|
158
|
+
ocr rules check --rule custom.json src/main/resources/mapper/UserMapper.xml
|
|
159
|
+
|
|
141
160
|
# 在浏览器中查看审查会话历史
|
|
142
161
|
ocr viewer
|
|
143
162
|
ocr viewer --addr :3000
|
package/bin/ocr.js
CHANGED
|
@@ -12,7 +12,7 @@ if (!process.env.OCR_NO_UPDATE) {
|
|
|
12
12
|
const stateDir = path.join(os.homedir(), ".opencodereview");
|
|
13
13
|
const tsFile = path.join(stateDir, "last-update-check");
|
|
14
14
|
const cooldownMs =
|
|
15
|
-
(parseInt(process.env.OCR_UPDATE_INTERVAL, 10) ||
|
|
15
|
+
(parseInt(process.env.OCR_UPDATE_INTERVAL, 10) || 30) * 60 * 1000;
|
|
16
16
|
|
|
17
17
|
let shouldCheck = true;
|
|
18
18
|
try {
|
package/imgs/logo.svg
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" fill="none" version="1.1" width="500" height="500" viewBox="0 0 500 500"><defs><clipPath id="master_svg0_3_2815"><rect x="0" y="0" width="500" height="500" rx="0"/></clipPath></defs><g clip-path="url(#master_svg0_3_2815)"><rect x="0" y="0" width="500" height="500" rx="0" fill="#35BD5F" fill-opacity="1"/><path d="M369.391824777832,207.16973852783204L369.391854777832,131.60131852783203C369.391854777832,128.15557852783203,367.18552477783203,125.09696952783203,363.915744777832,124.00987252783203L265.002354777832,91.12426762783203C256.809764777832,88.40048217783203,247.95578477783204,88.40048217783203,239.76320477783204,91.12426762783203L140.84986477783204,124.00987252783203C137.58010877783204,125.09696952783203,135.37377977783203,128.15557852783203,135.37377977783203,131.60131052783203L135.37377977783203,187.979896527832Q110.36145377783203,206.39992852783203,91.91033172783203,231.29782852783202C91.25267028783203,232.18527852783203,91.45416259783204,233.43310852783202,92.34779357783204,234.08234852783204L101.33021547783203,240.60814852783204C102.22384677783204,241.25737852783203,103.48256677783203,241.04652852783204,104.14099877783204,240.15965852783202Q117.80681777783204,221.75247852783204,135.37377977783203,207.15375852783203L135.37377977783203,207.16844852783203C135.42535377783202,207.120678527832,135.47695877783204,207.07293852783204,135.52861377783202,207.02521852783204Q150.71416877783201,194.43234852783203,168.80918877783205,184.679801527832Q209.221374777832,162.89910852783203,251.50217477783204,162.39883452783204C251.59465477783203,162.39774352783203,251.68558477783202,162.39046452783202,251.77458477783202,162.377410527832C251.97704477783202,162.37673952783203,252.17955477783204,162.37640352783203,252.38211477783204,162.37640352783203C296.51404477783205,162.37640352783203,338.303324777832,178.37405352783202,369.391824777832,207.16973852783204ZM252.38291477783204,295.414878527832C279.10971477783204,295.414878527832,300.776084777832,273.74850852783203,300.776084777832,247.02170852783203C300.776084777832,240.21207852783203,299.33893477783204,233.47909852783204,296.55858477783204,227.26292852783203C294.66187477783205,235.80182852783204,287.548164777832,242.19144852783202,278.85541477783204,243.16412852783202C279.03736477783207,244.42372852783203,279.131504777832,245.71170852783203,279.131504777832,247.02168852783203C279.131504777832,261.794608527832,267.155694777832,273.770428527832,252.38277477783203,273.770428527832C237.60985477783203,273.770428527832,225.63404477783203,261.794608527832,225.63404477783203,247.02168852783203C225.63404477783203,232.24876852783203,237.60985477783203,220.27295852783203,252.38277477783203,220.27295852783203C253.69280477783204,220.27295852783203,254.98084477783203,220.36711852783202,256.240474777832,220.54907852783202C257.21321477783204,211.85636852783205,263.60280477783203,204.742728527832,272.141634777832,202.84602852783203C265.925484777832,200.06567852783203,259.19254477783204,198.62853852783203,252.38291477783204,198.62853852783203C225.65610477783204,198.62853852783203,203.98974477783202,220.29489852783203,203.98974477783202,247.02170852783203C203.98974477783202,273.74850852783203,225.65610477783204,295.414878527832,252.38291477783204,295.414878527832ZM274.81439477783204,243.21481852783202C264.90529477783207,242.35698852783204,257.04755477783203,234.49919852783202,256.1897847778321,224.59009852783203C254.95186477783204,224.38151852783204,253.68000477783204,224.27295852783203,252.38277477783203,224.27295852783203C239.81899477783202,224.27295852783203,229.63404477783203,234.45790852783202,229.63404477783203,247.02168852783203C229.63404477783203,259.58546852783206,239.81899477783202,269.770428527832,252.38277477783203,269.770428527832C264.94655477783203,269.770428527832,275.131504777832,259.58546852783206,275.131504777832,247.02168852783203C275.131504777832,245.72450852783203,275.02294477783204,244.45268852783204,274.81439477783204,243.21481852783202ZM313.98419477783204,373.06705852783205C339.510884777832,356.763438527832,357.584414777832,331.664328527832,365.268044777832,303.130198527832Q389.75965477783205,285.49699852783203,408.07666477783204,260.794778527832C408.73459477783206,259.907508527832,408.54608477783205,258.641948527832,407.65244477783205,257.99271852783204L398.67002477783205,251.46689852783203C397.77640477783206,250.81766852783204,396.535654777832,251.00403852783202,395.877174777832,251.89087852783203Q383.89688477783204,268.02576852783204,369.057804777832,280.89220852783205L369.05826477783205,280.885928527832L368.94913477783206,280.98634852783204Q352.69916477783204,295.05307852783204,333.02570477783206,305.20590852783204Q296.653174777832,323.976558527832,256.24495477783205,325.33028852783207C254.95948477783202,325.35753852783205,253.67179477783202,325.37118852783203,252.38211477783204,325.37118852783203C208.41640477783204,325.37118852783203,166.76860077783203,309.49235852783204,135.70742077783203,280.887278527832C138.50840777783202,318.39349852783204,158.79283877783203,352.636328527832,190.78138777783204,373.067088527832L248.07660477783202,409.660928527832C250.70246477783203,411.33801852783205,254.06308477783202,411.33801852783205,256.68894477783203,409.660928527832L313.98419477783204,373.06705852783205Z" fill-rule="evenodd" fill="#121519" fill-opacity="1"/></g></svg>
|