Skip to content

feat(derive): keep command aliases on their args - #946

Merged
jdx merged 1 commit into
claude/derive-unknown-flags-inheritfrom
agent/derive-clap-migration
Aug 17, 2026
Merged

feat(derive): keep command aliases on their args#946
jdx merged 1 commit into
claude/derive-unknown-flags-inheritfrom
agent/derive-clap-migration

Conversation

@jdx

@jdx jdx commented Aug 17, 2026

Copy link
Copy Markdown
Owner

Summary

  • accept alias and alias_hidden(...) on derived Args command structs
  • merge struct aliases with any enum-variant aliases for backwards compatibility
  • reject duplicate command names and aliases at compile time
  • document the migration-friendly placement and cover it with conformance tests

This lets Clap-shaped command structs keep their command metadata when moving to usage_derive, so callers no longer need to relocate aliases into the parent enum.

Stack

Targets #939 (claude/derive-unknown-flags-inherit). #936 should be retargeted onto the final PR in this stack.

Checks

  • cargo test -p usage-conformance --test subcommands
  • cargo test -p usage-derive
  • cargo test -p usage-argv
  • full stacked cargo test --all --all-features
  • full stacked Clippy with warnings denied

This PR was generated by Codex.


Note

Medium Risk
Changes derive codegen and static command tables used by every CLI; mistakes could break routing, help, or specs, though conformance tests cover the new alias paths.

Overview
Command aliases can live on derived Args structs (clap-style migration), not only on Subcommands variants. Visible and hidden aliases on the struct and on the mounting variant are joined at compile time via new concat_aliases, and emitted into both parse tables and metadata.

Root Cli still cannot declare aliases — those attributes are rejected there as misplaced. Duplicate aliases on one command fail at derive time; assert_unique_subcommand_names panics at compile time if any two subcommands share a name or alias after merging struct + variant tables.

Conformance tests move install/remove aliases onto the Args types and assert spec + parsing behavior (including hidden vs visible aliases).

Reviewed by Cursor Bugbot for commit 6a4511b. Bugbot is set up for automated code reviews on this repo. Configure here.

@coderabbitai

coderabbitai Bot commented Aug 17, 2026

Copy link
Copy Markdown

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Central YAML (base), Organization UI (inherited)

Review profile: CHILL

Plan: Pro Plus

Run ID: dcb35ec6-0b49-406a-bda2-ab77be7767a1

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@greptile-apps

greptile-apps Bot commented Aug 17, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

The PR preserves aliases declared directly on derived Args structs when they are mounted as subcommands, while retaining aliases declared on enum variants.

  • Concatenates struct-level and variant-level visible and hidden alias metadata into generated static command tables.
  • Adds compile-time validation that rejects collisions among command names and aliases after composition.
  • Extends attribute parsing, documentation, and conformance coverage for migration-friendly alias placement.

Confidence Score: 5/5

The PR appears safe to merge, with alias composition, visibility metadata, and duplicate-name rejection remaining consistent across generated parser and specification tables.

The changed derive paths preserve aliases from both declaration levels, maintain matching hot and cold metadata, and reject ambiguous composed names at compile time; no actionable failure remains.

Important Files Changed

Filename Overview
derive/src/codegen.rs Emits struct-level aliases, composes them with variant aliases, keeps hidden-alias metadata aligned, and validates the completed subcommand table.
derive/src/model.rs Parses and validates alias attributes on derived Args while retaining placement checks that reject them on root Cli declarations.
argv/src/lib.rs Adds const-compatible validation for duplicate command names and aliases across fully composed subcommand tables.
argv/src/spec.rs Adds compile-time alias-slice concatenation using lengths calculated from the same source groups.
conformance/tests/subcommands.rs Exercises aliases split between Args structs and Subcommands variants and verifies emitted visibility metadata.
derive/src/lib.rs Documents supported alias placement and the composition behavior when both declaration levels provide aliases.

Reviews (1): Last reviewed commit: "feat(derive): keep command aliases on th..." | Re-trigger Greptile

@github-actions

Copy link
Copy Markdown
Contributor

Instruction counts

Nothing was compared, and so nothing was gated. No series appears on both sides: either the base has no measurements recorded, or the two were measured on different runner classes, which are deliberately not comparable — counts shift between machine types by more than a real regression does.

New, nothing to compare against: markdown on bamboo-v2-ubuntu24.04-x64-30vcpu-24gb-rust1.97.1, startup on bamboo-v2-ubuntu24.04-x64-30vcpu-24gb-rust1.97.1

Only instruction counts gate. Wall clock is shown for context — on identical hardware it moves 4-20% run to run.

Measured by tak — instruction-counted CLI benchmarks, stored in this repository's git notes.

Shadow comparison

Parsing mise use -g node@20 against a shadow of mise's committed spec.
Reported, not gated: the shadow grows as the derive learns to express more, so
what to watch is the ratio rather than either column.

usage clap ratio
instructions, cold parse 60566 5893652 97x
usage: argv -> struct                            1030 ns      1.03 µs
clap: build tree + parse -> struct             499514 ns    499.51 µs
clap: parse -> struct, tree reused              23413 ns     23.41 µs
clap: build tree only                          308597 ns    308.60 µs

6a4511b2bd81 vs 2ff6307581d6 · measured on the runner, not pushed to the history.

@jdx
jdx merged commit 6555ef9 into main Aug 17, 2026
11 checks passed
@jdx
jdx deleted the agent/derive-clap-migration branch August 17, 2026 04:26
jdx added a commit that referenced this pull request Aug 17, 2026
…#965)

Stacked on #963, the `usage-rs` facade.

`usage` is now its own first adopter. Its command structs, root, and
command enums use the `usage-rs` facade instead of Clap, and
`--usage-spec` prints `Cli::to_kdl()` from the same tables that parsed
the command line.

## What goes away

- `clap`, `clap_usage`, and the `clap-sort` dev dependency
- `tests/clap_sort.rs`; declaration order is held by the spec
- the duplicated command-effect tables; effects now live on the commands
they describe
- the empty `Sponsors` struct; unit subcommands are supported directly
- runtime checks for relationships the spec can express

## Migration shape

The declarations remain close to their former Clap layout:

- inferred shorts use `#[usage(short, long)]`
- command aliases live on their command structs, e.g. `#[usage(alias =
"c", alias_hidden("complete", "completions"))]`
- positive dependencies use `requires`, including `--cache-key` →
`--usage-cmd` and `--out-dir` → `--multi`
- aliases written on enum variants still merge with struct aliases for
compatibility
- deliberately formatted docs keep `#[usage(verbatim_doc_comment)]`
- path hints keep `value_hint = usage_rs::ValueHint::FilePath` or
`DirPath` from usage’s own runtime type
- subcommand payloads stay unboxed as they were under Clap; `Box<T>`
remains an optional size optimization

The four shell commands are separate derived structs flattening a shared
group. A single destination struct cannot identify which enum variant
selected it, so a macro keeps their common declaration in one place.

## Parity gaps closed by the stack

- required subcommands survive KDL generation (#937)
- strict unknown-flag behavior is inherited by subcommands (#939)
- command-owned visible and hidden aliases are supported (#946)
- duplicate non-repeatable flags are rejected (#945)
- a missing required subcommand prints the available command choices
(#947)
- verbatim doc-comment layout is preserved on commands, fields, and
variants (#949)
- file and directory value hints reach native and emitted completions
(#951)

The emitted spec still intentionally gains metadata the Clap bridge
dropped, including `JDX_USAGE_BIN` on `--usage-bin`, preserved multiline
long help, the manpage description, and the correct binary name `usage`.

## Verification

- `mise run render`
- `cargo test --all --all-features`
- `cargo clippy --all --all-features --all-targets -- -D warnings`
- direct binary checks for no-argument help, duplicate flags, command
aliases, and positive requirements

_This PR was generated by Codex._

<!-- CURSOR_SUMMARY -->
---

> [!NOTE]
> **Medium Risk**
> Changes how the primary `usage` CLI is parsed and documented
(including `--completions` UX), but behavior is covered by updated
integration tests and is an intentional migration to the shipped parser.
> 
> **Overview**
> The **`usage` binary dogfoods `usage-rs`**: command structs use
`#[derive(usage_rs::Cli)]` / `#[usage(...)]` instead of Clap, and
**`--usage-spec` emits `Cli::to_kdl()`** from the same parse tables that
handle argv. **Clap, `clap_usage`, and `clap-sort` are removed**, along
with the post-hoc **`command_effects` patch table**—`effect`,
`requires`, `overrides`, and similar metadata now live on the
declarations.
> 
> **Root CLI shape is corrected in spec and docs**: **`--completions
<SHELL>` is a long flag** (not a positional), with an **explicit
multi-line `usage` synopsis** for `usage <COMMAND>` / `--completions` /
`--usage-spec`. Shell runner commands (`bash`, `fish`, `zsh`,
`powershell`, `exec`) use **`unknown_flags = "value"`** so script
arguments can include unknown flags.
> 
> **Help and manpages** gain support for an optional root **`usage`
string** on `Spec` (derive + KDL emission); root help/man synopsis
prefer that over generated lines. Generated assets (`usage.usage.kdl`,
`usage.1`, Fig spec, CLI reference markdown, snapshots) are refreshed to
match.
> 
> <sup>Reviewed by [Cursor Bugbot](https://cursor.com/bugbot) for commit
3aba1aa. Bugbot is set up for automated
code reviews on this repo. Configure
[here](https://www.cursor.com/dashboard/bugbot).</sup>
<!-- /CURSOR_SUMMARY -->

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

* **New Features**
  * Added `--completions <SHELL>` for selecting a completion shell.
* Improved command validation, aliases, defaults, environment settings,
and file-output completion hints.
  * Shell commands now forward unrecognized arguments as script values.
  * Added clearer help text and descriptions for generation commands.

* **Documentation**
* Updated CLI references, manpages, usage specifications, and shell
documentation to reflect revised options and behavior.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

Replaces #936 after flipping the facade and CLI layers.

---------

Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant