#223: Improve error messages for reference inspection

Author: filiphr

src/main/java/org/mapstruct/intellij/codeinsight/references/BaseMappingReference.java

@@ -0,0 +1,30 @@
+/*
+ * Copyright MapStruct Authors.
+ *
+ * Licensed under the Apache License version 2.0, available at https://www.apache.org/licenses/LICENSE-2.0
+ */
+package org.mapstruct.intellij.codeinsight.references;
+
+import com.intellij.openapi.util.TextRange;
+import com.intellij.psi.PsiElement;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+import org.mapstruct.intellij.MapStructBundle;
+
+/**
+ * @author Filip Hrisafov
+ */
+abstract class BaseMappingReference extends MapstructBaseReference {
+
+    BaseMappingReference(@NotNull PsiElement element, @Nullable MapstructBaseReference previousReference,
+                         TextRange rangeInElement, String value) {
+        super( element, previousReference, rangeInElement, value );
+    }
+
+    @NotNull
+    @Override
+    public String getUnresolvedMessagePattern() {
+        //noinspection UnresolvedPropertyKey
+        return MapStructBundle.message( "unknown.property" );
+    }
+}

src/main/java/org/mapstruct/intellij/codeinsight/references/BaseReference.java

@@ -5,6 +5,7 @@
  */
 package org.mapstruct.intellij.codeinsight.references;
 
+import com.intellij.codeInsight.daemon.EmptyResolveMessageProvider;
 import com.intellij.openapi.util.TextRange;
 import com.intellij.psi.PsiElement;
 import com.intellij.psi.PsiMethod;
@@ -21,7 +22,7 @@
  *
  * @author Filip Hrisafov
  */
-public abstract class BaseReference extends PsiReferenceBase<PsiElement> {
+public abstract class BaseReference extends PsiReferenceBase<PsiElement> implements EmptyResolveMessageProvider {
 
     /**
      * @param element the element for which a reference should be found

src/main/java/org/mapstruct/intellij/codeinsight/references/BaseValueMappingReference.java

@@ -13,6 +13,7 @@
 import com.intellij.psi.PsiMethod;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
+import org.mapstruct.intellij.MapStructBundle;
 
 /**
  * Base Reference for {@link org.mapstruct.ValueMapping}(s).
@@ -108,6 +109,13 @@ public final Object[] getVariants() {
     @NotNull
     abstract Object[] getVariantsInternal(@NotNull PsiMethod mappingMethod, @NotNull PsiClass enumClass);
 
+    @NotNull
+    @Override
+    public String getUnresolvedMessagePattern() {
+        //noinspection UnresolvedPropertyKey
+        return MapStructBundle.message( "unknown.enum.constant" );
+    }
+
     private static boolean isNotValueMapping(@Nullable PsiMethod mappingMethod) {
         return mappingMethod == null || mappingMethod.getParameterList().getParametersCount() != 1;
     }

src/main/java/org/mapstruct/intellij/codeinsight/references/MapstructMappingQualifiedByNameReference.java

@@ -24,6 +24,7 @@
 import com.intellij.psi.PsiTypes;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
+import org.mapstruct.intellij.MapStructBundle;
 import org.mapstruct.intellij.util.MapstructUtil;
 
 import static com.intellij.codeInsight.AnnotationUtil.findAnnotation;
@@ -167,6 +168,13 @@ PsiType resolvedType() {
         return null;
     }
 
+    @NotNull
+    @Override
+    public String getUnresolvedMessagePattern() {
+        //noinspection UnresolvedPropertyKey
+        return MapStructBundle.message( "unknown.qualifiedByName.reference" );
+    }
+
     /**
      * @param psiElement the literal for which references need to be created
      * @return the references for the given {@code psiLiteral}

src/main/java/org/mapstruct/intellij/codeinsight/references/MapstructSourceReference.java

@@ -35,7 +35,7 @@
  *
  * @author Filip Hrisafov
  */
-class MapstructSourceReference extends MapstructBaseReference {
+class MapstructSourceReference extends BaseMappingReference {
 
     /**
      * Create a new {@link MapstructSourceReference} with the provided parameters.

src/main/java/org/mapstruct/intellij/codeinsight/references/MapstructTargetReference.java

@@ -49,7 +49,7 @@
  *
  * @author Filip Hrisafov
  */
-class MapstructTargetReference extends MapstructBaseReference {
+class MapstructTargetReference extends BaseMappingReference {
 
     private final MapStructVersion mapStructVersion;
 

src/main/java/org/mapstruct/intellij/inspection/MapstructReferenceInspection.java

@@ -47,7 +47,7 @@ public void visitElement(@NotNull PsiElement element) {
                     if ( psiReference instanceof BaseReference baseReference && psiReference.resolve() == null ) {
                         TextRange range = psiReference.getRangeInElement();
                         if (range.isEmpty() && range.getStartOffset() == 1 && "\"\"".equals( element.getText() ) ) {
-                            String message = ProblemsHolder.unresolvedReferenceMessage( psiReference );
+                            String message = ProblemsHolder.unresolvedReferenceMessage( baseReference );
                             holder.registerProblem( element, message, ProblemHighlightType.LIKE_UNKNOWN_SYMBOL,
                                     TextRange.create( 0, 2 ) );
                         }

src/main/resources/org/mapstruct/intellij/messages/MapStructBundle.properties

@@ -44,3 +44,6 @@ intention.replace.source.property=Replace source ''.'' with ''{0}''
 plugin.settings.title=MapStruct
 plugin.settings.quickFix.title=Quick fix properties
 plugin.settings.quickFix.preferSourceBeforeTargetInMapping=Prefer source before target in @Mapping
+unknown.property=Unknown property ''{0}''
+unknown.enum.constant=Unknown enum constant ''{0}''
+unknown.qualifiedByName.reference=Unknown @Named reference ''{0}''

testData/inspection/UnknownIgnoreUnmappedSourceReference.java

@@ -39,7 +39,7 @@ public void setTestName(String testName) {
 interface SingleMappingMapper {
 
     @Mapping(target = "testName", ignore = true)
-    @BeanMapping(ignoreUnmappedSourceProperties = {"<error descr="Cannot resolve symbol 'testName'">testName</error>"})
+    @BeanMapping(ignoreUnmappedSourceProperties = {"<error descr="Unknown property 'testName'">testName</error>"})
     Target map(Source source);
 }
 
@@ -49,6 +49,6 @@ interface SingleMappingsMapper {
     @Mappings({
         @Mapping(target = "testName", ignore = true)
     })
-    @BeanMapping(ignoreUnmappedSourceProperties = {"<error descr="Cannot resolve symbol 'testName'">testName</error>"})
+    @BeanMapping(ignoreUnmappedSourceProperties = {"<error descr="Unknown property 'testName'">testName</error>"})
     Target map(Source source);
 }

testData/inspection/UnknownNestedSourceReference.java

@@ -49,15 +49,15 @@ public void setTestName(String testName) {
 @Mapper
 interface SingleMappingMapper {
 
-    @Mapping(target = "testName", source="inner.<error descr="Cannot resolve symbol 'testName'">testName</error>")
+    @Mapping(target = "testName", source="inner.<error descr="Unknown property 'testName'">testName</error>")
     Target map(Source source);
 }
 
 @Mapper
 interface SingleMappingsMapper {
 
     @Mappings({
-        @Mapping(target = "testName", source="inner.<error descr="Cannot resolve symbol 'testName'">testName</error>")
+        @Mapping(target = "testName", source="inner.<error descr="Unknown property 'testName'">testName</error>")
     })
     Target map(Source source);
 }