Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: More plugin metadata options #25

Open
cswimr opened this issue Oct 18, 2024 · 2 comments
Open

feat: More plugin metadata options #25

cswimr opened this issue Oct 18, 2024 · 2 comments
Labels
type: feature Issue or PR related to new feature

Comments

@cswimr
Copy link

cswimr commented Oct 18, 2024

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.
@Exidex Exidex added the type: feature Issue or PR related to new feature label Oct 18, 2024
@cswimr
Copy link
Author

cswimr commented Oct 19, 2024

Didn't consider this when writing this issue yesterday, but a version number would also be nice!

@BennoCrafter
Copy link

@Exidex I'd like working on this. Can I do so? Cuz I'm working on a small website, and would be ideal.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: feature Issue or PR related to new feature
Projects
None yet
Development

No branches or pull requests

3 participants