Commit 258e94b
authored
feat(cli): add Examples help text to 7 feat subcommands (#812)
## Summary
Adds `addHelpText('after', ...)` Examples sections to seven `shep feat`
subcommands, mirroring the pattern in `ui.command.ts`.
## Motivation
New users discover subcommands via `shep feat <cmd> --help`. These seven
commands previously ended at the flag list with no runnable examples,
even though each file's JSDoc/Usage header already documented the
intended invocations.
## Changes
| Command | Examples |
|---------|----------|
| `feat adopt` | 2 |
| `feat archive` | 2 |
| `feat del` | 4 |
| `feat feedback` | 2 (includes concrete feedback string) |
| `feat promote` | 2 |
| `feat review` | 2 |
| `feat unarchive` | 1 |
Example invocations are taken from existing file-level Usage /
`@example` headers — no new flag combinations were introduced.
## Tests
- [x] `pnpm validate` (format, lint, typecheck, tsp:compile)
- [x] `pnpm dev:cli feat adopt --help`
- [x] `pnpm dev:cli feat archive --help`
- [x] `pnpm dev:cli feat del --help`
- [x] `pnpm dev:cli feat feedback --help`
- [x] `pnpm dev:cli feat promote --help`
- [x] `pnpm dev:cli feat review --help`
- [x] `pnpm dev:cli feat unarchive --help`
## Notes
- Documentation-only change; no runtime behavior changes.
- Example descriptions use inline English strings (not i18n), consistent
with `ui.command.ts` and other CLI help examples.
Fixes #790
Co-authored-by: syf2211 <syf2211@users.noreply.github.com>1 parent 0fd19be commit 258e94b
7 files changed
Lines changed: 50 additions & 0 deletions
File tree
- src/presentation/cli/commands/feat
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
20 | 20 | | |
21 | 21 | | |
22 | 22 | | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
23 | 30 | | |
24 | 31 | | |
25 | 32 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
30 | 30 | | |
31 | 31 | | |
32 | 32 | | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
33 | 40 | | |
34 | 41 | | |
35 | 42 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
34 | 34 | | |
35 | 35 | | |
36 | 36 | | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
37 | 46 | | |
38 | 47 | | |
39 | 48 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
21 | 21 | | |
22 | 22 | | |
23 | 23 | | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
24 | 31 | | |
25 | 32 | | |
26 | 33 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
24 | 24 | | |
25 | 25 | | |
26 | 26 | | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
27 | 34 | | |
28 | 35 | | |
29 | 36 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
79 | 79 | | |
80 | 80 | | |
81 | 81 | | |
| 82 | + | |
| 83 | + | |
| 84 | + | |
| 85 | + | |
| 86 | + | |
| 87 | + | |
| 88 | + | |
82 | 89 | | |
83 | 90 | | |
84 | 91 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
24 | 24 | | |
25 | 25 | | |
26 | 26 | | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
27 | 33 | | |
28 | 34 | | |
29 | 35 | | |
| |||
0 commit comments