Add script to upgrade component syntax.

django_components/management/commands/upgradecomponent.py

@@ -0,0 +1,66 @@
+import os
+import re
+
+from pathlib import Path
+
+from django.conf import settings
+from django.core.management.base import BaseCommand
+from django.template.engine import Engine
+
+from django_components.template_loader import Loader
+
+
+class Command(BaseCommand):
+    help = "Updates component and component_block tags to the new syntax"
+
+    def add_arguments(self, parser):
+        parser.add_argument("--path", type=str, help="Path to search for components")
+
+    def handle(self, *args, **options):
+        current_engine = Engine.get_default()
+        loader = Loader(current_engine)
+        dirs = loader.get_dirs()
+
+        if settings.BASE_DIR:
+            dirs.append(Path(settings.BASE_DIR) / "templates")
+
+        if options["path"]:
+            dirs = [options["path"]]
+
+        for dir_path in dirs:
+            self.stdout.write(f"Searching for components in {dir_path}...")
+            for root, _, files in os.walk(dir_path):
+                for file in files:
+                    if file.endswith((".html", ".py")):
+                        file_path = os.path.join(root, file)
+                    with open(file_path, "r+", encoding="utf-8") as f:
+                        content = f.read()
+                        content_with_closed_components, step0_count = re.subn(
+                            r'({%\s*component\s*"(\w+?)"(.*?)%})(?!.*?{%\s*endcomponent\s*%})',
+                            r"\1{% endcomponent %}",
+                            content,
+                            flags=re.DOTALL,
+                        )
+                        updated_content, step1_count_opening = re.subn(
+                            r'{%\s*component_block\s*"(\w+?)"\s*(.*?)%}',
+                            r'{% component "\1" \2%}',
+                            content_with_closed_components,
+                            flags=re.DOTALL,
+                        )
+                        updated_content, step2_count_closing = re.subn(
+                            r'{%\s*endcomponent_block\s*"(\w+?)"\s*%}',
+                            r"{% endcomponent %}",
+                            updated_content,
+                            flags=re.DOTALL,
+                        )
+                        updated_content, step2_count_closing_no_name = re.subn(
+                            r"{%\s*endcomponent_block\s*%}", r"{% endcomponent %}", updated_content, flags=re.DOTALL
+                        )
+                        total_updates = (
+                            step0_count + step1_count_opening + step2_count_closing + step2_count_closing_no_name
+                        )
+                        if total_updates > 0:
+                            f.seek(0)
+                            f.write(updated_content)
+                            f.truncate()
+                            self.stdout.write(f"Updated {file_path}: {total_updates} changes made")