@staff0rd/assist 0.680.1 → 0.682.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 +4 -0
- package/claude/commands/high-level-config.md +48 -0
- package/dist/commands/sessions/web/bundle.js +1 -1
- package/dist/index.js +539 -175
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -53,6 +53,7 @@ After installation, the `assist` command will be available globally. You can als
|
|
|
53
53
|
- `/fix-rules [dir]` - Put existing rules into the `## Rules` format `assist rules` reads
|
|
54
54
|
- `/forward-comments` - Split a coarse PR comment into per-line review comments, attributed to the original reviewer
|
|
55
55
|
- `/handover` - Write a session handover note for the next conversation
|
|
56
|
+
- `/high-level-config` - Set this repo's high-level review checklist keys: propose `review.highLevel.criticalPaths` and `uiPaths` from the repo's own tree with the files each glob matches, put them to the user to accept or edit, then write the accepted answers with `assist review --high-level --configure --answer ...` to the project `assist.yml` or this repo's block in `~/.assist.yml`
|
|
56
57
|
- `/pr` - Raise a PR with a concise description, then watch CI in the background
|
|
57
58
|
- `/prs-slack <number> [--no-confirm]` - Post a PR's title and URL to the Slack channel configured in `prs.slack`; `--no-confirm` skips the confirmation and posts straight away (used by chained announces)
|
|
58
59
|
- `/prs-status [channel] <owner/repo>...` - Post an overview of the open PRs across the named repos to Slack: a summary line in the channel, the PRs grouped by what they are waiting on in its thread; the channel falls back to `slack.channel`
|
|
@@ -140,6 +141,9 @@ Every command supports `--help` for full detail on its flags and behaviour.
|
|
|
140
141
|
- `--backlog` - Skip posting; file all findings as a single bug backlog item with one phase per finding
|
|
141
142
|
- `--checkout-only` - Skip the review entirely; check the PR out and leave an idle interactive Claude session running in the checkout tree. Requires a PR number, and cannot be combined with `--refine`, `--apply`, `--backlog` or `--submit`
|
|
142
143
|
- `--high-level` - Skip the LLM review; check the PR branch out and step through the high-level review checklist in the web UI preview pane, ticking the manual items and commenting on any item. The deterministic items are What/Why present, description under `review.highLevel.descriptionWordCap`, a GitHub issue linked, and a screenshot or video whenever a changed file matches `review.highLevel.uiPaths`; the manual items are change structure, critical-file diffs and backend PR linked. The two structural items carry their evidence in the pane: the structure item expands to the changed-file tree, each file marked added/deleted/modified with its `+`/`-` line counts, folders collapsible with their collapsed state remembered per PR, and clicking a file opens its diff in the same viewer the session diff uses (syntax highlighting, word-level edit marks, unified or split) in a dialog with a link out to GitHub; the critical-diff item expands to the full diff of every changed file matching `review.highLevel.criticalPaths`, inline in that same viewer. Diffs are capped at 1500 lines per file and 20000 across the review, whole hunks at a time and critical files first, with anything past the cap pointing at GitHub. Approving or requesting changes writes the verdict, per-item state and comments to `~/.assist/high-level-reviews/<repo>/<branch>-<head-sha>.json` and prints the path; re-running against the same head SHA reopens that saved review with its ticks and comments intact, unless `--force` is passed. Outside an assist session the checklist, the tree and the critical diffs are printed to the terminal instead. Nothing is posted to GitHub. Cannot be combined with `--refine`, `--apply`, `--backlog`, `--submit` or `--checkout-only`. See [docs/high-level-review.md](docs/high-level-review.md)
|
|
144
|
+
- `--configure` - With `--high-level`: review nothing and configure the checklist instead. Asks for `review.highLevel.criticalPaths`, `uiPaths` and `descriptionWordCap` one at a time, each prefilled with its current value or, where the key is unset, with globs Claude proposes from this repo's own tree (every tracked directory and the extensions in it, so the proposal matches files the repo actually has); each answer is accepted, edited or left blank to leave that key unset. Before the questions it asks which config file the answers go to — the project `assist.yml`, checked in and shared with the team, or this repo's block in `~/.assist.yml`, personal, as `config set -g --repo` writes it — and all the answers are written in one pass at the end, so a rejected value leaves the file untouched. Takes no PR number and requires `--high-level`. The same flow is available to any command through the `configureConfigKeys` helper (`src/commands/config/configureConfigKeys.ts`), which takes `{key, question, suggest}` entries and answers each by prompting or from answers its caller supplies
|
|
145
|
+
- `--scope <project|repo>` - With `--configure`: write to the repo's own `assist.yml` (`project`) or this repo's block in `~/.assist.yml` (`repo`) instead of asking which
|
|
146
|
+
- `--answer <key=value>` - With `--configure`: answer one key without prompting, repeatable. This is the path for an agent that has already put the choice to the user — `/high-level-config` proposes the globs from the repo tree in the session, then passes the accepted answers here. Answer all three keys and nothing is prompted for and no globs are proposed; an empty value (`--answer 'review.highLevel.uiPaths='`) leaves that key unset
|
|
143
147
|
- `--address-comments` - After the review posts comments and submits, start an Address Comments session (`assist review-pr-comments <n>`) for the PR. Only fires inside an assist session, and only when at least one comment was posted and the review was submitted
|
|
144
148
|
- `--announce` - Announce the PR in Slack (`/prs-slack <n> --no-confirm`) at the tail of the chain: the Address Comments session announces once every thread is processed when one was started, otherwise a `/prs-slack` session is started directly. Announces exactly once, and only inside an assist session
|
|
145
149
|
- `--verbose` - Per-line log output instead of the stacked-spinner UI (automatic in CI)
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: Configure this repo's high-level review checklist keys
|
|
3
|
+
allowed_args: "[what matters in this repo, e.g. 'the graphql schema and the translation catalogue']"
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
The user wants to set `review.highLevel.criticalPaths`, `review.highLevel.uiPaths` and `review.highLevel.descriptionWordCap` for this repo — the three variable parts of the high-level review checklist (`assist review --high-level`, see `docs/high-level-review.md`). You propose the values from the repo itself; the user accepts or edits them; `assist` writes them.
|
|
7
|
+
|
|
8
|
+
## Step 1: Read what is already set
|
|
9
|
+
|
|
10
|
+
```
|
|
11
|
+
assist config get review.highLevel.criticalPaths
|
|
12
|
+
assist config get review.highLevel.uiPaths
|
|
13
|
+
assist config get review.highLevel.descriptionWordCap
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
A key that is already set is the starting point — propose a change to it only where you can say why.
|
|
17
|
+
|
|
18
|
+
## Step 2: Propose globs from this repo's own tree
|
|
19
|
+
|
|
20
|
+
Look at the repo, do not guess from its language or framework. `git ls-files` is the source; read enough of the files you are unsure about to be sure.
|
|
21
|
+
|
|
22
|
+
- **criticalPaths** — the files where a wrong line is expensive and an LLM reviewer cannot judge it: schema and API definitions, translation catalogues, database migrations, infrastructure and deployment definitions, dependency and permission manifests. Their full diffs are put in front of the human reviewer, so keep the set small — a glob that matches half the repo makes the item unreadable and it will be rubber-stamped.
|
|
23
|
+
- **uiPaths** — the files that render the user interface, so that touching one requires a screenshot or video on the PR. Exclude tests and stories.
|
|
24
|
+
- **descriptionWordCap** — leave at 300 unless the user asks otherwise.
|
|
25
|
+
|
|
26
|
+
Every glob must match files this repo actually has. Check each one does before proposing it.
|
|
27
|
+
|
|
28
|
+
## Step 3: Put the proposal to the user
|
|
29
|
+
|
|
30
|
+
Show the globs with, for each, the files in this repo it matches (a count, plus a few names). Ask them to accept or edit, and ask which config file the values go to:
|
|
31
|
+
|
|
32
|
+
- `project` — the repo's own `assist.yml`, checked in, so the team reviews against the same globs
|
|
33
|
+
- `repo` — this repo's block in `~/.assist.yml`, personal to this machine
|
|
34
|
+
|
|
35
|
+
## Step 4: Write the answers
|
|
36
|
+
|
|
37
|
+
Pass every key, so nothing is prompted for — you have already asked:
|
|
38
|
+
|
|
39
|
+
```
|
|
40
|
+
assist review --high-level --configure --scope project \
|
|
41
|
+
--answer 'review.highLevel.criticalPaths=**/*.graphql,en-AU/translation.json' \
|
|
42
|
+
--answer 'review.highLevel.uiPaths=src/ui/**' \
|
|
43
|
+
--answer 'review.highLevel.descriptionWordCap=300'
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
An empty value (`--answer 'review.highLevel.uiPaths='`) leaves that key unset — which for `uiPaths` means the UI-evidence check passes rather than fails, so only do it when the user has said the repo has no UI.
|
|
47
|
+
|
|
48
|
+
All three are validated and written in one pass, so a rejected value leaves the config file untouched. Report what was written and where, quoting the command's own output.
|