Introduce TOML configuration support and deprecate JSON config (#68)#303
Open
Guria wants to merge 1 commit intomikker:mainfrom
Open
Introduce TOML configuration support and deprecate JSON config (#68)#303Guria wants to merge 1 commit intomikker:mainfrom
Guria wants to merge 1 commit intomikker:mainfrom
Conversation
…r#68) - Added support for TOML configuration format alongside JSON. - Created a new `ConfigFormat` enum to manage file extensions and names. - Implemented encoding and decoding methods for TOML in `UserConfig`. - Updated file handling to prefer TOML format and added detection logic. - Refactored existing JSON handling to accommodate the new format. - Added conversion method to convert existing JSON configs to TOML. - Introduced comprehensive unit tests for TOML parsing and serialization. - Updated README and sample configuration file to reflect new TOML format.
There was a problem hiding this comment.
Pull request overview
This pull request introduces TOML configuration format support to Leader Key while maintaining backward compatibility with the existing JSON format. The TOML format is now preferred for new installations, with JSON being deprecated but still supported for existing users.
Changes:
- Added TOML parsing and serialization using the TOMLKit library
- Implemented automatic format detection that prefers TOML over JSON
- Created a conversion tool to migrate JSON configs to TOML with automatic backup
- Updated documentation and sample configuration to reflect the new format
Reviewed changes
Copilot reviewed 12 out of 12 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| config.sample.toml | New sample configuration file demonstrating TOML syntax |
| README.md | Updated documentation to reference TOML format and config path |
| AGENTS.md | Updated coding agent guidance to reflect TOML-first approach |
| Leader Key/TOMLConfig.swift | New file implementing TOML parsing and serialization logic |
| Leader Key/UserConfig.swift | Added ConfigFormat enum, TOML support, and conversion functionality |
| Leader Key/Settings/AdvancedPane.swift | Added UI for JSON-to-TOML conversion in settings |
| Leader KeyTests/TOMLConfigTests.swift | Comprehensive test suite for TOML parsing and serialization |
| Leader KeyTests/UserConfigTests.swift | Updated tests to use TOML format |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| @@ -0,0 +1,40 @@ | |||
| # Leader Key Configuration (sample) | |||
There was a problem hiding this comment.
The comment says '(sample)' but this appears to be an actual sample file. Consider changing to 'Leader Key Configuration Sample' for clarity.
Suggested change
| # Leader Key Configuration (sample) | |
| # Leader Key Configuration Sample |
| - `AppDelegate`: Application lifecycle, global shortcuts registration, update management | ||
| - `Controller`: Central event handling, manages key sequences and window display | ||
| - `UserConfig`: JSON configuration management with validation | ||
| - `UserConfig`: TOML-first (JSON legacy) configuration management with validation |
There was a problem hiding this comment.
The description uses parentheses for 'JSON legacy' which could be clearer. Consider revising to 'Configuration management with TOML format (JSON deprecated) and validation' for better clarity.
Suggested change
| - `UserConfig`: TOML-first (JSON legacy) configuration management with validation | |
| - `UserConfig`: Configuration management with TOML format (JSON deprecated) and validation |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
ConfigFormatenum to manage file extensions and names.UserConfig.Prepared in collaboration with Claude and Codex
Sample from wiki converted reduced 328 to 73 LOC:
@miiraheart's config
closes #68