@staff0rd/assist 0.821.0 → 0.823.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
CHANGED
|
@@ -146,6 +146,7 @@ Every command supports `--help` for full detail on its flags and behaviour.
|
|
|
146
146
|
- `review.highLevel.uiPaths` - Globs that make a change a UI change, requiring a screenshot or video; unset, the check passes
|
|
147
147
|
- `review.highLevel.descriptionWordCap` - Word cap for the PR description; defaults to 300
|
|
148
148
|
- `review.highLevel.testPaths` - Globs of test files whose changed tests back the tests checklist item as a file > describe > it hierarchy, each test's source a click away and each open to its own comment; defaults to `**/*.{test,spec}.{ts,tsx,js,jsx}`
|
|
149
|
+
- `review.highLevel.collapsedPaths` - Globs of files that start collapsed in the changed-files tree, each tagged with the glob it matched; a directory whose files all match starts collapsed; defaults to `**/*.test.*` and `**/generated/**`
|
|
149
150
|
- `assist github commits <org> [--since <date>] [--top <n>] [--json]` - Report commit activity across a GitHub organisation
|
|
150
151
|
- `assist github issue create --title <title> --body <body> [-R <owner>/<repo>] [--type <name>] [--parent <issue>] [--project <number>] [--status <name>] [--label <name>]` - Create a GitHub issue on the current repo (or `-R`'s), previewed for approval in a web session; the options set its issue type, parent issue, project, project status and labels
|
|
151
152
|
- `assist github issue edit <number> [-R <owner>/<repo>] [--body <body>] [--fresh] [--fetch] [--parent <issue>]` - Rework an issue's body in the web preview pane; `--body` previews a proposed body (`-` reads stdin) instead of the current one, `--fetch` writes the current body to the working file without previewing so it can be edited before the first preview, `--fresh` discards an unpushed revision, and `--parent` instead makes the issue a sub-issue of `<issue>`
|
|
@@ -3,7 +3,7 @@ description: Configure this repo's high-level review checklist keys
|
|
|
3
3
|
allowed_args: "[what matters in this repo, e.g. 'the graphql schema and the translation catalogue']"
|
|
4
4
|
---
|
|
5
5
|
|
|
6
|
-
The user wants to set `review.highLevel.criticalPaths`, `review.highLevel.uiPaths` and `review.highLevel.
|
|
6
|
+
The user wants to set `review.highLevel.criticalPaths`, `review.highLevel.uiPaths`, `review.highLevel.descriptionWordCap` and `review.highLevel.collapsedPaths` for this repo — the four 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
7
|
|
|
8
8
|
## Step 1: Read what is already set
|
|
9
9
|
|
|
@@ -11,6 +11,7 @@ The user wants to set `review.highLevel.criticalPaths`, `review.highLevel.uiPath
|
|
|
11
11
|
assist config get review.highLevel.criticalPaths
|
|
12
12
|
assist config get review.highLevel.uiPaths
|
|
13
13
|
assist config get review.highLevel.descriptionWordCap
|
|
14
|
+
assist config get review.highLevel.collapsedPaths
|
|
14
15
|
```
|
|
15
16
|
|
|
16
17
|
A key that is already set is the starting point — propose a change to it only where you can say why.
|
|
@@ -22,6 +23,7 @@ Look at the repo, do not guess from its language or framework. `git ls-files` is
|
|
|
22
23
|
- **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
24
|
- **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
25
|
- **descriptionWordCap** — leave at 300 unless the user asks otherwise.
|
|
26
|
+
- **collapsedPaths** — the files that are noise in the changed-files tree, so they start collapsed: tests, generated code, snapshots, lockfiles. Defaults to `**/*.test.*,**/generated/**`; keep the default unless this repo has other noise.
|
|
25
27
|
|
|
26
28
|
Every glob must match files this repo actually has. Check each one does before proposing it.
|
|
27
29
|
|
|
@@ -31,6 +33,7 @@ Do not ask in chat. Write the proposal as markdown to a scratch file with the Wr
|
|
|
31
33
|
|
|
32
34
|
- each glob as its own bullet, with the files in this repo it matches (a count, plus a few names), and why it belongs
|
|
33
35
|
- `descriptionWordCap` with its value
|
|
36
|
+
- `collapsedPaths`, each glob as its own bullet like the others
|
|
34
37
|
- the scope you propose, with the other one named so the user can swap it:
|
|
35
38
|
- `repo` — this repo's override in the shared assist database, personal to the user and seen by every node (propose this unless the user has said otherwise)
|
|
36
39
|
- `project` — the repo's own `assist.yml`, a file to check in so the team reviews against the same globs; only when the user asks for it, since it leaves a new file in a repo they may not own
|
|
@@ -54,9 +57,10 @@ Pass every key, so nothing is prompted for — you have already asked:
|
|
|
54
57
|
assist review --high-level --configure --scope repo \
|
|
55
58
|
--answer 'review.highLevel.criticalPaths=**/*.graphql,en-AU/translation.json' \
|
|
56
59
|
--answer 'review.highLevel.uiPaths=src/ui/**' \
|
|
57
|
-
--answer 'review.highLevel.descriptionWordCap=300'
|
|
60
|
+
--answer 'review.highLevel.descriptionWordCap=300' \
|
|
61
|
+
--answer 'review.highLevel.collapsedPaths=**/*.test.*,**/generated/**'
|
|
58
62
|
```
|
|
59
63
|
|
|
60
64
|
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.
|
|
61
65
|
|
|
62
|
-
All
|
|
66
|
+
All four 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.
|