feat: comprehensive auto-rename system for all file/folder references #903
+2,259
−0
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
Extends the auto-rename feature to cover all file and folder references throughout QuickAdd, not just basic folder paths in choices.
## New Features
### Extended Auto-Rename Coverage
- Template file paths (templatePath in Template choices)
- Template files for capture creation (createFileIfItDoesntExist.template)
- User script paths in macro commands (IUserScript.path)
- Open file command paths (IOpenFileCommand.filePath)
- Format string embedded references ({{TEMPLATE:path}} and {{FIELD:|folder:path}})
### File Rename Support
- Added support for file renames in addition to folder renames
- Smart detection using file extensions and Obsidian file types
- Separate handling logic for file vs folder renames
### Format String Processing
- New FormatStringPathParser for parsing embedded path references
- Handles {{TEMPLATE:path}} syntax for template references
- Handles {{FIELD:name|folder:path}} syntax for field folder filters
- Preserves filter order and non-path filters during updates
## Technical Implementation
### Core Components
- **FolderPathUpdater**: Extended to handle all choice types and format strings
- **FormatStringPathParser**: New utility for parsing/updating format syntax
- **PathRenameHandler**: Replaces FolderRenameHandler with broader scope
- **Enhanced Settings**: Added granular controls for different rename types
### Updated Choice Handling
- **Capture**: captureTo, template fields, format strings
- **Template**: templatePath, folder.folders, fileNameFormat strings
- **Macro**: user script paths, open file commands
- **Multi**: recursive processing of nested choices
### New Settings
- autoRenameTemplateFiles: Enable/disable template file auto-rename
- autoRenameUserScripts: Enable/disable user script auto-rename
- autoRenameFormatReferences: Enable/disable format string updates
- (autoRenameDestinationFolders: existing folder setting)
## Testing
- Comprehensive test suite for FormatStringPathParser (14 tests)
- Extended FolderPathUpdater tests (10 tests)
- All existing tests pass (446 total)
- Covers edge cases, format preservation, and error handling
## Backward Compatibility
- Maintains all existing functionality
- Existing settings continue to work
- New features default to enabled for seamless experience
- No breaking changes to existing API
Addresses issue #769 with comprehensive solution covering all file/folder references in QuickAdd.
- Extended PathRenameHandler to support global settings auto-rename - Added monitoring for templateFolderPath and ai.promptTemplatesFolderPath - Enhanced notification system to include global settings updates - Replaced basic auto-rename UI with comprehensive organized section - Added granular controls for all auto-rename features: - Destination folders, template files, user scripts - Format references, global settings, notifications - Implemented hierarchical settings with smart visibility management - Maintained backward compatibility and proper styling Addresses #769 with comprehensive auto-rename coverage
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
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.
Summary
Implements a comprehensive auto-rename system that automatically updates all file and folder references in QuickAdd when they are renamed in the vault. This addresses issue #769 and extends well beyond the original request to provide complete coverage.
What Changed
🎯 Core Auto-Rename System
vault.on('rename')events for real-time updatesstructuredClone()for error recovery{{TEMPLATE:path}}and{{FIELD:|folder:path}}syntax🔧 Technical Implementation
FolderPathUpdater,FormatStringPathParserfor modular path updatingPathRenameHandlerwith comprehensive file/folder detection and global settings support⚙️ Comprehensive Settings UI
📋 Coverage Details
{{TEMPLATE:path}},{{FIELD:|folder:path}})templateFolderPath,ai.promptTemplatesFolderPath)Testing
Benefits
Closes #769