JasonFreeLab/dsh-command-code-review

dsh-command-code-review

English | 中文

A DSH (DeepSeek Harness) slash-command bundle that runs a full code review — configurable review lenses with per-finding confidence and severity scoring, for both pull requests and local code.

/code-review slash command for DeepSeek Harness — self-contained plugin bundle, installable into any dsh profile.

Table of Contents

• Features
• Requirements
• Install
• Usage
• How it works
• Configuration
• Troubleshooting
• Layout
• Development
• Contributing
• License

Features

• Two modes, one command — /code-review reviews a pull request; /code-review [request] (or empty) reviews local code.
• Configurable review lenses — five by default (AGENTS.md/CLAUDE.md compliance, bug & correctness, historical context, security, code-comment compliance), plus an optional performance lens; choose a subset per profile.
• Confidence + severity scoring — findings are deduplicated across lenses, then batch-scored for confidence (real vs false positive) and severity (blocker/major/minor/nit); anything below the threshold is dropped (default 80).
• PR auto-reply — pull-request results are posted back to the PR with gh; local results are reported in chat.
• Configurable — the confidence threshold is set per profile (see Configuration).
• Review report document — local reviews are written as a structured Markdown report (in English) plus a machine-readable JSON sidecar, under doc/ by default; override the directory with --out per invocation or config.outputDir per profile. The filename embeds the current HEAD's short sha (omitted outside a git repo).
• Tracks the current dsh runtime — the bundle targets the dsh 0.2.x plugin API: engines.dsh compatibility metadata, an exported schemastery Config schema, a producer-owned message source kind, and the asynchronous subagent tool contract.

Requirements

• A dsh 0.2.x runtime — ^0.2.1-rc.2, declared as engines.dsh. The dsh loader validates this range when the plugin is installed and when a profile boots; incompatible bundles are skipped unless the user grants an explicit exact-version exemption.
• A dsh profile built on @deepseek-ai/dsh-base (the shipped web, headless, sdk, and acp profiles; sdk-minimal is a standalone tree and lacks the commands service), which provides the commands service and the subagent/bash/todo tools the workflow uses.
• The GitHub CLI (gh) on PATH, authenticated — required only for pull-request review. Local review needs no gh.

Install

From the npm registry:

dsh plugin --profile web add dsh-command-code-review

From a local checkout or tarball:

# directory
dsh plugin --profile web add /path/to/dsh-command-code-review

# packed tarball
dsh plugin --profile web add /path/to/dsh-command-code-review-<version>.tgz

The dsh plugin add command installs the package into the profile and, because its package.json declares dsh.bundle, appends it to dsh.profile.bundles automatically. The install also checks the bundle's dsh requirements (engines.dsh); if it names an incompatible runtime, upgrade either dsh or the plugin. Restart or re-boot the profile to pick it up.

Usage

In the DSH web UI

1. Start the web UI and open the printed URL: dsh web (alias of dsh --profile web).
2. Start a new session and type /code-review in the composer. The command is registered automatically — no extra setup.
3. For pull requests the result is posted back to the PR via gh; for local review, findings are reported directly in chat.

Examples

/code-review 123                                  # review a pull request by number
/code-review https://github.com/owner/repo/pull/123
/code-review review src/auth                      # local review of a named scope
/code-review review the whole project             # local review of the entire repository
/code-review                                      # local review of the current uncommitted changes
/code-review review src/auth --out reports        # save the report under reports/
/code-review --out docs review src/auth           # --out may come first or last

Empty input first probes the current branch's open PR, then falls back to reviewing uncommitted changes.

For local reviews, the report is also written to a Markdown document — under doc/ by default, or wherever --out (or config.outputDir) points. The filename is code-review--.md in a git repo (` is the current HEAD's short sha, is derived from the review scope), and code-review-.md` outside a git repo.

How it works

The package is a standard dsh bundle:

• package.json declares "dsh": { "bundle": { "patch": "./cordis.patch.yml" } } and the supported runtime range in engines.dsh.
• cordis.patch.yml inserts one plugin row (id: command-code-review) into the profile layer stack.
• lib/index.js is a Cordis plugin that injects commands and registers the code-review command. It exports a schemastery Config schema (so profile configuration is validated at load time) and one handler that routes PR numbers/URLs to the pull-request workflow and everything else (including empty input) to the local-review workflow, then delivers the workflow through agent.followup as a notice user message carrying this plugin's own command-code-review source kind. The workflows tell the agent to launch subagents in parallel and await the runtime's completion notices rather than polling; the dsh 0.2.x subagent tool always runs asynchronously, so no background flag is used.

Users can disable or override the command from their own profile cordis.patch.yml:

- id: command-code-review
  disabled: true

Configuration

Configuration is validated by the exported Config schema, so an invalid value fails the plugin load with a clear error instead of being silently ignored.

• Confidence threshold: the workflow drops findings scored below a threshold (default 80). Override it in your profile cordis.patch.yml:

- id: command-code-review
    config:
      threshold: 90

• Report output directory: where local-review reports are saved (default doc). Override per profile:

- id: command-code-review
    config:
      outputDir: reports

or per invocation with --out: /code-review --out reports review src/auth.

• Review lenses: available lens ids are guidance, bugs, history, security, comments, and perf. The default set is guidance, bugs, history, security, comments. Choose a subset per profile:

- id: command-code-review
    config:
      lenses: [guidance, bugs, security]

• Adaptive lenses: with autoLenses: true (the default), the security lens is auto-enabled when the scope touches security-sensitive files and the performance lens when it touches hot paths — if they are not already enabled. Disable with autoLenses: false.

Troubleshooting

• `Plugin dsh-command-code-review@… is incompatible with dsh …`: the running dsh runtime is outside this version's engines.dsh range. Upgrade dsh to 0.2.x or install a matching plugin version. Only as a last resort, grant the exact-version exemption (dsh plugin allow-version).
• No review comment posted: the PR is closed, draft, trivial, or already reviewed; or no finding scored 80 or above.
• `gh` not found: install and authenticate the GitHub CLI (gh auth login); only pull-request review needs it.
• Code links do not render: use the full commit SHA and the #L[start]-L[end] line range.

Layout

lib/index.js             # Cordis plugin that registers the /code-review command
lib/lenses.js            # review-lens registry + resolution
lib/parse.js             # invocation parsing (--out flag)
test/smoke.test.mjs      # package/bundle metadata smoke test
test/plugin.test.mjs     # command registration + handler delivery test
test/parse.test.mjs      # parser unit test
test/lenses.test.mjs     # lens resolution unit test
cordis.patch.yml         # bundle patch
.github/workflows/       # ci.yml + release.yml + release-please.yml

Development

npm install
npm test        # node --test (smoke + plugin handler + parser + lens unit tests)

The plugin handler test imports lib/index.js against the declared peer dependencies and registers the command into a real @deepseek-ai/dsh-commands runtime, so it covers the real createUserMessage/schemastery/command-registry paths.

Contributing

Issues and pull requests are welcome.

License

MIT