feat: enhance recursive translations with shortcuts and dot notation #110
Conversation
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
- Add load_translation_folder() function to support translations/ folder structure
- Modify extension loading to check for both translations.yml and translations/ folder
- Maintain backward compatibility with existing translations.yml files
- Support recursive folder structure with dot-notation keys for strings
- Add comprehensive documentation for the new feature
Features:
- Recursive processing of .yml/.yaml files in translations/ folder
- Automatic separation of commands and strings based on folder structure
- Dot-notation keys for nested string organization (e.g., strings.general.welcome)
- Priority given to translations.yml for backward compatibility
- Support for both .yml and .yaml file extensions
This allows extensions to organize translations in a more structured way:
translations/
├── commands/
│ ├── command1.yaml
│ └── command2.yaml
└── strings/
└── messages.yaml
- Add folder name shortcuts: c. → commands., t. → translations., s. → strings. - Support dots in folder names for nested key structures - Update readme.md with comprehensive folder structure documentation - Remove separate RECURSIVE_TRANSLATIONS.md file as requested - Fix command structure loading for folder-based translations - Maintain backward compatibility with existing translation files Resolves #67
There was a problem hiding this comment.
Pull Request Overview
This PR implements enhanced translation loading by introducing support for both a single file and a folder structure with shortcut expansion and dot notation for nested translation keys. Key changes include:
- Updating src/start.py to check and load translations from either a file or folder
- Adding helper functions (_expand_folder_name, _load_recursive_translations, load_translation_folder) in src/i18n/utils.py to process folder-based translations
- Updating module exports in src/i18n/init.py and enhancing documentation in readme.md
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| src/start.py | Added logic to check for both translations files and folders with detailed logging |
| src/i18n/utils.py | Introduced helper functions to expand folder names and recursively load translations |
| src/i18n/init.py | Updated exports to include the new load_translation_folder function |
| readme.md | Updated documentation with usage examples for the new folder structure format |
| break | ||
|
|
||
| # Convert dots to path separators for nested structure | ||
| return folder_name.replace('.', '.') |
There was a problem hiding this comment.
The _expand_folder_name function's replacement operation currently has no effect, as it replaces '.' with '.'. If the intent is to convert dots to a different separator for nested keys, please update the replacement accordingly (e.g., using a different character or string).
Suggested change
| return folder_name.replace('.', '.') | |
| return folder_name.replace('.', '/') |
Copilot uses AI. Check for mistakes.
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.
Implements issue #67 with enhanced folder structure support:
Maintains full backward compatibility with existing translation files.
Fixes #67