Skip to content

feat: More plugin metadata options #25

@cswimr

Description

@cswimr

I think it'd be beneficial to add some more metadata for plugins rather than just name and description, so plugin authors can provide useful information like issue reporting links, repository links, and just... being able to credit themselves without having their name in the plugin name or description. Metadata provided in a top-level [gauntlet] definition that isn't defined in children [[entrypoint]] definitions should be inherited from the parent.

Proposals:

Note: None of these should be required/mandatory, just optional metadata.

  • Authors field
    • Should be an array of either objects or strings
      • example: authors = [{"name":"cswimr", "url": "https://github.com/cswimr"}]
      • example: authors = ["cswimr"]
    • If strings are used instead of objects, urls will not be rendered
    • Renders in the settings UI as Author: [name](url) (assuming markdown formatting), or Authors: [name](url), [name](url)
    • This specifically should be usable in entrypoints as well.
  • Repository field
    • Simple string/url that points to the git repository
    • Renders in the settings UI as Repository: url
  • Issues field
    • Same as repository, just points to the plugin's issue tracking, whether that's on the repository or elsewhere.
    • Renders in the settings UI as Issues: url, or alternatively, as a "report issue" button if present
  • Description field
    • Yes, this already exists, but I'd like to be able to use markdown formatting inside of descriptions. This might warrant its own issue, I'm not sure.
    • Descriptions supporting markdown, if implemented, should also be usable in entrypoints.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions