Skip to content
This repository has been archived by the owner on Jan 19, 2023. It is now read-only.

Plugin configuration #654

Open
johnharris85 opened this issue Feb 10, 2020 · 1 comment
Open

Plugin configuration #654

johnharris85 opened this issue Feb 10, 2020 · 1 comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request plugin

Comments

@johnharris85
Copy link

Describe the problem/challenge you have
As a plugin developer, I may need to read some local (or remote?) configuration to setup my plugin (credentials, endpoints, etc...). Right now I would make some code to deal with getting this from disk, parsing it, etc... Not a huge amount of overhead, but applicable to a lot of future plugin developers probably.

Describe the solution you'd like
Some 'standard' way of Octant enabling plugins to read configuration which is then exposed to the plugin via an 'options' struct / function etc... It would deal with parsing from a set location (maybe ~/.config/octant/plugins/plugin-name.{json,toml,yaml}), dealing with missing fields or whatever, and then exposing this in a friendly API to the developer for use.

@GuessWhoSamFoo GuessWhoSamFoo added enhancement New feature or request plugin labels Feb 10, 2020
@wwitzel3 wwitzel3 added the documentation Improvements or additions to documentation label Feb 11, 2020
@wwitzel3
Copy link
Contributor

This potentially related to #557

I like the idea, but at the moment, I just don't think there is enough information to make an informed decision about how this would be implemented.

Implementing something like this is essentially creating another external API surface for us to maintain and version. The likelihood that plugins will want to store and load and use this data in radically different ways seems pretty high.

I think this maybe a great case for establishing a convention in the documentation around plugins, providing some clear examples, and letting plugin authors implement this in a way that best works for them.

@wwitzel3 wwitzel3 added this to Incoming in Documentation Dec 15, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation enhancement New feature or request plugin
Projects
Development

No branches or pull requests

3 participants