Add optional displayName field to plugin manifest#17
Open
aaronpowell wants to merge 1 commit into
Open
Conversation
Closes vercel-labs#16 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.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
Adds an optional
displayNamefield to the plugin manifest, giving plugins ahuman-readable label that is separate from the constrained machine identifier
name(§5.5: lowercasea-z0-9-., 1–64 chars, no leading/trailing hyphens orconsecutive separators).
Closes #16
Changes
displayNameto the JSON schema (schemas/1.0.0/plugin.schema.json).displayNamein the metadata field table (§5.4) and add a dedicatedsubsection (§5.7).
displayNamein the full example manifest (§5.5).nameis described as the plugin identifier (see §5.5constraints) rather than "human-readable", now that
displayNamefills thehuman-readable role.
Behavior
displayNameis optional; if present it MUST be a string.displayNamein user interfaces instead ofname.nameas the display name.Example
{ "$schema": "https://open-plugins.com/schemas/1.0.0/plugin.schema.json", "name": "plugin-name", "displayName": "Plugin Name", "version": "1.2.0" }