Skip to content

Adds aliases to the dump-help output.#813

Merged
rauhul merged 6 commits intoapple:mainfrom
jglogan:dump-help-aliases
Jan 12, 2026
Merged

Adds aliases to the dump-help output.#813
rauhul merged 6 commits intoapple:mainfrom
jglogan:dump-help-aliases

Conversation

@jglogan
Copy link
Copy Markdown
Contributor

@jglogan jglogan commented Sep 15, 2025

Closes #812 by adding aliases to DumpHelpGenerator and ToolInfo.

Checklist

  • I've added at least one test that validates that my change is working, if appropriate
  • I've followed the code style of the rest of the project
  • I've read the Contribution Guidelines
  • I've updated the documentation if necessary

/// Name used to invoke the command.
public var commandName: String
/// List of command aliases.
public var aliases: [String]
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

to maintain compatibility with tool info v1 we need to make this Optional

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! I'll make the change.

So I understand better (I'm new to the code, first PR), where would I need to look to know that? I just did a code search of the project for aliases and I didn't see any hints about this.

Is it just a rule that any new fields are Optional (it seems aliases was added later) to keep compatibility straightforward?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@rauhul Anything else needed for this PR? Thanks!

@jglogan jglogan requested a review from rauhul September 16, 2025 19:05
@rauhul rauhul force-pushed the dump-help-aliases branch from 857fe55 to 385e641 Compare January 12, 2026 16:50
@rauhul rauhul enabled auto-merge (squash) January 12, 2026 17:18
@rauhul rauhul requested review from Copilot and natecook1000 and removed request for Copilot, natecook1000 and rauhul January 12, 2026 17:18
@rauhul
Copy link
Copy Markdown
Collaborator

rauhul commented Jan 12, 2026

Accidentally asked for a copilot review.

@rauhul rauhul merged commit bbf95b7 into apple:main Jan 12, 2026
63 of 64 checks passed
@jglogan jglogan deleted the dump-help-aliases branch January 12, 2026 17:40
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.

Include command aliases in the help dump.

2 participants