UCT-1030: Added config files support

bohdan-harniuk · bohdan-harniuk · commit 23d1931ea38c · 2022-03-18T15:49:26.000+02:00
diff --git a/src/com/magento/idea/magento2uct/execution/GenerateUctReportCommand.java b/src/com/magento/idea/magento2uct/execution/GenerateUctReportCommand.java
@@ -135,9 +135,6 @@ public void execute() {
                     boolean isModuleHeaderPrinted = false;
 
                     for (final PsiFile psiFile : new ModuleFilesScanner(componentData)) {
-                        if (!(psiFile instanceof PhpFile)) {
-                            continue;
-                        }
                         final String filename = psiFile.getVirtualFile().getPath();
                         final UctInspectionManager inspectionManager = new UctInspectionManager(
                                 project
diff --git a/src/com/magento/idea/magento2uct/execution/scanner/ModuleFilesScanner.java b/src/com/magento/idea/magento2uct/execution/scanner/ModuleFilesScanner.java
@@ -7,8 +7,8 @@
 
 import com.intellij.psi.PsiDirectory;
 import com.intellij.psi.PsiFile;
-import com.jetbrains.php.lang.psi.PhpFile;
 import com.magento.idea.magento2uct.execution.scanner.data.ComponentData;
+import com.magento.idea.magento2uct.packages.SupportedIssue;
 import java.util.ArrayList;
 import java.util.Iterator;
 import java.util.List;
@@ -53,9 +53,12 @@ private List<PsiFile> run() {
      */
     private void collectFilesInDirectoryRecursively(final @NotNull PsiDirectory directory) {
         for (final PsiFile file : directory.getFiles()) {
-            if (file instanceof PhpFile) {
-                files.add(file);
+            if (SupportedIssue.getSupportedFileTypes().stream().noneMatch(
+                    clazz -> clazz.isInstance(file))
+            ) {
+                continue;
             }
+            files.add(file);
         }
 
         for (final PsiDirectory subDirectory : directory.getSubdirectories()) {
diff --git a/src/com/magento/idea/magento2uct/inspections/UctInspectionManager.java b/src/com/magento/idea/magento2uct/inspections/UctInspectionManager.java
@@ -11,6 +11,7 @@
 import com.intellij.psi.PsiElementVisitor;
 import com.intellij.psi.PsiFile;
 import com.intellij.psi.util.PsiTreeUtil;
+import com.intellij.psi.xml.XmlFile;
 import com.jetbrains.php.codeInsight.PhpCodeInsightUtil;
 import com.jetbrains.php.lang.psi.PhpFile;
 import com.jetbrains.php.lang.psi.elements.AssignmentExpression;
@@ -49,7 +50,9 @@ public UctInspectionManager(final @NotNull Project project) {
      * @return ProblemsHolder
      */
     public @Nullable UctProblemsHolder run(final PsiFile psiFile) {
-        if (!(psiFile instanceof PhpFile)) {
+        if (SupportedIssue.getSupportedFileTypes().stream().noneMatch(
+                clazz -> clazz.isInstance(psiFile))
+        ) {
             return null;
         }
         final UctProblemsHolder problemsHolder = new UctProblemsHolder(
@@ -78,25 +81,29 @@ public UctInspectionManager(final @NotNull Project project) {
     private List<PsiElement> collectElements(final @NotNull PsiFile psiFile) {
         final List<PsiElement> elements = new LinkedList<>();
 
-        final PhpClass phpClass = GetFirstClassOfFile.getInstance().execute((PhpFile) psiFile);
+        if (psiFile instanceof PhpFile) {
+            final PhpClass phpClass = GetFirstClassOfFile.getInstance().execute((PhpFile) psiFile);
 
-        if (phpClass != null) {
-            elements.add(phpClass);
-            final PhpPsiElement scopeForUseOperator = PhpCodeInsightUtil.findScopeForUseOperator(
-                    phpClass
-            );
+            if (phpClass != null) {
+                elements.add(phpClass);
+                final PhpPsiElement scopeForUseOperator = PhpCodeInsightUtil
+                        .findScopeForUseOperator(phpClass);
 
-            if (scopeForUseOperator != null) {
-                elements.addAll(PhpCodeInsightUtil.collectImports(scopeForUseOperator));
+                if (scopeForUseOperator != null) {
+                    elements.addAll(PhpCodeInsightUtil.collectImports(scopeForUseOperator));
+                }
+                elements.addAll(Arrays.asList(phpClass.getOwnFields()));
             }
-            elements.addAll(Arrays.asList(phpClass.getOwnFields()));
-        }
-        elements.addAll(PsiTreeUtil.findChildrenOfType(psiFile, ClassConstantReference.class));
-        elements.addAll(PsiTreeUtil.findChildrenOfType(psiFile, MethodReference.class));
-        elements.addAll(PsiTreeUtil.findChildrenOfType(psiFile, AssignmentExpression.class));
-        elements.addAll(PsiTreeUtil.findChildrenOfType(psiFile, ClassReference.class));
-        elements.addAll(PsiTreeUtil.findChildrenOfType(psiFile, FieldReference.class));
 
+            elements.addAll(PsiTreeUtil.findChildrenOfType(psiFile, ClassConstantReference.class));
+            elements.addAll(PsiTreeUtil.findChildrenOfType(psiFile, MethodReference.class));
+            elements.addAll(PsiTreeUtil.findChildrenOfType(psiFile, AssignmentExpression.class));
+            elements.addAll(PsiTreeUtil.findChildrenOfType(psiFile, ClassReference.class));
+            elements.addAll(PsiTreeUtil.findChildrenOfType(psiFile, FieldReference.class));
+        } else if (psiFile instanceof XmlFile) {
+            elements.add(psiFile);
+        }
+        
         return elements;
     }
 }
diff --git a/src/com/magento/idea/magento2uct/inspections/xml/ModuleConfigFileInspection.java b/src/com/magento/idea/magento2uct/inspections/xml/ModuleConfigFileInspection.java
@@ -7,9 +7,11 @@
 
 import com.intellij.codeInspection.InspectionManager;
 import com.intellij.codeInspection.ProblemDescriptor;
+import com.intellij.codeInspection.ProblemsHolder;
 import com.intellij.codeInspection.XmlSuppressableInspectionTool;
 import com.intellij.openapi.project.Project;
 import com.intellij.psi.PsiElement;
+import com.intellij.psi.PsiElementVisitor;
 import com.intellij.psi.PsiFile;
 import com.intellij.psi.tree.IElementType;
 import com.intellij.psi.util.PsiTreeUtil;
@@ -39,6 +41,17 @@ abstract class ModuleConfigFileInspection extends XmlSuppressableInspectionTool
             "product_types.xml",
             "widget.xml",
     };
+    private ProblemsHolder problemsHolder;
+
+    @Override
+    public @NotNull PsiElementVisitor buildVisitor(
+            final @NotNull ProblemsHolder holder,
+            final boolean isOnTheFly
+    ) {
+        problemsHolder = holder;
+
+        return super.buildVisitor(holder, isOnTheFly);
+    }
 
     @Override
     public @Nullable ProblemDescriptor[] checkFile(
@@ -48,8 +61,9 @@ abstract class ModuleConfigFileInspection extends XmlSuppressableInspectionTool
     ) {
         final Project project = file.getProject();
         final UctSettingsService settings = UctSettingsService.getInstance(project);
+        final ProblemsHolder holder = getProblemsHolder();
 
-        if (!settings.isEnabled()) {
+        if (!settings.isEnabled() || holder == null) {
             return getEmptyResult();
         }
 
@@ -72,7 +86,7 @@ abstract class ModuleConfigFileInspection extends XmlSuppressableInspectionTool
                 continue;
             }
             // Inspection logic.
-            doInspection(fqn, token, manager, isOnTheFly, descriptors);
+            doInspection(fqn, token, manager, holder, isOnTheFly, descriptors);
         }
 
         return descriptors.toArray(new ProblemDescriptor[0]);
@@ -84,17 +98,23 @@ abstract class ModuleConfigFileInspection extends XmlSuppressableInspectionTool
      * @param fqn String
      * @param target PsiElement
      * @param manager InspectionManager
+     * @param holder ProblemsHolder
      * @param isOnTheFly boolean
      * @param descriptors List[ProblemDescriptor]
      */
     protected abstract void doInspection(
             final @NotNull String fqn,
             final @NotNull PsiElement target,
             final @NotNull InspectionManager manager,
+            final @NotNull ProblemsHolder holder,
             final boolean isOnTheFly,
             final @NotNull List<ProblemDescriptor> descriptors
     );
 
+    private @Nullable ProblemsHolder getProblemsHolder() {
+        return problemsHolder;
+    }
+
     /**
      * Retrieves an empty result.
      *
diff --git a/src/com/magento/idea/magento2uct/inspections/xml/UsedDeprecatedTypeInConfig.java b/src/com/magento/idea/magento2uct/inspections/xml/UsedDeprecatedTypeInConfig.java
@@ -8,7 +8,9 @@
 import com.intellij.codeInspection.InspectionManager;
 import com.intellij.codeInspection.ProblemDescriptor;
 import com.intellij.codeInspection.ProblemHighlightType;
+import com.intellij.codeInspection.ProblemsHolder;
 import com.intellij.psi.PsiElement;
+import com.magento.idea.magento2uct.inspections.UctProblemsHolder;
 import com.magento.idea.magento2uct.packages.SupportedIssue;
 import com.magento.idea.magento2uct.versioning.VersionStateManager;
 import java.util.List;
@@ -21,6 +23,7 @@ protected void doInspection(
             final @NotNull String fqn,
             final @NotNull PsiElement target,
             final @NotNull InspectionManager manager,
+            final @NotNull ProblemsHolder holder,
             final boolean isOnTheFly,
             final @NotNull List<ProblemDescriptor> descriptors
     ) {
@@ -32,6 +35,11 @@ protected void doInspection(
                     ).getDeprecatedInVersion(fqn)
             );
 
+            if (holder instanceof UctProblemsHolder) {
+                ((UctProblemsHolder) holder).setIssue(
+                        SupportedIssue.USED_DEPRECATED_TYPE_IN_CONFIG
+                );
+            }
             final ProblemDescriptor descriptor = manager.createProblemDescriptor(
                     target,
                     message,
diff --git a/src/com/magento/idea/magento2uct/inspections/xml/UsedNonExistentTypeInConfig.java b/src/com/magento/idea/magento2uct/inspections/xml/UsedNonExistentTypeInConfig.java
@@ -8,7 +8,9 @@
 import com.intellij.codeInspection.InspectionManager;
 import com.intellij.codeInspection.ProblemDescriptor;
 import com.intellij.codeInspection.ProblemHighlightType;
+import com.intellij.codeInspection.ProblemsHolder;
 import com.intellij.psi.PsiElement;
+import com.magento.idea.magento2uct.inspections.UctProblemsHolder;
 import com.magento.idea.magento2uct.packages.SupportedIssue;
 import com.magento.idea.magento2uct.versioning.VersionStateManager;
 import java.util.List;
@@ -21,6 +23,7 @@ protected void doInspection(
             final @NotNull String fqn,
             final @NotNull PsiElement target,
             final @NotNull InspectionManager manager,
+            final @NotNull ProblemsHolder holder,
             final boolean isOnTheFly,
             final @NotNull List<ProblemDescriptor> descriptors
     ) {
@@ -32,6 +35,11 @@ protected void doInspection(
                     ).getRemovedInVersion(fqn)
             );
 
+            if (holder instanceof UctProblemsHolder) {
+                ((UctProblemsHolder) holder).setIssue(
+                        SupportedIssue.USED_NON_EXISTENT_TYPE_IN_CONFIG
+                );
+            }
             final ProblemDescriptor descriptor = manager.createProblemDescriptor(
                     target,
                     message,
diff --git a/src/com/magento/idea/magento2uct/packages/SupportedIssue.java b/src/com/magento/idea/magento2uct/packages/SupportedIssue.java
@@ -7,6 +7,7 @@
 
 import com.intellij.codeInspection.LocalInspectionTool;
 import com.intellij.psi.PsiElementVisitor;
+import com.intellij.psi.xml.XmlFile;
 import com.jetbrains.php.lang.psi.PhpFile;
 import com.magento.idea.magento2uct.bundles.UctInspectionBundle;
 import com.magento.idea.magento2uct.inspections.UctProblemsHolder;
@@ -401,6 +402,7 @@ public static List<PsiElementVisitor> getVisitors(
     public static List<Class<?>> getSupportedFileTypes() {
         final List<Class<?>> types = new ArrayList<>();
         types.add(PhpFile.class);
+        types.add(XmlFile.class);
 
         return types;
     }
