Add Open in Editor support for template paths

Author: federicobond

debug_toolbar/panels/templates/panel.py

@@ -16,6 +16,7 @@
 from debug_toolbar.panels import Panel
 from debug_toolbar.panels.sql.tracking import SQLQueryTriggered, allow_sql
 from debug_toolbar.panels.templates import views
+from debug_toolbar.utils import get_editor_url
 
 if find_spec("jinja2"):
     from debug_toolbar.panels.templates.jinja2 import patch_jinja_render
@@ -195,13 +196,15 @@ 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 = get_editor_url(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": "vscode",
     "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>

debug_toolbar/utils.py

@@ -401,3 +401,28 @@ def is_processable_html_response(response):
         and content_encoding == ""
         and content_type in _HTML_TYPES
     )
+
+
+def get_editor_url(file: str, line: int = 1) -> str | None:
+    formats = {
+        "cursor": "cursor://file/{file}:{line}",
+        "emacs": "emacs://open?url=file://{file}&line={line}",
+        "espresso": "x-espresso://open?filepath={file}&lines={line}",
+        "idea": "idea://open?file={file}&line={line}",
+        "idea-remote": "javascript:(()=>{let r=new XMLHttpRequest; r.open('get','http://localhost:63342/api/file/?file={file}&line={line}');r.send();})()",
+        "macvim": "mvim://open/?url=file://{file}&line={line}",
+        "nova": "nova://open?path={file}&line={line}",
+        "pycharm": "pycharm://open?file={file}&line={line}",
+        "pycharm-remote": "javascript:(()=>{let r=new XMLHttpRequest; r.open('get','http://localhost:63342/api/file/{file}:{line}');r.send();})()",
+        "sublime": "subl://open?url=file://{file}&line={line}",
+        "vscode": "vscode://file/{file}:{line}",
+        "vscode-insiders": "vscode-insiders://file/{file}:{line}",
+        "vscode-remote": "vscode://vscode-remote/{file}:{line}",
+        "vscode-insiders-remote": "vscode-insiders://vscode-remote/{file}:{line}",
+        "vscodium": "vscodium://file/{file}:{line}",
+        "windsurf": "windsurf://file/{file}:{line}",
+    }
+    template = formats.get(dt_settings.get_config()["EDITOR"])
+    if template is None:
+        return None
+    return template.format(file=file, line=line)

docs/configuration.rst

@@ -67,6 +67,16 @@ 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``
+
+  Default: ``'vscode'``
+
+  The editor to use to open file paths from the toolbar.
+
+  Available editors: ``'vscode'``, ``'cursor'``, ``'emacs'``, ``'idea'``,
+  ``'pycharm'``, ``'sublime'``, ``'vscode-insiders'``, ``'vscode-remote'``,
+  ``'vscodium'``, ``'windsurf'``
+
 * ``INSERT_BEFORE``
 
   Default: ``'</body>'``

example/settings.py

@@ -118,4 +118,6 @@
         "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",
+    }