Replaced UndefinedVariable by adding validation severity setting for Qute UndefinedObject error

Signed-off-by: Alexander Chen <alchen@redhat.com>

Author: Alexander Chen

qute.ls/com.redhat.qute.ls/src/main/java/com/redhat/qute/services/QuteCodeActions.java

@@ -50,7 +50,7 @@
 
 /**
  * Qute code actions support.
- * 
+ *
  * @author Angelo ZERR
  *
  */
@@ -91,13 +91,13 @@ public CompletableFuture<List<CodeAction>> doCodeActions(Template template, Code
 				QuteErrorCode errorCode = QuteErrorCode.getErrorCode(diagnostic.getCode());
 				if (errorCode != null) {
 					switch (errorCode) {
-					case UndefinedVariable:
+					case UndefinedObject:
 						// The following Qute template:
-						// {undefinedVariable}
+						// {undefinedObject}
 						//
 						// will provide a quickfix like:
 						//
-						// Declare `undefinedVariable` with parameter declaration."
+						// Declare `undefinedObject` with parameter declaration."
 						doCodeActionsForUndefinedVariable(template, diagnostic, codeActions);
 						break;
 					case UndefinedSectionTag:
@@ -188,13 +188,13 @@ private static void doCodeActionToDisableValidation(Template template, List<Diag
 
 	/**
 	 * Create the configuration update (done on client side) quick fix.
-	 * 
+	 *
 	 * @param title       the displayed name of the QuickFix.
 	 * @param sectionName the section name of the settings to update.
 	 * @param item        the section value of the settings to update.
 	 * @param editType    the configuration edit type.
 	 * @param diagnostic  the diagnostic list that this CodeAction will fix.
-	 * 
+	 *
 	 * @return the configuration update (done on client side) quick fix.
 	 */
 	private static CodeAction createConfigurationUpdateCodeAction(String title, String scopeUri, String sectionName,

qute.ls/com.redhat.qute.ls/src/main/java/com/redhat/qute/services/QuteDiagnostics.java

@@ -172,7 +172,8 @@ public List<Diagnostic> doDiagnostics(Template template, QuteValidationSettings
 		List<Diagnostic> diagnostics = new ArrayList<Diagnostic>();
 		try {
 			diagnosticsForSyntax.validateWithRealQuteParser(template, diagnostics);
-			validateDataModel(template, template, resolvingJavaTypeContext, new ResolutionContext(), diagnostics);
+			validateDataModel(template, template, validationSettings, resolvingJavaTypeContext, new ResolutionContext(),
+					diagnostics);
 		} catch (CancellationException e) {
 			throw e;
 		} catch (Exception e) {
@@ -182,8 +183,9 @@ public List<Diagnostic> doDiagnostics(Template template, QuteValidationSettings
 		return diagnostics;
 	}
 
-	private void validateDataModel(Node parent, Template template, ResolvingJavaTypeContext resolvingJavaTypeContext,
-			ResolutionContext currentContext, List<Diagnostic> diagnostics) {
+	private void validateDataModel(Node parent, Template template, QuteValidationSettings validationSettings,
+			ResolvingJavaTypeContext resolvingJavaTypeContext, ResolutionContext currentContext,
+			List<Diagnostic> diagnostics) {
 		ResolutionContext previousContext = currentContext;
 		List<Node> children = parent.getChildren();
 		for (Node node : children) {
@@ -223,8 +225,8 @@ private void validateDataModel(Node parent, Template template, ResolvingJavaType
 				for (Parameter parameter : parameters) {
 					Expression expression = parameter.getJavaTypeExpression();
 					if (expression != null) {
-						ResolvedJavaTypeInfo result = validateExpression(expression, section, template, previousContext,
-								resolvingJavaTypeContext, diagnostics);
+						ResolvedJavaTypeInfo result = validateExpression(expression, section, template,
+								validationSettings, previousContext, resolvingJavaTypeContext, diagnostics);
 						switch (section.getSectionKind()) {
 						case FOR:
 						case EACH:
@@ -252,13 +254,14 @@ private void validateDataModel(Node parent, Template template, ResolvingJavaType
 				break;
 			}
 			case Expression: {
-				validateExpression((Expression) node, null, template, previousContext, resolvingJavaTypeContext,
-						diagnostics);
+				validateExpression((Expression) node, null, template, validationSettings, previousContext,
+						resolvingJavaTypeContext, diagnostics);
 				break;
 			}
 			default:
 			}
-			validateDataModel(node, template, resolvingJavaTypeContext, currentContext, diagnostics);
+			validateDataModel(node, template, validationSettings, resolvingJavaTypeContext, currentContext,
+					diagnostics);
 		}
 	}
 
@@ -346,8 +349,8 @@ private static void validateIncludeSection(IncludeSection includeSection, List<D
 	}
 
 	private ResolvedJavaTypeInfo validateExpression(Expression expression, Section ownerSection, Template template,
-			ResolutionContext resolutionContext, ResolvingJavaTypeContext resolvingJavaTypeContext,
-			List<Diagnostic> diagnostics) {
+			QuteValidationSettings validationSettings, ResolutionContext resolutionContext,
+			ResolvingJavaTypeContext resolvingJavaTypeContext, List<Diagnostic> diagnostics) {
 		try {
 			String projectUri = template.getProjectUri();
 			String literalJavaType = expression.getLiteralJavaType();
@@ -372,7 +375,7 @@ private ResolvedJavaTypeInfo validateExpression(Expression expression, Section o
 				if (expressionChild.getKind() == NodeKind.ExpressionParts) {
 					Parts parts = (Parts) expressionChild;
 					resolvedJavaType = validateExpressionParts(parts, ownerSection, template, projectUri,
-							resolutionContext, resolvingJavaTypeContext, diagnostics);
+							validationSettings, resolutionContext, resolvingJavaTypeContext, diagnostics);
 				}
 			}
 			return resolvedJavaType;
@@ -386,12 +389,12 @@ private ResolvedJavaTypeInfo validateExpression(Expression expression, Section o
 	}
 
 	private ResolvedJavaTypeInfo validateExpressionParts(Parts parts, Section ownerSection, Template template,
-			String projectUri, ResolutionContext resolutionContext, ResolvingJavaTypeContext resolvingJavaTypeContext,
-			List<Diagnostic> diagnostics) {
+			String projectUri, QuteValidationSettings validationSettings, ResolutionContext resolutionContext,
+			ResolvingJavaTypeContext resolvingJavaTypeContext, List<Diagnostic> diagnostics) {
 		ResolvedJavaTypeInfo resolvedJavaType = null;
 		String namespace = null;
 		for (int i = 0; i < parts.getChildCount(); i++) {
-			Part current = ((Part) parts.getChild(i));
+			Part current = parts.getChild(i);
 
 			if (current.isLast()) {
 				// It's the last part, check if it is not ended with '.'
@@ -423,7 +426,7 @@ private ResolvedJavaTypeInfo validateExpressionParts(Parts parts, Section ownerS
 			case Object: {
 				ObjectPart objectPart = (ObjectPart) current;
 				resolvedJavaType = validateObjectPart(namespace, objectPart, ownerSection, template, projectUri,
-						resolutionContext, diagnostics, resolvingJavaTypeContext);
+						validationSettings, resolutionContext, diagnostics, resolvingJavaTypeContext);
 				if (resolvedJavaType == null) {
 					// The Java type of the object part cannot be resolved, stop the validation of
 					// property, method.
@@ -450,8 +453,8 @@ private ResolvedJavaTypeInfo validateExpressionParts(Parts parts, Section ownerS
 					}
 				}
 
-				resolvedJavaType = validateMemberPart(current, ownerSection, template, projectUri, resolutionContext,
-						resolvedJavaType, iter, diagnostics, resolvingJavaTypeContext);
+				resolvedJavaType = validateMemberPart(current, ownerSection, template, projectUri, validationSettings,
+						resolutionContext, resolvedJavaType, iter, diagnostics, resolvingJavaTypeContext);
 				if (resolvedJavaType == null) {
 					// The Java type of the previous part cannot be resolved, stop the validation of
 					// followings property, method.
@@ -515,7 +518,8 @@ private String validateNamespace(NamespacePart namespacePart, String projectUri,
 	}
 
 	private ResolvedJavaTypeInfo validateObjectPart(String namespace, ObjectPart objectPart, Section ownerSection,
-			Template template, String projectUri, ResolutionContext resolutionContext, List<Diagnostic> diagnostics,
+			Template template, String projectUri, QuteValidationSettings validationSettings,
+			ResolutionContext resolutionContext, List<Diagnostic> diagnostics,
 			ResolvingJavaTypeContext resolvingJavaTypeContext) {
 		JavaMemberInfo javaMember = resolutionContext.findMemberWithObject(objectPart.getPartName(), projectUri);
 		if (javaMember != null) {
@@ -540,8 +544,12 @@ private ResolvedJavaTypeInfo validateObjectPart(String namespace, ObjectPart obj
 			}
 
 			// ex : {item} --> undefined variable
+			DiagnosticSeverity severity = validationSettings.getUndefinedObject().getDiagnosticSeverity();
+			if (severity == null) {
+				return null;
+			}
 			Range range = QutePositionUtility.createRange(objectPart);
-			Diagnostic diagnostic = createDiagnostic(range, DiagnosticSeverity.Warning, QuteErrorCode.UndefinedVariable,
+			Diagnostic diagnostic = createDiagnostic(range, severity, QuteErrorCode.UndefinedObject,
 					objectPart.getPartName());
 			// Create data information helpful for code action
 			diagnostic.setData(DiagnosticDataFactory.createUndefinedVariableData(objectPart.getPartName(),
@@ -585,7 +593,7 @@ private ResolvedJavaTypeInfo validateObjectPart(String namespace, ObjectPart obj
 
 	/**
 	 * Validate the given property, method part.
-	 * 
+	 *
 	 * @param part                     the property, method part to validate.
 	 * @param ownerSection             the owner section and null otherwise.
 	 * @param template                 the template.
@@ -595,18 +603,18 @@ private ResolvedJavaTypeInfo validateObjectPart(String namespace, ObjectPart obj
 	 * @param iterableOfType           the iterable of type.
 	 * @param diagnostics              the diagnostic list to fill.
 	 * @param resolvingJavaTypeContext the resolving Java type context.
-	 * 
+	 *
 	 * @return the Java type returned by the member part and null otherwise.
 	 */
 	private ResolvedJavaTypeInfo validateMemberPart(Part part, Section ownerSection, Template template,
-			String projectUri, ResolutionContext resolutionContext, ResolvedJavaTypeInfo baseType,
-			ResolvedJavaTypeInfo iterableOfType, List<Diagnostic> diagnostics,
+			String projectUri, QuteValidationSettings validationSettings, ResolutionContext resolutionContext,
+			ResolvedJavaTypeInfo baseType, ResolvedJavaTypeInfo iterableOfType, List<Diagnostic> diagnostics,
 			ResolvingJavaTypeContext resolvingJavaTypeContext) {
 		if (part.getPartKind() == PartKind.Method) {
 			// Validate method part
 			// ex : {foo.method(1, 2)}
-			return validateMethodPart((MethodPart) part, ownerSection, template, projectUri, resolutionContext,
-					baseType, iterableOfType, diagnostics, resolvingJavaTypeContext);
+			return validateMethodPart((MethodPart) part, ownerSection, template, projectUri, validationSettings,
+					resolutionContext, baseType, iterableOfType, diagnostics, resolvingJavaTypeContext);
 		}
 		// Validate property part
 		// ex : {foo.property}
@@ -616,7 +624,7 @@ private ResolvedJavaTypeInfo validateMemberPart(Part part, Section ownerSection,
 
 	/**
 	 * Validate the given property part.
-	 * 
+	 *
 	 * @param part                     the property part to validate.
 	 * @param ownerSection             the owner section and null otherwise.
 	 * @param template                 the template.
@@ -626,7 +634,7 @@ private ResolvedJavaTypeInfo validateMemberPart(Part part, Section ownerSection,
 	 * @param iterableOfType           the iterable of type.
 	 * @param diagnostics              the diagnostic list to fill.
 	 * @param resolvingJavaTypeContext the resolving Java type context.
-	 * 
+	 *
 	 * @return the Java type returned by the member part and null otherwise.
 	 */
 	private ResolvedJavaTypeInfo validatePropertyPart(PropertyPart part, Section ownerSection, Template template,
@@ -649,7 +657,7 @@ private ResolvedJavaTypeInfo validatePropertyPart(PropertyPart part, Section own
 
 	/**
 	 * Validate the given method part.
-	 * 
+	 *
 	 * @param part                     the method part to validate.
 	 * @param ownerSection             the owner section and null otherwise.
 	 * @param template                 the template.
@@ -659,12 +667,12 @@ private ResolvedJavaTypeInfo validatePropertyPart(PropertyPart part, Section own
 	 * @param iterableOfType           the iterable of type.
 	 * @param diagnostics              the diagnostic list to fill.
 	 * @param resolvingJavaTypeContext the resolving Java type context.
-	 * 
+	 *
 	 * @return the Java type returned by the member part and null otherwise.
 	 */
 	private ResolvedJavaTypeInfo validateMethodPart(MethodPart methodPart, Section ownerSection, Template template,
-			String projectUri, ResolutionContext resolutionContext, ResolvedJavaTypeInfo resolvedJavaType,
-			ResolvedJavaTypeInfo iter, List<Diagnostic> diagnostics,
+			String projectUri, QuteValidationSettings validationSettings, ResolutionContext resolutionContext,
+			ResolvedJavaTypeInfo resolvedJavaType, ResolvedJavaTypeInfo iter, List<Diagnostic> diagnostics,
 			ResolvingJavaTypeContext resolvingJavaTypeContext) {
 
 		// Validate parameters of the method part
@@ -674,7 +682,7 @@ private ResolvedJavaTypeInfo validateMethodPart(MethodPart methodPart, Section o
 			ResolvedJavaTypeInfo result = null;
 			Expression expression = parameter.getJavaTypeExpression();
 			if (expression != null) {
-				result = validateExpression(expression, ownerSection, template, resolutionContext,
+				result = validateExpression(expression, ownerSection, template, validationSettings, resolutionContext,
 						resolvingJavaTypeContext, diagnostics);
 			}
 			if (result == null) {
@@ -700,7 +708,7 @@ private ResolvedJavaTypeInfo validateMethodPart(MethodPart methodPart, Section o
 			String arg = null;
 			if (namespace != null) {
 				// ex :{config.getXXXX()}
-				errorCode = QuteErrorCode.UnkwownNamespaceResolverMethod;
+				errorCode = QuteErrorCode.UnknownNamespaceResolverMethod;
 				arg = namespace;
 			} else {
 				// ex : {@org.acme.Item item}

qute.ls/com.redhat.qute.ls/src/main/java/com/redhat/qute/services/diagnostics/QuteErrorCode.java

@@ -24,10 +24,10 @@ public enum QuteErrorCode implements IQuteErrorCode {
 	UndefinedNamespace("No namespace resolver found for: `{0}`"), //
 
 	// Error code for object, property, method parts
-	UndefinedVariable("`{0}` cannot be resolved to a variable."), //
+	UndefinedObject("`{0}` cannot be resolved to an object."), //
 	UnknownType("`{0}` cannot be resolved to a type."), //
 	UnknownMethod("`{0}` cannot be resolved or is not a method of `{1}` Java type."), //
-	UnkwownNamespaceResolverMethod("`{0}` cannot be resolved or is not a method of `{1}` namespace resolver."), //
+	UnknownNamespaceResolverMethod("`{0}` cannot be resolved or is not a method of `{1}` namespace resolver."), //
 	InvalidMethodVoid("Invalid `{0}` method of `{1}` : void return is not allowed."), //
 	InvalidMethodFromObject("Invalid `{0}` method of `{1}` : method from `java.lang.Object` is not allowed."), //
 	InvalidMethodStatic("Invalid `{0}` method of `{1}` : static method is not allowed."), //

qute.ls/com.redhat.qute.ls/src/main/java/com/redhat/qute/settings/QuteValidationSettings.java

@@ -27,15 +27,25 @@
  */
 public class QuteValidationSettings {
 
+	public static enum Severity {
+		ignore, error, warning;
+	}
+
 	public static final QuteValidationSettings DEFAULT;
 
+	private static final QuteValidationTypeSettings DEFAULT_UNDEFINED_OBJECT;
+
 	static {
+		DEFAULT_UNDEFINED_OBJECT = new QuteValidationTypeSettings();
+		DEFAULT_UNDEFINED_OBJECT.setSeverity(Severity.warning.name());
 		DEFAULT = new QuteValidationSettings();
 		DEFAULT.updateDefault();
 	}
 
 	private boolean enabled;
 
+	private QuteValidationTypeSettings undefinedObject;
+
 	private List<String> excluded;
 
 	private transient boolean updated;
@@ -90,6 +100,7 @@ private void updateDefault() {
 		if (updated) {
 			return;
 		}
+		setUndefinedObject(undefinedObject != null ? undefinedObject : DEFAULT_UNDEFINED_OBJECT);
 		updated = true;
 	}
 
@@ -101,6 +112,27 @@ private void updateDefault() {
 	public void update(QuteValidationSettings newValidation) {
 		this.setEnabled(newValidation.isEnabled());
 		this.setExcluded(newValidation.getExcluded());
+		this.setUndefinedObject(newValidation.getUndefinedObject());
+	}
+
+	/**
+	 * Returns the settings for Qute undefined object validation.
+	 *
+	 * @return the settings for Qute undefined object validation
+	 */
+	public QuteValidationTypeSettings getUndefinedObject() {
+		updateDefault();
+		return this.undefinedObject;
+	}
+
+	/**
+	 * Set the settings for Qute undefined object validation.
+	 *
+	 * @param undefined the settings for Qute undefined object validation.
+	 */
+	public void setUndefinedObject(QuteValidationTypeSettings undefined) {
+		this.undefinedObject = undefined;
+		this.updated = false;
 	}
 
 	public boolean canValidate(String templateUri) {
@@ -182,6 +214,7 @@ public int hashCode() {
 		int result = 1;
 		result = prime * result + (enabled ? 1231 : 1237);
 		result = prime * result + ((excluded == null) ? 0 : excluded.hashCode());
+		result = prime * result + ((undefinedObject == null) ? 0 : undefinedObject.hashCode());
 		return result;
 	}
 
@@ -201,6 +234,12 @@ public boolean equals(Object obj) {
 				return false;
 		} else if (!excluded.equals(other.excluded))
 			return false;
+		if (undefinedObject == null) {
+			if (!getUndefinedObject().equals(other.getUndefinedObject())) {
+				return false;
+			}
+		} else if (!undefinedObject.equals(other.undefinedObject))
+			return false;
 		return true;
 	}