Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Conversation

jglogan
Copy link

@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

@@ -49,6 +49,8 @@ public struct CommandInfoV0: Codable, Hashable {

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

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
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?

@jglogan jglogan requested a review from rauhul September 16, 2025 19:05
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