Skip to content

Run checks

When To Use

Use this task before a commit, before a pull request, or when you need to reproduce the repository's CI plan locally.

Prerequisites

  • Run repo doctor from the workspace root.
  • Install dependencies with the repository's pinned pnpm version.
  • Decide whether you need a fast check or the full delivery gate.

Smallest Command

bash
repo check --dry-run

Expected Output

repoctl prints the selected tasks and the exact commands that would run. Remove --dry-run only after the plan matches the repository policy.

Common Branches

  • A staged file needs a focused check: use repo check --staged.
  • CI requires an artifact: add --json --out reports/check-plan.json.
  • You are preparing a release: use repo check --full after the fast check passes.

repo check provides stable, task-oriented entrypoints for local and CI verification. It preserves the underlying workspace scripts and reports which commands will run before execution.

Modes

ModeCommandPurpose
Defaultrepo checkLightweight pre-commit verification
Stagedrepo check --stagedlint-staged plus workspace-aware type checking
Fullrepo check --fullRoot lint, typecheck, build, test, and tsd workflow
Commit messagerepo check --edit-file <file>Validate a commit message file

Use --dry-run, --json, or --markdown to inspect the plan without running it. --out <file> persists the result and --redact removes local paths.

Pre-Commit

repo verify pre-commit runs the repository's staged-file policy. JavaScript, TypeScript, Vue, and style files are routed to the configured lint tasks.

Staged Type Checking

repo verify staged-typecheck <files...> maps changed TypeScript and Vue files to their owning workspace. Vue packages use their vue-tsc based typecheck script; TypeScript packages use tsc.

Pre-Push

repo verify pre-push is the comprehensive delivery gate. The repository policy builds first, then runs lint, type checks, type-level tests, and test suites against built artifacts.

Automation

bash
repo check --full --dry-run --json --out reports/check-plan.json
repo check --staged --markdown --redact --out reports/check-plan.md

JSON field names and command IDs do not change with --lang; only human-readable descriptions do.