Repository navigation
Help: Changed help and pagination to translatable components - #17
Merged
Merged
Conversation
whereareiam
added a commit
to whereareiam/chassis
that referenced
this pull request
Nov 8, 2026
The module commands carry Commandant's TranslatableDescription of <prefix>description.<name>, so Commandant's help shows them in each reader's language; ExtensionMessages holds their English descriptions in the host's words. Commandant moves to 2.0.0-local-aa2ac7e, the local build of whereareiam/commandant#17, until that release is published. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Merged
7 tasks done
Help and pagination are built from translatable components under a prefix the plugin chooses, with named arguments from an ArgumentFactory such as semantica's TextArgument::of. HelpBuilder.Text and PaginationBuilder.Text list the keys and their arguments; plugins write the texts in their own wording. TranslatableDescription gives commands translatable descriptions. HelpMessages, PaginationMessages and the token path are removed. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
whereareiam
force-pushed
the
feature/translatable-help
branch
from
November 8, 2026 16:24
517e3bb to
f036759
Compare
whereareiam
added a commit
to whereareiam/chassis
that referenced
this pull request
Nov 9, 2026
The module commands carry Commandant's TranslatableDescription of <prefix>description.<name>, so Commandant's help shows them in each reader's language; ExtensionMessages holds their English descriptions in the host's words. Commandant moves to 2.0.0-local-aa2ac7e, the local build of whereareiam/commandant#17, until that release is published. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Help and pagination are now Adventure components that each reader's translator renders, instead of one MiniMessage string for everyone.
HelpBuilder.buildreturns aComponentmade of translatable keys under a prefix the plugin chooses (for examplearbor.help). Named arguments come from anArgumentFactorythe plugin passes, such as semantica'sTextArgument::of. Commandant does not depend on semantica.HelpBuilder.TextandPaginationBuilder.Textlist every key with the named arguments it gets, and plugins write the texts in their own wording:title{host},command{command, arguments, description},argument{name},optionalArgument{name},empty, and underpagination:line{current, max, previous, next},previous{page},next{page}.TranslatableDescription.of(key)gives a command a translatable description. The help renders anyDescriptionthat is also aComponentLikeas that component.pageCommand, so translations need no click tags.HelpMessages,PaginationMessagesand the token path are removed.CommandantSyntaxFormatternow takes its two argument templates as strings.Release notes
Area: Descriptionwith a listed areaHelp: Fixed ...feature,change,bug,dependencies, orskip-changelogbugonly for a bug that shipped in a release; a fix for a bug that only existed ondevisskip-changelogmajoradded when plugins must change their code on upgrade.github/release-notes.md, if plugins need themChecks
🤖 Generated with Claude Code