feat: add configuration migration function to handle backward compatibility for output style

Author: AndersonBY

src/repomix/config/config_load.py

@@ -13,6 +13,41 @@
 from .global_directory import get_global_directory
 
 
+def migrate_config_format(config_dict: Dict[str, Any]) -> Dict[str, Any]:
+    """Migrate old configuration format to new format
+
+    This function handles backward compatibility by:
+    - Converting '_style' to 'style' in output configuration
+    - Any other future migrations can be added here
+
+    Args:
+        config_dict: Configuration dictionary
+
+    Returns:
+        Migrated configuration dictionary
+    """
+    # Make a deep copy to avoid modifying the original
+    import copy
+
+    migrated_config = copy.deepcopy(config_dict)
+
+    # Handle output._style -> output.style migration
+    if "output" in migrated_config and isinstance(migrated_config["output"], dict):
+        output_config = migrated_config["output"]
+
+        # If we have _style but no style, migrate it
+        if "_style" in output_config and "style" not in output_config:
+            output_config["style"] = output_config["_style"]
+            del output_config["_style"]
+            logger.info("Migrated configuration: '_style' -> 'style'")
+        # If we have both, remove the old _style
+        elif "_style" in output_config and "style" in output_config:
+            del output_config["_style"]
+            logger.info("Removed deprecated '_style' parameter (using 'style' instead)")
+
+    return migrated_config
+
+
 def load_config(
     directory: str | Path,
     cwd: str | Path,
@@ -61,6 +96,19 @@ def load_global_config() -> Optional[RepomixConfig]:
 
     try:
         config_dict = json.loads(global_config_path.read_text(encoding="utf-8"))
+
+        # Migrate old configuration format
+        config_dict = migrate_config_format(config_dict)
+
+        # Try to update the global config file if migration was needed
+        try:
+            updated_content = json.dumps(config_dict, indent=2, ensure_ascii=False)
+            if updated_content != global_config_path.read_text(encoding="utf-8"):
+                global_config_path.write_text(updated_content, encoding="utf-8")
+                logger.info("Updated global configuration file to new format")
+        except Exception as e:
+            logger.warn(f"Failed to update global configuration file: {e}")
+
         return RepomixConfig(**config_dict)
     except Exception as error:
         logger.warn(f"Failed to load global configuration: {error}")
@@ -99,6 +147,10 @@ def load_local_config(directory: str | Path, cwd: str | Path, config_path: Optio
 
     try:
         config_dict = json.loads(config_path_obj.read_text(encoding="utf-8"))
+
+        # Migrate old configuration format
+        config_dict = migrate_config_format(config_dict)
+
         return RepomixConfig(**config_dict)
     except json.JSONDecodeError as error:
         raise RepomixError(f"Invalid configuration file format: {config_path_obj}") from error

tests/test_config.py

@@ -9,6 +9,7 @@
     RepomixConfigOutput,
     RepomixOutputStyle,
 )
+from src.repomix.config.config_load import migrate_config_format
 
 
 class TestRepomixConfigOutput:
@@ -281,7 +282,7 @@ def test_advanced_output_options_configuration(self):
                 "truncate_base64": True,
                 "include_empty_directories": True,
                 "include_diffs": True,
-                "style": "xml"
+                "style": "xml",
             }
         }
 
@@ -309,12 +310,13 @@ def test_advanced_output_options_json_serialization(self):
                 "truncate_base64": True,
                 "include_empty_directories": False,
                 "include_diffs": True,
-                "copy_to_clipboard": True
+                "copy_to_clipboard": True,
             }
         }
 
         # Convert to JSON and back to simulate config file loading
         import json
+
         json_str = json.dumps(original_config)
         loaded_dict = json.loads(json_str)
         config = RepomixConfig(**loaded_dict)
@@ -332,5 +334,79 @@ def test_advanced_output_options_json_serialization(self):
         assert config.output.copy_to_clipboard is True
 
 
+class TestConfigMigration:
+    """Test cases for configuration migration functionality"""
+
+    def test_style_migration_from_underscore_style(self):
+        """Test that _style is properly migrated to style"""
+        old_config = {
+            "output": {"file_path": "repomix-output.md", "_style": "markdown", "header_text": "", "remove_comments": False},
+            "security": {"enable_security_check": True},
+        }
+
+        migrated = migrate_config_format(old_config)
+
+        # Check that _style was converted to style
+        assert "_style" not in migrated["output"]
+        assert migrated["output"]["style"] == "markdown"
+
+        # Verify we can create RepomixConfig with migrated data
+        config_obj = RepomixConfig(**migrated)
+        assert config_obj.output.style == "markdown"
+        assert config_obj.output.style_enum == RepomixOutputStyle.MARKDOWN
+
+    def test_style_migration_with_both_style_and_underscore_style(self):
+        """Test that _style is removed when both _style and style are present"""
+        config_with_both = {"output": {"_style": "xml", "style": "markdown"}}
+
+        migrated = migrate_config_format(config_with_both)
+        assert "_style" not in migrated["output"]
+        assert migrated["output"]["style"] == "markdown"
+
+    def test_migration_preserves_new_format(self):
+        """Test that new config format without _style is unchanged"""
+        new_config = {"output": {"style": "xml", "file_path": "output.xml"}}
+
+        migrated = migrate_config_format(new_config)
+        assert migrated["output"]["style"] == "xml"
+        assert "_style" not in migrated["output"]
+
+    def test_migration_with_real_user_config(self):
+        """Test with the actual problematic config from user"""
+        user_config = {
+            "output": {
+                "file_path": "repomix-output.md",
+                "_style": "markdown",
+                "header_text": "",
+                "instruction_file_path": "",
+                "remove_comments": False,
+                "remove_empty_lines": False,
+                "top_files_length": 5,
+                "show_line_numbers": False,
+                "copy_to_clipboard": False,
+                "include_empty_directories": False,
+                "calculate_tokens": False,
+                "show_file_stats": False,
+                "show_directory_structure": True,
+            },
+            "security": {"enable_security_check": True, "exclude_suspicious_files": True},
+            "ignore": {"custom_patterns": [], "use_gitignore": True, "use_default_ignore": True},
+            "include": [],
+        }
+
+        migrated = migrate_config_format(user_config)
+
+        # Verify migration
+        assert "_style" not in migrated["output"]
+        assert migrated["output"]["style"] == "markdown"
+
+        # Test that we can create RepomixConfig with migrated data
+        config_obj = RepomixConfig(**migrated)
+        assert config_obj.output.style == "markdown"
+        assert config_obj.output.style_enum == RepomixOutputStyle.MARKDOWN
+        assert config_obj.output.top_files_length == 5
+        assert config_obj.security.enable_security_check is True
+
+
 if __name__ == "__main__":
     pytest.main([__file__])