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

Refactor the config file to make it more intuitive and structured #344

Closed
soywod opened this issue Mar 14, 2022 · 1 comment
Closed

Refactor the config file to make it more intuitive and structured #344

soywod opened this issue Mar 14, 2022 · 1 comment
Assignees
Labels
enhancement New feature or request

Comments

@soywod
Copy link
Member

soywod commented Mar 14, 2022

The first big problem is the untagged enum used for backends (#295 (comment)). This leads to unprecise and hard-to-debug errors like #333. By using an adjacently-tagged enum we avoid the parser to "guess" the right config variant and get better error messages, but we break the config API.

The second problem is that options have been added on the fly since the beginning, and most of them are misplaced. We need to make the API more consistent by grouping options by context. Also some namings are not the best. default_page_size is a good (bad?) example: default_ is not need since it is implied by the config itself, and we miss the context (listing).

@soywod soywod added enhancement New feature or request cli labels Mar 14, 2022
@soywod soywod changed the title Refactor the config file to make it more intuitive and structured. Refactor the config file to make it more intuitive and structured Mar 14, 2022
@soywod soywod self-assigned this May 28, 2022
@soywod
Copy link
Member Author

soywod commented Oct 10, 2022

Released in the v0.6.0 🎉 please read the changelog because this feature brings breaking changes!

@soywod soywod closed this as completed Oct 10, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant