Code finder

Author: boxed

iommi/apps.py

@@ -1,5 +1,6 @@
 from django.apps import AppConfig
 
+from iommi.code_finder import setup_code_finder
 from iommi.from_model import register_search_fields
 from iommi.style_bootstrap_docs import bootstrap_docs
 
@@ -56,3 +57,5 @@ def ready(self):
 
         register_factory(GenericRelation, factory=None)
         register_factory(GenericForeignKey, factory=None)
+
+        setup_code_finder()

iommi/code_finder.py

@@ -0,0 +1,35 @@
+from pathlib import Path
+
+from django.conf import settings
+from django.template.loader_tags import IncludeNode
+
+from iommi._web_compat import format_html
+from iommi.debug import src_debug_url_builder
+
+
+def setup_code_finder():
+    if not settings.DEBUG:
+        return
+
+    # IncludeNode monkey patch - output link to template location before each included template
+    orig_include_render = IncludeNode.render
+
+    def include_render(self, context):
+        # Get the file path and line number from the node's origin and token
+        link_html = ''
+        if hasattr(self, 'origin') and self.origin:
+            filename = self.origin.name
+            # Token has a lineno attribute that gives us the line number
+            line_number = self.token.lineno if hasattr(self, 'token') and hasattr(self.token, 'lineno') else 1
+
+            # Create a PyCharm link
+            link_html = format_html(
+                '<!-- ## iommi-code-finder-URL ## {} ## {} -->',
+                f'{Path(filename).name}:{line_number}',
+                src_debug_url_builder(filename, line_number)
+            )
+
+        result = link_html + orig_include_render(self, context)
+        return result
+
+    IncludeNode.render = include_render

iommi/menu.py

@@ -307,6 +307,11 @@ class DebugMenu(Menu):
             attrs__onclick='window.iommi_start_pick()',
             tag='li',
         )
+        code_finder = MenuItem(
+            url='#',
+            attrs__onclick='window.insert_iommi_code_finder_links()',
+            tag='li',
+        )
         edit = MenuItem(
             display_name=lambda request, **_: (
                 'Edit vertical'

iommi/static/js/iommi.js

@@ -611,3 +611,93 @@ document.addEventListener('readystatechange', () => {
         window.iommi.select2.onCompleteReadyState();
     }
 });
+
+
+function insert_iommi_code_finder_links() {
+    remove_iommi_code_finder_links();
+
+    // Find all matching comments
+    const walker = document.createTreeWalker(
+        document.documentElement,
+        NodeFilter.SHOW_COMMENT,
+        {
+            acceptNode: function (node) {
+                return node.textContent.includes('## iommi-code-finder-URL ##')
+                    ? NodeFilter.FILTER_ACCEPT
+                    : NodeFilter.FILTER_SKIP;
+            }
+        },
+        false
+    );
+
+    const comments = [];
+    let comment;
+    while (comment = walker.nextNode()) {
+        comments.push(comment);
+    }
+
+    // Process each comment
+    comments.forEach(comment => {
+        // Extract content between the markers
+        // Format: "## iommi-code-finder-URL ## short name ## https://example.com/path"
+        const match = comment.textContent.match(/## iommi-code-finder-URL ##\s*(.+?)\s*##\s*(.+?)$/);
+        if (!match || !match[1] || !match[2]) return;
+
+        const shortName = match[1].trim();
+        const url = match[2].trim();
+
+        // Find the next element node after the comment
+        let nextNode = comment.nextSibling;
+        while (nextNode && nextNode.nodeType !== 1) {
+            nextNode = nextNode.nextSibling;
+        }
+
+        if (!nextNode) {
+            // No next sibling, try parent's next sibling
+            nextNode = comment.parentNode;
+            while (nextNode && !nextNode.nextElementSibling && nextNode.parentNode) {
+                nextNode = nextNode.parentNode;
+            }
+            if (nextNode && nextNode.nextElementSibling) {
+                nextNode = nextNode.nextElementSibling;
+            }
+        }
+
+        if (!nextNode || nextNode.nodeType !== 1) return;
+
+        // Create the link element
+        const link = document.createElement('a');
+        link.href = url;
+        link.textContent = shortName;  // Use short name as link text
+        link.title = url;  // Show full URL on hover
+        link.target = '_blank';
+        link.style.cssText = `
+      position: absolute;
+      background: #ffeb3b;
+      padding: 4px 8px;
+      border: 1px solid #f57c00;
+      border-radius: 3px;
+      font-family: monospace;
+      font-size: 12px;
+      z-index: 10000;
+      box-shadow: 0 2px 4px rgba(0,0,0,0.2);
+      color: #333;
+      text-decoration: none;
+    `;
+
+        // Position the link at the next element's position
+        document.body.appendChild(link);
+
+        // Get position of the next element
+        const rect = nextNode.getBoundingClientRect();
+        link.style.left = rect.left + window.scrollX + 'px';
+        link.style.top = rect.top + window.scrollY + 'px';
+        link.className = 'iommi-code-finder-URL-link';
+    });
+}
+
+function remove_iommi_code_finder_links() {
+    document.querySelectorAll('.iommi-code-finder-URL-link').forEach(link => {
+        link.remove();
+    });
+}