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

Consider changing config code to use figment #3331

Closed
stevenengler opened this issue May 14, 2024 · 1 comment
Closed

Consider changing config code to use figment #3331

stevenengler opened this issue May 14, 2024 · 1 comment
Labels
Priority: Low Prioritized below most other issues Status: Help Wanted Well suited for community contributions Type: Maintenance Refactoring, cleanup, documenation, or process improvements

Comments

@stevenengler
Copy link
Contributor

Shadow's configuration code currently uses clap to read cli options and serde_yaml to read yaml files. Then we do some merging to combine the two. But this makes the configuration code a bit awkward.

The figment library claims to handle this, so it might be nice to try it to simplify our configuration code. It's not immediately clear if it would support everything required by Shadow (for example including the default values in the clap help text like we do with generate_help_strs).

@stevenengler stevenengler added Priority: Low Prioritized below most other issues Type: Maintenance Refactoring, cleanup, documenation, or process improvements Status: Help Wanted Well suited for community contributions labels May 14, 2024
@stevenengler
Copy link
Contributor Author

Closing since the current version works fine, it's not obvious if it will be an improvement, and I doubt anyone would volunteer to work on this issue, so it's probably best to have one fewer forever-issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Priority: Low Prioritized below most other issues Status: Help Wanted Well suited for community contributions Type: Maintenance Refactoring, cleanup, documenation, or process improvements
Projects
None yet
Development

No branches or pull requests

1 participant