feat: add configuration file support #70
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
No attributes yet though
- Updated test assertions to reflect the changes in active_item_style
- Added `env_logger` for enhanced logging capabilities. - Integrated `shellexpand` to handle tilde expansion in config paths. - Updated `ConfigContentStyle` to use simplified field names. - Ensured unknown fields in config files are denied. - Modified tests to reflect changes in `ConfigContentStyle`.
lanej
commented
Jan 9, 2025
Added support for custom key events and focus prefixes in the configuration. This includes new fields in the Config and ConfigFile structs, as well as updates to the merge function and related tests. The changes enhance the flexibility and customizability of the editor.
|
I'd like to get a general temperature check on pursuing this path @ynqa |
Added spin_duration field to Config and ConfigFile structs. Updated merge function to handle spin_duration. Set default spin_duration to 300ms. Removed redundant spin_duration initialization in main.
Added new style options to Config and ConfigFile structs, including prefix_style, active_char_style, inactive_char_style, curly_brackets_style, square_brackets_style, key_style, string_value_style, number_value_style, boolean_value_style, and null_value_style. Updated merge function and default implementation to handle these new styles.
Removed unused dependencies `env_logger`, `log`, and `humantime` from Cargo.toml and Cargo.lock. Cleaned up related imports and initialization code in main.rs.
ynqa
reviewed
Jan 25, 2025
| long = "write-default-config", | ||
| help = "Writes the default configuration to the specified file and exits." | ||
| )] | ||
| pub write_default_config: bool, |
There was a problem hiding this comment.
I want to create the config file at the time of the first execution.
ynqa
reviewed
Jan 25, 2025
src/main.rs
Outdated
| long_help = " | ||
| Specifies the path to the configuration file. | ||
| ", | ||
| default_value = "~/.config/jnv/config.toml", |
There was a problem hiding this comment.
How about using directories-rs for default? I want to manage the optimal directory for each platform.
|
@lanej Thank you for your contribution. I’m sorry for the delayed review, and I’ve left a few comments. |
ynqa
reviewed
Jan 25, 2025
| default_value = "~/.config/jnv/config.toml", | ||
| value_parser = |x: &str| Ok::<String, std::convert::Infallible>(shellexpand::tilde(x).into_owned()), | ||
| )] | ||
| pub config_file: String, |
There was a problem hiding this comment.
I’d like to place an example of the actual configuration file somewhere (in examples/?).
- Bump versions for various dependencies in Cargo.lock - Add `dirs` crate to Cargo.toml - Remove `shellexpand` crate from Cargo.toml
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Introduces a configuration file support for the project, following the XDG Base Directory Specification. The configuration file allows users to customize various settings, including keybindings and color schemes. This update enhances the flexibility and user experience of the application by allowing greater customization
according to individual preferences.
Key Features 🔑
~/.config/jnv/config.toml. This allows users to define custom configurations outside of the codebase.Changes Summary 📋
• Added a new module
config.rsto handle loading and parsing of the configuration file.• Refactored the
main.rsto incorporate configuration loading logic and adjusted the initialization of various components to use the loaded configurations.• Expanded
editor.rsto utilize keybindings from the configuration file.• Adjusted
prompt.rsto align with the changes in the configuration handling structure.• Added default configuration logic to ensure application functionality in the absence of a custom configuration file.
References 📖
Closes #23 by implementing a system for customizable configurations as discussed.
Thoughts 🧠
JQ_COLORSenvironment variable for color customization if not specified in the configuration file.TODO 🗒️
~/.configdirectoryexamples/and some sample configurations.