Merge pull request #300 from shopware/twig-native-navigation

Replace Symfony plugin sw_extends/sw_include integration with own navigation

Author: shyim

CHANGELOG.md

@@ -4,6 +4,10 @@
 
 ## Unreleased
 
+- Replaced the Symfony plugin integration for `sw_extends` / `sw_include` with own navigation and autocompletion: navigating a template reference now offers all templates of that view path (the referenced bundle first, then all plugin overrides), and completion suggests templates of every bundle including plugins in `custom/plugins`
+- Added navigation from a Twig block name to the upstream block it overrides (nearest parent first, following the `sw_extends` chain)
+- Templates are indexed by their view path and `sw_extends` target, so template resolution, chain walking and completion no longer scan files
+
 - Twig block versioning comments now also work for templates of third-party extensions, both installed via Composer and in `custom/plugins` (block changed / removed / comment missing inspections). The versioning comment records the version of the extension the block belongs to (from the Composer package or the extension's composer.json). Showing a diff of the upstream changes is only supported for Shopware core templates.
 - The "versioning comment missing" inspection only reports files that extend another template via `sw_extends`
 - The upstream of a block is now resolved through the `sw_extends` chain of the template, so versioning also works when extending a template at a different relative path and sibling overrides of other plugins cannot be mistaken for the upstream

doc/twig-versioning.md

@@ -38,6 +38,8 @@ Versioning works for blocks of the Shopware core **and any other extension** —
 
 Once an override is reviewed, re-run the *"Add/Update"* intention (or the quick fix) to record the new hash, which clears the warning.
 
+To compare an override with its origin, **Ctrl+Click (Go to Declaration) on a block name** navigates to the upstream block it overrides — nearest parent in the `sw_extends` chain first. Template references in `sw_extends` / `sw_include` navigate to all templates of that view path: the referenced bundle first, followed by every plugin override.
+
 ## How the upstream of a block is resolved
 
 All blocks of all templates under `Resources/views/` are indexed with their content hash. For a block in your file, the upstream candidates are determined in two steps:

src/main/kotlin/de/shyim/shopware6/completion/TwigCompletionProvider.kt

@@ -77,6 +77,24 @@ class TwigCompletionProvider : CompletionContributor() {
             }
         )
 
+        extend(
+            CompletionType.BASIC,
+            TwigPattern.getShopwareIncludeExtendsTagPattern(),
+            object : CompletionProvider<CompletionParameters>() {
+                override fun addCompletions(
+                    parameters: CompletionParameters,
+                    context: ProcessingContext,
+                    result: CompletionResultSet
+                ) {
+                    if (!TwigPattern.isShopwareIncludeExtendsTag(parameters.position)) {
+                        return
+                    }
+
+                    result.addAllElements(ShopwareTemplateUtil.getTemplateLookupElements(parameters.position.project))
+                }
+            }
+        )
+
         extend(
             CompletionType.BASIC,
             TwigPattern.getPrintBlockOrTagFunctionPattern("theme_config"),

src/main/kotlin/de/shyim/shopware6/index/ShopwareTemplateIndex.kt

@@ -0,0 +1,60 @@
+package de.shyim.shopware6.index
+
+import com.intellij.util.indexing.DataIndexer
+import com.intellij.util.indexing.DefaultFileTypeSpecificInputFilter
+import com.intellij.util.indexing.FileBasedIndex
+import com.intellij.util.indexing.FileBasedIndexExtension
+import com.intellij.util.indexing.FileContent
+import com.intellij.util.indexing.ID
+import com.intellij.util.io.EnumeratorStringDescriptor
+import com.intellij.util.io.KeyDescriptor
+import com.jetbrains.twig.TwigFileType
+import de.shyim.shopware6.util.TwigUtil
+
+/**
+ * Indexes every template by its path relative to Resources/views. The value is the template
+ * reference of the sw_extends tag inside the file (empty when the file does not extend).
+ */
+class ShopwareTemplateIndex : FileBasedIndexExtension<String, String>() {
+    override fun getName(): ID<String, String> {
+        return key
+    }
+
+    override fun getIndexer(): DataIndexer<String, String, FileContent> {
+        return DataIndexer { inputData ->
+            if (!inputData.file.path.contains("Resources/views/")) {
+                return@DataIndexer mapOf()
+            }
+
+            mapOf(
+                TwigUtil.getRelativePath(inputData.file.path) to
+                        (TwigUtil.findExtendsTargetReference(inputData.contentAsText) ?: "")
+            )
+        }
+    }
+
+    override fun getKeyDescriptor(): KeyDescriptor<String> {
+        return EnumeratorStringDescriptor.INSTANCE
+    }
+
+    override fun getValueExternalizer(): EnumeratorStringDescriptor {
+        return EnumeratorStringDescriptor.INSTANCE
+    }
+
+    override fun getVersion(): Int {
+        return 1
+    }
+
+    override fun getInputFilter(): FileBasedIndex.InputFilter {
+        return object : DefaultFileTypeSpecificInputFilter(TwigFileType.INSTANCE) {
+        }
+    }
+
+    override fun dependsOnFileContent(): Boolean {
+        return true
+    }
+
+    companion object {
+        val key = ID.create<String, String>("de.shyim.shopware6.frontend.twig_templates")
+    }
+}

src/main/kotlin/de/shyim/shopware6/navigation/TwigBlockGoToDeclareHandler.kt

@@ -0,0 +1,32 @@
+package de.shyim.shopware6.navigation
+
+import com.intellij.codeInsight.navigation.actions.GotoDeclarationHandler
+import com.intellij.openapi.editor.Editor
+import com.intellij.psi.PsiElement
+import com.jetbrains.twig.elements.TwigBlockTag
+import de.shyim.shopware6.util.TwigUtil
+
+class TwigBlockGoToDeclareHandler : GotoDeclarationHandler {
+    override fun getGotoDeclarationTargets(
+        element: PsiElement?,
+        offset: Int,
+        editor: Editor?
+    ): Array<PsiElement>? {
+        if (element == null) {
+            return null
+        }
+
+        val blockTag = element.parent as? TwigBlockTag ?: return null
+        val blockName = blockTag.name ?: return null
+
+        if (blockName != element.text) {
+            return null
+        }
+
+        // navigate to the upstream block this one overrides, nearest parent first
+        val targets = TwigUtil.getUpstreamBlocks(element.containingFile.originalFile, blockName)
+            .mapNotNull { TwigUtil.findBlockTagInFile(element.project, it.absolutePath, blockName) }
+
+        return if (targets.isEmpty()) null else targets.toTypedArray()
+    }
+}

src/main/kotlin/de/shyim/shopware6/navigation/TwigTemplateGoToDeclareHandler.kt

@@ -0,0 +1,47 @@
+package de.shyim.shopware6.navigation
+
+import com.intellij.codeInsight.navigation.actions.GotoDeclarationHandler
+import com.intellij.openapi.editor.Editor
+import com.intellij.psi.PsiElement
+import com.intellij.psi.PsiManager
+import com.intellij.psi.util.elementType
+import com.jetbrains.twig.TwigTokenTypes
+import com.jetbrains.twig.elements.TwigElementTypes
+import de.shyim.shopware6.util.ShopwareTemplateUtil
+
+class TwigTemplateGoToDeclareHandler : GotoDeclarationHandler {
+    override fun getGotoDeclarationTargets(
+        element: PsiElement?,
+        offset: Int,
+        editor: Editor?
+    ): Array<PsiElement>? {
+        if (element == null || element.elementType != TwigTokenTypes.STRING_TEXT) {
+            return null
+        }
+
+        val tag = element.parent ?: return null
+
+        if (tag.elementType != TwigElementTypes.TAG) {
+            return null
+        }
+
+        val tagName = tag.node.findChildByType(TwigTokenTypes.TAG_NAME)?.text
+        if (tagName != "sw_extends" && tagName != "sw_include") {
+            return null
+        }
+
+        // only the template reference, not other strings inside the tag (e.g. sw_include with)
+        if (tag.node.getChildren(null).firstOrNull { it.elementType == TwigTokenTypes.STRING_TEXT }?.psi != element) {
+            return null
+        }
+
+        val project = element.project
+        val currentPath = element.containingFile.originalFile.virtualFile?.path
+
+        val targets = ShopwareTemplateUtil.resolveTemplateReference(project, element.text)
+            .filter { it.path != currentPath }
+            .mapNotNull { PsiManager.getInstance(project).findFile(it) }
+
+        return if (targets.isEmpty()) null else targets.toTypedArray()
+    }
+}

src/main/kotlin/de/shyim/shopware6/symfonyplugin/SymfonyTwigCompletionProvider.kt

@@ -8,8 +8,6 @@ import com.intellij.codeInsight.completion.CompletionType
 import com.intellij.util.ProcessingContext
 import de.shyim.shopware6.util.TwigPattern
 import fr.adrienbrault.idea.symfony2plugin.routing.RouteHelper
-import fr.adrienbrault.idea.symfony2plugin.templating.util.TwigUtil
-import java.util.Collections
 
 class SymfonyTwigCompletionProvider : CompletionContributor() {
     init {
@@ -27,24 +25,5 @@ class SymfonyTwigCompletionProvider : CompletionContributor() {
             }
         )
 
-        extend(
-            CompletionType.BASIC,
-            TwigPattern.getShopwareIncludeExtendsTagPattern(),
-            object : CompletionProvider<CompletionParameters>() {
-                override fun addCompletions(
-                    parameters: CompletionParameters,
-                    context: ProcessingContext,
-                    result: CompletionResultSet
-                ) {
-                    result.addAllElements(
-                        TwigUtil.getTwigLookupElements(
-                            parameters.position.project,
-                            Collections.emptyList()
-                        )
-                    )
-                }
-            }
-        )
-
     }
 }