@alibaba-group/open-code-review 1.7.2 → 1.7.4
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.ja-JP.md +9 -0
- package/README.ko-KR.md +9 -0
- package/README.md +9 -0
- package/README.ru-RU.md +9 -0
- package/README.zh-CN.md +9 -0
- package/package.json +7 -7
package/README.ja-JP.md
CHANGED
|
@@ -404,6 +404,15 @@ ocr review \
|
|
|
404
404
|
|
|
405
405
|
`--format json`フラグは、CIスクリプトでのパースに適した機械可読な結果を出力します。
|
|
406
406
|
|
|
407
|
+
各指摘には2つの構造化フィールドが付与され、CI統合はコメント本文を再パースせずに並べ替え・グループ化・フィルタリング・ビルドのゲート判定を行えます:
|
|
408
|
+
|
|
409
|
+
| フィールド | 許可される値 | 説明 |
|
|
410
|
+
|-----------|-------------|------|
|
|
411
|
+
| `category` | `bug`、`security`、`performance`、`maintainability`、`test`、`style`、`documentation`、`other` | 指摘が属するカテゴリ。 |
|
|
412
|
+
| `severity` | `critical`、`high`、`medium`、`low` | 指摘の重要度。 |
|
|
413
|
+
|
|
414
|
+
JSON出力ではこの2つのフィールドは`content`や`start_line`などと同じ階層に並びます。ターミナルでは、コメントの前にインラインの`[category · severity]`バッジとして表示され、重要度に応じて色分けされます。
|
|
415
|
+
|
|
407
416
|
統合例は[`examples/`](./examples/)ディレクトリを参照してください:
|
|
408
417
|
|
|
409
418
|
- [`github_actions/`](./examples/github_actions/) — GitHub Actions統合の例
|
package/README.ko-KR.md
CHANGED
|
@@ -404,6 +404,15 @@ ocr review \
|
|
|
404
404
|
|
|
405
405
|
`--format json` flag는 CI script에서 파싱하기 좋은 machine-readable 결과를 출력합니다.
|
|
406
406
|
|
|
407
|
+
각 finding에는 두 개의 구조화된 field가 포함되어, CI 통합에서 comment 텍스트를 다시 파싱하지 않고도 정렬·그룹화·필터링하거나 build를 gate할 수 있습니다:
|
|
408
|
+
|
|
409
|
+
| Field | 허용 값 | 설명 |
|
|
410
|
+
|-------|--------|------|
|
|
411
|
+
| `category` | `bug`, `security`, `performance`, `maintainability`, `test`, `style`, `documentation`, `other` | 이슈가 속한 카테고리. |
|
|
412
|
+
| `severity` | `critical`, `high`, `medium`, `low` | 이슈의 중요도. |
|
|
413
|
+
|
|
414
|
+
JSON 출력에서 두 field는 `content`, `start_line` 등과 같은 수준의 sibling으로 나타납니다. 터미널에서는 comment 앞에 인라인 `[category · severity]` badge로 표시되며 severity에 따라 색상이 지정됩니다.
|
|
415
|
+
|
|
407
416
|
통합 예시는 [`examples/`](./examples/) 디렉터리를 참고하세요.
|
|
408
417
|
|
|
409
418
|
- [`github_actions/`](./examples/github_actions/): GitHub Actions 통합 예시
|
package/README.md
CHANGED
|
@@ -406,6 +406,15 @@ The `--from` flag accepts a branch ref (e.g., `origin/main`) or commit SHA as th
|
|
|
406
406
|
|
|
407
407
|
The `--format json` flag outputs machine-readable results suitable for parsing in CI scripts.
|
|
408
408
|
|
|
409
|
+
Each finding carries two structured fields so CI integrations can sort, group, filter, or gate builds without re-parsing comment text:
|
|
410
|
+
|
|
411
|
+
| Field | Allowed values | Notes |
|
|
412
|
+
|-------|----------------|-------|
|
|
413
|
+
| `category` | `bug`, `security`, `performance`, `maintainability`, `test`, `style`, `documentation`, `other` | The category the issue belongs to. |
|
|
414
|
+
| `severity` | `critical`, `high`, `medium`, `low` | The importance of the issue. |
|
|
415
|
+
|
|
416
|
+
In JSON output the two fields appear as siblings alongside `content`, `start_line`, etc. In the terminal, they render as an inline `[category · severity]` badge before the comment, colored by severity.
|
|
417
|
+
|
|
409
418
|
See the [`examples/`](./examples/) directory for integration examples:
|
|
410
419
|
|
|
411
420
|
- [`github_actions/`](./examples/github_actions/) — GitHub Actions integration example
|
package/README.ru-RU.md
CHANGED
|
@@ -406,6 +406,15 @@ ocr review \
|
|
|
406
406
|
|
|
407
407
|
Флаг `--format json` выводит машиночитаемый результат, удобный для разбора в CI-скриптах.
|
|
408
408
|
|
|
409
|
+
Каждое замечание содержит два структурированных поля, чтобы CI-интеграции могли сортировать, группировать, фильтровать замечания или блокировать сборку без повторного разбора текста комментария:
|
|
410
|
+
|
|
411
|
+
| Поле | Допустимые значения | Примечание |
|
|
412
|
+
|------|---------------------|------------|
|
|
413
|
+
| `category` | `bug`, `security`, `performance`, `maintainability`, `test`, `style`, `documentation`, `other` | Категория, к которой относится замечание. |
|
|
414
|
+
| `severity` | `critical`, `high`, `medium`, `low` | Важность замечания. |
|
|
415
|
+
|
|
416
|
+
В JSON-выводе эти два поля располагаются рядом с `content`, `start_line` и др. В терминале они отображаются перед комментарием как встроенный бейдж `[category · severity]`, цвет которого определяется важностью.
|
|
417
|
+
|
|
409
418
|
Примеры интеграции — в каталоге [`examples/`](./examples/):
|
|
410
419
|
|
|
411
420
|
- [`github_actions/`](./examples/github_actions/) — пример интеграции с GitHub Actions
|
package/README.zh-CN.md
CHANGED
|
@@ -404,6 +404,15 @@ ocr review \
|
|
|
404
404
|
|
|
405
405
|
`--format json` 参数输出适合 CI 脚本解析的机器可读结果。
|
|
406
406
|
|
|
407
|
+
每条评审结果都带有两个结构化字段,便于 CI 集成在无需解析评论文本的情况下排序、分组、过滤或卡点构建:
|
|
408
|
+
|
|
409
|
+
| 字段 | 允许的取值 | 说明 |
|
|
410
|
+
|------|-----------|------|
|
|
411
|
+
| `category` | `bug`、`security`、`performance`、`maintainability`、`test`、`style`、`documentation`、`other` | 问题所属的类别。 |
|
|
412
|
+
| `severity` | `critical`、`high`、`medium`、`low` | 问题的严重程度。 |
|
|
413
|
+
|
|
414
|
+
在 JSON 输出中,这两个字段与 `content`、`start_line` 等平级;在终端中,它们会以内联的 `[category · severity]` 徽章形式显示在评论前,并按严重程度着色。
|
|
415
|
+
|
|
407
416
|
集成示例请参见 [`examples/`](./examples/) 目录:
|
|
408
417
|
|
|
409
418
|
- [`github_actions/`](./examples/github_actions/) — GitHub Actions 集成示例
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@alibaba-group/open-code-review",
|
|
3
|
-
"version": "1.7.
|
|
3
|
+
"version": "1.7.4",
|
|
4
4
|
"description": "OpenCodeReview CLI — AI-powered code review tool",
|
|
5
5
|
"bin": {
|
|
6
6
|
"ocr": "bin/ocr.js"
|
|
@@ -28,12 +28,12 @@
|
|
|
28
28
|
"checksumPattern": "https://github.com/alibaba/open-code-review/releases/download/v{version}/sha256sum.txt"
|
|
29
29
|
},
|
|
30
30
|
"optionalDependencies": {
|
|
31
|
-
"@alibaba-group/ocr-darwin-arm64": "1.7.
|
|
32
|
-
"@alibaba-group/ocr-darwin-x64": "1.7.
|
|
33
|
-
"@alibaba-group/ocr-linux-arm64": "1.7.
|
|
34
|
-
"@alibaba-group/ocr-linux-x64": "1.7.
|
|
35
|
-
"@alibaba-group/ocr-win32-arm64": "1.7.
|
|
36
|
-
"@alibaba-group/ocr-win32-x64": "1.7.
|
|
31
|
+
"@alibaba-group/ocr-darwin-arm64": "1.7.4",
|
|
32
|
+
"@alibaba-group/ocr-darwin-x64": "1.7.4",
|
|
33
|
+
"@alibaba-group/ocr-linux-arm64": "1.7.4",
|
|
34
|
+
"@alibaba-group/ocr-linux-x64": "1.7.4",
|
|
35
|
+
"@alibaba-group/ocr-win32-arm64": "1.7.4",
|
|
36
|
+
"@alibaba-group/ocr-win32-x64": "1.7.4"
|
|
37
37
|
},
|
|
38
38
|
"engines": {
|
|
39
39
|
"node": ">=14"
|