Added the Require JS mapping reference navigation support

META-INF/plugin.xml

@@ -88,6 +88,8 @@
         <fileBasedIndex implementation="com.magento.idea.magento2plugin.stubs.indexes.mftf.PageIndex" />
         <fileBasedIndex implementation="com.magento.idea.magento2plugin.stubs.indexes.mftf.StepKeyIndex" />
         <fileBasedIndex implementation="com.magento.idea.magento2plugin.stubs.indexes.graphql.GraphQlResolverIndex" />
+        <fileBasedIndex implementation="com.magento.idea.magento2plugin.stubs.indexes.js.RequireJsIndex" />
+        <fileBasedIndex implementation="com.magento.idea.magento2plugin.stubs.indexes.js.MagentoLibJsIndex" />
 
         <codeInsight.lineMarkerProvider language="PHP" implementationClass="com.magento.idea.magento2plugin.php.linemarker.PluginLineMarkerProvider"/>
         <codeInsight.lineMarkerProvider language="PHP" implementationClass="com.magento.idea.magento2plugin.php.linemarker.ClassConfigurationLineMarkerProvider"/>

src/com/magento/idea/magento2plugin/completion/provider/RequireJsMappingCompletionProvider.java

@@ -0,0 +1,44 @@
+/*
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+package com.magento.idea.magento2plugin.completion.provider;
+
+import com.intellij.codeInsight.completion.CompletionParameters;
+import com.intellij.codeInsight.completion.CompletionProvider;
+import com.intellij.codeInsight.completion.CompletionResultSet;
+import com.intellij.codeInsight.lookup.LookupElementBuilder;
+import com.intellij.lang.javascript.JavaScriptFileType;
+import com.intellij.psi.PsiElement;
+import com.intellij.util.ProcessingContext;
+import com.intellij.util.indexing.FileBasedIndex;
+import com.magento.idea.magento2plugin.stubs.indexes.js.RequireJsIndex;
+import org.jetbrains.annotations.NotNull;
+import java.util.Collection;
+
+public class RequireJsMappingCompletionProvider extends CompletionProvider<CompletionParameters> {
+
+    @Override
+    protected void addCompletions(@NotNull CompletionParameters parameters,
+                                  ProcessingContext context,
+                                  @NotNull CompletionResultSet result) {
+        PsiElement position = parameters.getPosition().getOriginalElement();
+        if (position == null) {
+            return;
+        }
+        String prefix = result.getPrefixMatcher().getPrefix();
+
+        Collection<String> requireJsKeys
+                = FileBasedIndex.getInstance().getAllKeys(RequireJsIndex.KEY, position.getProject());
+
+        requireJsKeys.removeIf(m -> !m.startsWith(prefix));
+        JavaScriptFileType jsFileType = new JavaScriptFileType();
+        for (String requireJsKey : requireJsKeys) {
+            result.addElement(
+                    LookupElementBuilder
+                            .create(requireJsKey)
+                            .withIcon(jsFileType.getIcon())
+            );
+        }
+    }
+}

src/com/magento/idea/magento2plugin/completion/xml/XmlCompletionContributor.java

@@ -107,6 +107,25 @@ public XmlCompletionContributor() {
             new EventNameCompletionContributor()
         );
 
+        extend(CompletionType.BASIC, psiElement(XmlTokenType.XML_ATTRIBUTE_VALUE_TOKEN)
+            .inside(XmlPatterns.xmlAttributeValue().withParent(
+                XmlPatterns.xmlAttribute().withName("component")
+            )),
+            new RequireJsMappingCompletionProvider()
+        );
+
+        extend(CompletionType.BASIC, psiElement(XmlTokenType.XML_DATA_CHARACTERS)
+             .withParent(XmlPatterns.xmlText().withParent(
+                XmlPatterns.xmlTag().withName("item").withChild(
+                        XmlPatterns.xmlAttribute().withValue(string().matches("component"))
+                    ).withChild(
+                        XmlPatterns.xmlAttribute().withName("name")
+                    )
+                )
+            ),
+            new RequireJsMappingCompletionProvider()
+        );
+
         // mftf selector completion contributor
         extend(CompletionType.BASIC,
             psiElement(XmlTokenType.XML_ATTRIBUTE_VALUE_TOKEN)

src/com/magento/idea/magento2plugin/indexes/IndexManager.java

@@ -7,6 +7,8 @@
 import com.intellij.util.indexing.FileBasedIndexImpl;
 import com.intellij.util.indexing.ID;
 import com.magento.idea.magento2plugin.stubs.indexes.*;
+import com.magento.idea.magento2plugin.stubs.indexes.js.MagentoLibJsIndex;
+import com.magento.idea.magento2plugin.stubs.indexes.js.RequireJsIndex;
 import com.magento.idea.magento2plugin.stubs.indexes.graphql.GraphQlResolverIndex;
 import com.magento.idea.magento2plugin.stubs.indexes.mftf.*;
 import com.magento.idea.magento2plugin.stubs.indexes.xml.PhpClassNameIndex;
@@ -32,6 +34,9 @@ public static void manualReindex() {
             WebApiTypeIndex.KEY,
             ModuleNameIndex.KEY,
             PhpClassNameIndex.KEY,
+            //require_js
+            RequireJsIndex.KEY,
+            MagentoLibJsIndex.KEY,
             // mftf
             ActionGroupIndex.KEY,
             DataIndex.KEY,

src/com/magento/idea/magento2plugin/indexes/JsIndex.java

@@ -0,0 +1,118 @@
+/*
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+package com.magento.idea.magento2plugin.indexes;
+
+import com.intellij.openapi.project.Project;
+import com.intellij.openapi.vfs.VirtualFile;
+import com.intellij.psi.PsiElement;
+import com.intellij.psi.PsiManager;
+import com.intellij.psi.PsiReference;
+import com.intellij.psi.search.GlobalSearchScope;
+import com.intellij.util.indexing.FileBasedIndex;
+import com.magento.idea.magento2plugin.reference.xml.PolyVariantReferenceBase;
+import com.magento.idea.magento2plugin.stubs.indexes.js.RequireJsIndex;
+import com.magento.idea.magento2plugin.reference.provider.util.GetAllSubFilesOfVirtualFileUtil;
+import com.magento.idea.magento2plugin.reference.provider.util.GetFilePathUtil;
+import com.magento.idea.magento2plugin.reference.provider.util.GetModuleNameUtil;
+import com.magento.idea.magento2plugin.reference.provider.util.GetModuleSourceFilesUtil;
+import org.jetbrains.annotations.NotNull;
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.List;
+
+public class JsIndex {
+
+    private static JsIndex INSTANCE;
+
+    private JsIndex() {
+    }
+
+    public static JsIndex getInstance() {
+        if (null == INSTANCE) {
+            INSTANCE = new JsIndex();
+        }
+        return INSTANCE;
+    }
+
+    public PsiReference[] getRequireJsPreferences(@NotNull PsiElement element, final GlobalSearchScope scope) {
+        String originalValue = element.getText();
+        String jsKey = originalValue
+                .replace("'", "")
+                .replace("\"", "");
+
+        Collection<String> values =
+                FileBasedIndex.getInstance().getValues(RequireJsIndex.KEY, jsKey, scope);
+        PsiManager psiManager = PsiManager.getInstance(element.getProject());
+
+        List<PsiElement> targets = new ArrayList<>();
+        if (values.isEmpty()) {
+            Collection<VirtualFile> files = LibJsIndex.getInstance().getLibJsFiles(jsKey, element.getProject());
+            convertVirtualFilesToPsiElements(psiManager, targets, jsKey, files);
+        } else {
+            for (String value : values) {
+                String filePath = GetFilePathUtil.getInstance().execute(value);
+                if (null == filePath) {
+                    continue;
+                }
+                Collection<VirtualFile> files = getJsFilesByPath(value, element.getProject());
+
+                convertVirtualFilesToPsiElements(psiManager, targets, filePath, files);
+            }
+        }
+
+        if (targets.isEmpty()) {
+            return PsiReference.EMPTY_ARRAY;
+        }
+
+        return new PsiReference[] {
+                new PolyVariantReferenceBase(element, targets)
+        };
+    }
+
+    private void convertVirtualFilesToPsiElements(PsiManager psiManager, List<PsiElement> targets, String filePath, Collection<VirtualFile> files) {
+        for (VirtualFile file : files) {
+            String fileUrl = file.getUrl();
+            if (!fileUrl.contains(filePath)) {
+                return;
+            }
+
+            PsiElement psiElement = psiManager.findFile(file);
+            if (null != psiElement) {
+                targets.add(psiElement);
+            }
+        }
+    }
+
+    private Collection<VirtualFile> getJsFilesByPath(@NotNull String filePath, @NotNull Project project)
+    {
+        Collection<VirtualFile> virtualFiles = new ArrayList<>();
+        Collection<VirtualFile> files = new ArrayList<>();
+
+        String fileName = filePath.substring(filePath.lastIndexOf("/") + 1).concat(".js").replace("'", "");
+        String moduleName = GetModuleNameUtil.getInstance().execute(filePath);
+        if (moduleName == null) {
+            virtualFiles.addAll(LibJsIndex.getInstance().getLibJsFiles(filePath, project));
+        } else {
+            virtualFiles.addAll(GetModuleSourceFilesUtil.getInstance().execute(filePath, project));
+        }
+        if (!virtualFiles.isEmpty()) {
+            for (VirtualFile virtualFile : virtualFiles) {
+                Collection<VirtualFile> vfChildren = GetAllSubFilesOfVirtualFileUtil.
+                        getInstance().execute(virtualFile);
+                if (null != vfChildren) {
+                    vfChildren.removeIf(file -> {
+                        if (!file.isDirectory()) {
+                            String name = file.getName();
+                            return !name.equals(fileName);
+                        }
+                        return true;
+                    });
+                    files.addAll(vfChildren);
+                }
+            }
+        }
+        return files;
+    }
+}

src/com/magento/idea/magento2plugin/indexes/LibJsIndex.java

@@ -0,0 +1,36 @@
+/*
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+package com.magento.idea.magento2plugin.indexes;
+
+import com.intellij.openapi.project.Project;
+import com.intellij.openapi.vfs.VirtualFile;
+import com.intellij.psi.search.GlobalSearchScope;
+import com.intellij.util.indexing.FileBasedIndex;
+import com.magento.idea.magento2plugin.stubs.indexes.js.MagentoLibJsIndex;
+import org.jetbrains.annotations.NotNull;
+import java.util.Collection;
+
+public class LibJsIndex {
+
+    private static LibJsIndex INSTANCE;
+
+    private LibJsIndex() {
+    }
+
+    public static LibJsIndex getInstance() {
+        if (null == INSTANCE) {
+            INSTANCE = new LibJsIndex();
+        }
+        return INSTANCE;
+    }
+
+    public Collection<VirtualFile> getLibJsFiles(@NotNull String filePath, @NotNull Project project) {
+        return FileBasedIndex.getInstance()
+                .getContainingFiles(MagentoLibJsIndex.KEY,
+                        filePath.replace("'", ""),
+                        GlobalSearchScope.allScope(project)
+                );
+    }
+}

src/com/magento/idea/magento2plugin/reference/js/JsReferenceContributor.java

@@ -8,6 +8,7 @@
 import com.intellij.psi.*;
 import com.magento.idea.magento2plugin.reference.provider.FilePathReferenceProvider;
 import com.magento.idea.magento2plugin.reference.provider.ModuleNameReferenceProvider;
+import com.magento.idea.magento2plugin.reference.provider.RequireJsPreferenceReferenceProvider;
 import com.magento.idea.magento2plugin.util.RegExUtil;
 import org.jetbrains.annotations.NotNull;
 
@@ -26,5 +27,10 @@ public void registerReferenceProviders(@NotNull PsiReferenceRegistrar registrar)
                 JSPatterns.jsLiteralExpression().withText(string().matches(".*\\W" + RegExUtil.FILE_PATH + ".*")),
                 new FilePathReferenceProvider()
         );
+
+        registrar.registerReferenceProvider(
+                JSPatterns.jsLiteralExpression().withText(string().matches(".*\\W" + RegExUtil.FILE_PATH + ".*")),
+                new RequireJsPreferenceReferenceProvider()
+        );
     }
 }