Add required name field for plugin display names - #11
Merged
Conversation
Hosts previously had no manifest-declared human-readable name to show in UI, forcing derivation from `id` (e.g. title-casing "bundesliga"). Plugins now declare `name` directly. Not marked breaking: the plugin API contract is still pre-1.0 and in flux.
Hosts need to show a plugin's name in the user's locale. Adds an optional [names] table (locale -> display name) and Manifest::localized_name(locale), which falls back to the required name field when no entry matches. Not marked breaking: still pre-1.0.
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
1 participant
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
namefield toManifestfor a plugin's human-readable display name, distinct fromidid(e.g. title-casing it) — this closes that gapWhy
fulltime-ui's league selector needed a pretty display name per plugin. The stopgap of title-casing the pluginidwas rejected as incorrect; the name belongs in the manifest, declared by the plugin author.Not marked as a breaking change: the plugin API contract is still pre-1.0 and in flux, so this ships as a plain
feat:(minor bump). Breaking-change semantics are reserved for after the first 1.0 release.Test plan
cargo testpasses (14 unit tests, 3 integration tests, 7 doc-tests)cargo clippy --all-targets --all-features -- -D warningscleancargo +nightly fmt --all -- --checkclean