@weareikko/code-review 0.10.2 → 0.11.0
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.md +12 -37
- package/dist/{cli-D_wubGGT.js → cli-sMHMzfB_.js} +1738 -3947
- package/dist/cli-sMHMzfB_.js.map +1 -0
- package/dist/cli.d.ts +1 -19
- package/dist/cli.d.ts.map +1 -1
- package/dist/cli.js +2 -2
- package/dist/config.d.ts +2 -2
- package/dist/config.d.ts.map +1 -1
- package/dist/gitlab-review.d.ts +3 -23
- package/dist/gitlab-review.d.ts.map +1 -1
- package/dist/mcp.d.ts +4 -6
- package/dist/mcp.d.ts.map +1 -1
- package/dist/product.d.ts +12 -0
- package/dist/product.d.ts.map +1 -1
- package/dist/review.d.ts +3 -7
- package/dist/review.d.ts.map +1 -1
- package/dist/review.js +2 -1
- package/package.json +8 -29
- package/dist/cli-D_wubGGT.js.map +0 -1
- package/dist/marketplaces.d.ts +0 -100
- package/dist/marketplaces.d.ts.map +0 -1
- package/dist/mcp-config.d.ts +0 -90
- package/dist/mcp-config.d.ts.map +0 -1
- package/dist/mcp-parse.d.ts +0 -146
- package/dist/mcp-parse.d.ts.map +0 -1
- package/dist/skill-links.d.ts +0 -62
- package/dist/skill-links.d.ts.map +0 -1
- package/dist/skill-usage.d.ts +0 -67
- package/dist/skill-usage.d.ts.map +0 -1
- package/dist/skills.d.ts +0 -156
- package/dist/skills.d.ts.map +0 -1
package/README.md
CHANGED
|
@@ -172,15 +172,15 @@ Prefer no action at all? `GITHUB_TOKEN`, `GITHUB_REPOSITORY`, and the PR number
|
|
|
172
172
|
|
|
173
173
|
## Documentation
|
|
174
174
|
|
|
175
|
-
The README covers getting started. Reference material lives in [`docs/`](https://github.com/weareikko/code-review/tree/main/docs):
|
|
175
|
+
The README covers getting started. Reference material lives in [`docs/`](https://github.com/weareikko/code-review/tree/main/packages/code-review/docs):
|
|
176
176
|
|
|
177
|
-
- [Configuration](https://github.com/weareikko/code-review/blob/main/docs/configuration.md) — full environment-variable and CLI-flag reference, plus the `CODE_REVIEW_` namespacing convention.
|
|
178
|
-
- [Providers](https://github.com/weareikko/code-review/blob/main/docs/providers.md) — Anthropic, OpenRouter, Gemini, Ollama, and OpenAI-compatible endpoints, plus heterogeneous review with a model pool.
|
|
179
|
-
- [Skills](https://github.com/weareikko/code-review/blob/main/docs/skills.md) — built-in, external (`npm:`/`file:`/`git:`), Claude plugin marketplaces, and project auto-discovered review skills.
|
|
180
|
-
- [MCP servers](https://github.com/weareikko/code-review/blob/main/docs/mcp.md) — connect Model Context Protocol servers so the reviewer can call read-only tools (marketplace plugins, `--mcp file:`, opt-in repo `.mcp.json`), the read-only gate, the `${VAR}` allowlist, and the summary footer line.
|
|
181
|
-
- [Multi-stage review](https://github.com/weareikko/code-review/blob/main/docs/multi-stage-review.md) — the staged Find / Verify / Synthesize pipeline behind `--review-depth`.
|
|
182
|
-
- [Observability](https://github.com/weareikko/code-review/blob/main/docs/observability.md) — diagnostics-channel tracing and the opt-in OpenTelemetry bridge (spans, metrics, logs).
|
|
183
|
-
- [Output format](https://github.com/weareikko/code-review/blob/main/docs/output-format.md) — inline-comment shape, the upserted summary (a note on GitLab, an issue comment on GitHub), footer, and duplicate prevention.
|
|
177
|
+
- [Configuration](https://github.com/weareikko/code-review/blob/main/packages/code-review/docs/configuration.md) — full environment-variable and CLI-flag reference, plus the `CODE_REVIEW_` namespacing convention.
|
|
178
|
+
- [Providers](https://github.com/weareikko/code-review/blob/main/packages/code-review/docs/providers.md) — Anthropic, OpenRouter, Gemini, Ollama, and OpenAI-compatible endpoints, plus heterogeneous review with a model pool.
|
|
179
|
+
- [Skills](https://github.com/weareikko/code-review/blob/main/packages/code-review/docs/skills.md) — built-in, external (`npm:`/`file:`/`git:`), Claude plugin marketplaces, and project auto-discovered review skills.
|
|
180
|
+
- [MCP servers](https://github.com/weareikko/code-review/blob/main/packages/code-review/docs/mcp.md) — connect Model Context Protocol servers so the reviewer can call read-only tools (marketplace plugins, `--mcp file:`, opt-in repo `.mcp.json`), the read-only gate, the `${VAR}` allowlist, and the summary footer line.
|
|
181
|
+
- [Multi-stage review](https://github.com/weareikko/code-review/blob/main/packages/code-review/docs/multi-stage-review.md) — the staged Find / Verify / Synthesize pipeline behind `--review-depth`.
|
|
182
|
+
- [Observability](https://github.com/weareikko/code-review/blob/main/packages/code-review/docs/observability.md) — diagnostics-channel tracing and the opt-in OpenTelemetry bridge (spans, metrics, logs).
|
|
183
|
+
- [Output format](https://github.com/weareikko/code-review/blob/main/packages/code-review/docs/output-format.md) — inline-comment shape, the upserted summary (a note on GitLab, an issue comment on GitHub), footer, and duplicate prevention.
|
|
184
184
|
|
|
185
185
|
## Configuration
|
|
186
186
|
|
|
@@ -190,11 +190,11 @@ The CLI auto-resolves most values from the CI environment (GitLab CI variables o
|
|
|
190
190
|
code-review --model anthropic/claude-sonnet-4-5 --api-key "$ANTHROPIC_API_KEY"
|
|
191
191
|
```
|
|
192
192
|
|
|
193
|
-
Equivalently, set `CODE_REVIEW_MODEL` and the provider's key (e.g. `ANTHROPIC_API_KEY`) as CI/CD variables (GitLab) or repository/organization variables and secrets (GitHub). Common knobs include `--min-severity`, `--thinking`, `--posting-mode draft`, `--no-summary`, and `--dry-run`. See the full [environment-variable and flag reference](https://github.com/weareikko/code-review/blob/main/docs/configuration.md).
|
|
193
|
+
Equivalently, set `CODE_REVIEW_MODEL` and the provider's key (e.g. `ANTHROPIC_API_KEY`) as CI/CD variables (GitLab) or repository/organization variables and secrets (GitHub). Common knobs include `--min-severity`, `--thinking`, `--posting-mode draft`, `--no-summary`, and `--dry-run`. See the full [environment-variable and flag reference](https://github.com/weareikko/code-review/blob/main/packages/code-review/docs/configuration.md).
|
|
194
194
|
|
|
195
195
|
## Providers
|
|
196
196
|
|
|
197
|
-
`code-review` uses [`@earendil-works/pi-ai`](https://github.com/earendil-works/pi-ai) for model access. Any registered provider can be selected with `--model provider/modelId` (e.g. `anthropic/claude-sonnet-4-5`, `openrouter/anthropic/claude-opus-4.5`, `google/gemini-2.5-flash`, `ollama/qwen2.5-coder:32b`). See [Providers](https://github.com/weareikko/code-review/blob/main/docs/providers.md) for per-provider setup and the model pool.
|
|
197
|
+
`code-review` uses [`@earendil-works/pi-ai`](https://github.com/earendil-works/pi-ai) for model access. Any registered provider can be selected with `--model provider/modelId` (e.g. `anthropic/claude-sonnet-4-5`, `openrouter/anthropic/claude-opus-4.5`, `google/gemini-2.5-flash`, `ollama/qwen2.5-coder:32b`). See [Providers](https://github.com/weareikko/code-review/blob/main/packages/code-review/docs/providers.md) for per-provider setup and the model pool.
|
|
198
198
|
|
|
199
199
|
## Artifacts
|
|
200
200
|
|
|
@@ -236,34 +236,9 @@ Use these files for CI debugging and auditing.
|
|
|
236
236
|
|
|
237
237
|
## Development / release
|
|
238
238
|
|
|
239
|
-
|
|
240
|
-
npm run typecheck
|
|
241
|
-
npm test
|
|
242
|
-
npm run build
|
|
243
|
-
npm pack --dry-run
|
|
244
|
-
```
|
|
245
|
-
|
|
246
|
-
Do not edit `CHANGELOG.md`: each pull request adds a fragment in `.changelog/` (format: [`weareikko/changelog`](https://github.com/weareikko/changelog)), or gets the `no-changelog` label when users do not see the change.
|
|
247
|
-
|
|
248
|
-
Each merge into `main` releases: the `Publish` workflow tests, folds the fragments into `CHANGELOG.md`, bumps the version, tags, publishes to npm and creates the GitHub release. A merge without a fragment (and without a dependency pull request from Renovate) releases nothing. The fragments give the version ([automatic version](https://github.com/weareikko/changelog#automatic-version)):
|
|
249
|
-
|
|
250
|
-
| Entries | From 1.0.0 | On 0.x |
|
|
251
|
-
| ------------------------------------------ | ---------- | ------ |
|
|
252
|
-
| A breaking entry (`**BREAKING**: …`) | major | minor |
|
|
253
|
-
| An entry under `Added`, no breaking entry | minor | patch |
|
|
254
|
-
| Other entries only (fixes, `Dependencies`) | patch | patch |
|
|
255
|
-
|
|
256
|
-
Prereleases follow the file `.changelog/prerelease` ([prereleases](https://github.com/weareikko/changelog#prereleases)): a pull request that adds it with `beta` makes the next merges with fragments release prereleases (from `0.10.0`, a fix gives `0.10.1-beta.0`, then `0.10.1-beta.1`…); a pull request that deletes it releases the stable version, also without a new fragment. A prerelease (a version with a `-`) is published on the `next` npm dist-tag, is a GitHub prerelease and does not move the `@0` / `@0.x` tags; any other version goes to `latest`.
|
|
257
|
-
|
|
258
|
-
A manual run forces a bump, for example a major version without a breaking entry:
|
|
259
|
-
|
|
260
|
-
```bash
|
|
261
|
-
gh workflow run publish.yml -f version=major # or patch / minor
|
|
262
|
-
```
|
|
263
|
-
|
|
264
|
-
Publishing uses npm trusted publishing (no npm token) and skips a version that npm already has: if the `Publish to npm` job fails, use "Re-run failed jobs".
|
|
239
|
+
This package lives in the [weareikko/code-review](https://github.com/weareikko/code-review) monorepo, next to [`@weareikko/agent-context`](https://github.com/weareikko/code-review/tree/main/packages/agent-context), which loads its context files, skills and MCP server configuration. Both packages share one version and are released together. See [CONTRIBUTING.md](https://github.com/weareikko/code-review/blob/main/CONTRIBUTING.md) for the commands, the changelog fragments and the release.
|
|
265
240
|
|
|
266
|
-
Eval tests call the real LLM and require `ANTHROPIC_API_KEY` (or `CODE_REVIEW_API_KEY`) in
|
|
241
|
+
Eval tests call the real LLM and require `ANTHROPIC_API_KEY` (or `CODE_REVIEW_API_KEY`) in the `.env` file at the repository root:
|
|
267
242
|
|
|
268
243
|
```bash
|
|
269
244
|
npm run test:evals
|