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

Map method names to configuration keys automatically (deprecate @ConfKey?) #38

Open
A248 opened this issue Aug 29, 2023 · 0 comments
Open
Labels
enhancement New feature or request feedback wanted Feedback especially wanted on this issue
Milestone

Comments

@A248
Copy link
Owner

A248 commented Aug 29, 2023

Using @ConfKey to enforce configuration key conventions is brittle and error-prone. I might want to use this-kind-of-format with YAML, and thus use @ConfKey("my-key") on a method name such as "myKey". However, it can be easy to forget this for a single key, which creates a longlasting ugly-looking spot in the configuration.

An interface should be provided to automatically map method names to configuration keys, therefore.

In the same vein of reasoning, we may want to deprecate @ConfKey entirely. I don't see a reason to keep the annotation. Removing it would make reasoning about a config easier for someone who wants to look at their plugin's source code.

@A248 A248 added this to the 2.0.0 milestone Aug 29, 2023
@A248 A248 added enhancement New feature or request feedback wanted Feedback especially wanted on this issue labels Aug 29, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request feedback wanted Feedback especially wanted on this issue
Projects
None yet
Development

No branches or pull requests

1 participant