feat: surface preview and deprecated APIs in help
- Dominant language
- TypeScript
- Stars
- 41
- Forks
- 24
- Avg merge
- 1d 3h
- Merged PRs (30d)
- 56
Description
We keep `x-deprecated` / `x-availability` on schemas and do not show them (`ARCHITECTURE.md`). The whole CLI is tech preview, but some generated endpoints are already deprecated upstream.
- Mark deprecated flags/commands in `--help` (and `--help --json`)
- Emit a one-line stderr warning when a deprecated command runs (not when `--help` runs)
- Optional: prefix preview-only namespaces when `--command-profile` hides the rest
Do not hide deprecated commands before 1.0; warn only.
Acceptance: a deprecated command's `--help` says deprecated. Invoking it prints a warning on stderr and still runs.
Contributor guide
Research direction
Start by reading ARCHITECTURE.md and locating the CLI entry points for --help, --help --json, and --command-profile. Trace how x-deprecated and x-availability are retained on schemas and how command invocation is dispatched. Done means deprecated commands are marked in both help formats, invocation emits a one-line stderr warning while still running, and help itself emits no warning.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- cli
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 68/100