Add Open in Editor support for template paths

Author: federicobond

debug_toolbar/panels/templates/panel.py

@@ -195,13 +195,17 @@ def generate_stats(self, request, response):
             if hasattr(template, "origin") and template.origin and template.origin.name:
                 template.origin_name = template.origin.name
                 template.origin_hash = signing.dumps(template.origin.name)
+                template.editor_url = self.toolbar.config["EDITOR_URL_CALLBACK"](
+                    template.origin.name
+                )
             else:
                 template.origin_name = _("No origin")
                 template.origin_hash = ""
             info["template"] = {
                 "name": template.name,
                 "origin_name": template.origin_name,
                 "origin_hash": template.origin_hash,
+                "editor_url": getattr(template, "editor_url", None),
             }
             # Clean up context for better readability
             if self.toolbar.config["SHOW_TEMPLATE_CONTEXT"]:

debug_toolbar/settings.py

@@ -22,6 +22,7 @@ def _is_running_tests():
         "debug_toolbar.panels.profiling.ProfilingPanel",
         "debug_toolbar.panels.redirects.RedirectsPanel",
     },
+    "EDITOR_URL_CALLBACK": lambda f: None,
     "INSERT_BEFORE": "</body>",
     "RENDER_PANELS": None,
     "RESULTS_CACHE_SIZE": 25,

debug_toolbar/templates/debug_toolbar/panels/templates.html

@@ -15,7 +15,15 @@ <h4>{% blocktranslate count template_count=templates|length %}Template{% plural
   <dl>
     {% for template in templates %}
       <dt><strong><a class="remoteCall toggleTemplate" href="{% url 'djdt:template_source' %}?template={{ template.template.name }}&amp;template_origin={{ template.template.origin_hash }}">{{ template.template.name|addslashes }}</a></strong></dt>
-      <dd><samp>{{ template.template.origin_name|addslashes }}</samp></dd>
+      <dd>
+        <samp>
+        {% if template.template.editor_url %}
+          <a href="{{ template.template.editor_url }}" title="{% translate "Open in editor" %}">{{ template.template.origin_name|addslashes }}</a>
+        {% else %}
+          {{ template.template.origin_name|addslashes }}
+        {% endif %}
+        </samp>
+      </dd>
       {% if template.context %}
         <dd>
           <details>

docs/configuration.rst

@@ -67,6 +67,14 @@ Toolbar options
   This setting is a set of the full Python paths to each panel that you
   want disabled (but still displayed) by default.
 
+* ``EDITOR_URL_CALLBACK``
+
+  Default: ``lambda f: None``
+
+  This function is passed a file path and should return a URL to open the file in the editor.
+
+  For example, to open the file in VS Code, you can use: ``lambda f: f"vscode://file/{f}"``
+
 * ``INSERT_BEFORE``
 
   Default: ``'</body>'``

example/settings.py

@@ -118,4 +118,7 @@
         "debug_toolbar.middleware.DebugToolbarMiddleware",
     ]
     # Customize the config to support turbo and htmx boosting.
-    DEBUG_TOOLBAR_CONFIG = {"ROOT_TAG_EXTRA_ATTRS": "data-turbo-permanent hx-preserve"}
+    DEBUG_TOOLBAR_CONFIG = {
+        "ROOT_TAG_EXTRA_ATTRS": "data-turbo-permanent hx-preserve",
+        "EDITOR_URL_CALLBACK": lambda f: f"vscode://file/{f}",
+    }