feat: improve error message

Safe-DS · Nov 11, 2023 · 869dfb0 · 869dfb0
1 parent 310a7fb
commit 869dfb0
Show file tree

Hide file tree

Showing 4 changed files with 46 additions and 38 deletions.
diff --git a/packages/safe-ds-lang/src/language/validation/inheritance.ts b/packages/safe-ds-lang/src/language/validation/inheritance.ts
@@ -1,4 +1,4 @@
-import { ValidationAcceptor } from 'langium';
+import { expandToStringWithNL, ValidationAcceptor } from 'langium';
 import { isEmpty } from '../../helpers/collectionUtils.js';
 import { SdsClass, type SdsClassMember } from '../generated/ast.js';
 import { getParentTypes } from '../helpers/nodeProperties.js';
@@ -25,11 +25,19 @@ export const classMemberMustMatchOverriddenMember = (services: SafeDsServices) =
         const overriddenMemberType = typeComputer.computeType(overriddenMember);
 
         if (!typeChecker.isAssignableTo(ownMemberType, overriddenMemberType)) {
-            accept('error', 'Overriding member does not match the overridden member.', {
-                node,
-                property: 'name',
-                code: CODE_INHERITANCE_MUST_MATCH_OVERRIDDEN_MEMBER,
-            });
+            accept(
+                'error',
+                expandToStringWithNL`
+                    Overriding member does not match the overridden member:
+                    - Expected type: ${overriddenMemberType}
+                    - Actual type:   ${ownMemberType}
+                `,
+                {
+                    node,
+                    property: 'name',
+                    code: CODE_INHERITANCE_MUST_MATCH_OVERRIDDEN_MEMBER,
+                },
+            );
         }
     };
 };

diff --git a/packages/safe-ds-lang/tests/language/validation/safe-ds-validator.test.ts b/packages/safe-ds-lang/tests/language/validation/safe-ds-validator.test.ts
@@ -1,12 +1,12 @@
-import { afterEach, beforeEach, describe, it } from 'vitest';
-import { createSafeDsServices } from '../../../src/language/index.js';
-import { NodeFileSystem } from 'langium/node';
-import { createValidationTests, ExpectedIssue } from './creator.js';
-import { Diagnostic, DiagnosticSeverity } from 'vscode-languageserver';
 import { AssertionError } from 'assert';
+import { NodeFileSystem } from 'langium/node';
 import { clearDocuments, isRangeEqual } from 'langium/test';
+import { afterEach, beforeEach, describe, it } from 'vitest';
+import { Diagnostic, DiagnosticSeverity } from 'vscode-languageserver';
+import { createSafeDsServices } from '../../../src/language/index.js';
 import { locationToString } from '../../helpers/location.js';
 import { loadDocuments } from '../../helpers/testResources.js';
+import { createValidationTests, ExpectedIssue } from './creator.js';
 
 const services = createSafeDsServices(NodeFileSystem).SafeDs;
 
@@ -94,7 +94,7 @@ const getMatchingActualIssues = (expectedIssue: ExpectedIssue): Diagnostic[] =>
     // Filter by message
     if (expectedIssue.message) {
         if (expectedIssue.messageIsRegex) {
-            const regex = new RegExp(expectedIssue.message, 'gu');
+            const regex = new RegExp(expectedIssue.message, 'u');
             result = result.filter((d) => regex.test(d.message));
         } else {
             result = result.filter((d) => d.message === expectedIssue.message);

diff --git a/...ources/validation/inheritance/overriding method must match overridden method/main.sdstest b/...ources/validation/inheritance/overriding method must match overridden method/main.sdstest
@@ -9,67 +9,67 @@ class MySuperClass {
 }
 
 class MyClass1 sub MySuperClass {
-    // $TEST$ no error "Overriding member does not match the overridden member."
+    // $TEST$ no error r"Overriding member does not match the overridden member:[\s\S]*"
     attr »myInstanceAttribute«: Int
-    // $TEST$ no error "Overriding member does not match the overridden member."
+    // $TEST$ no error r"Overriding member does not match the overridden member:[\s\S]*"
     static attr »myStaticAttribute«: Int
 
-    // $TEST$ no error "Overriding member does not match the overridden member."
+    // $TEST$ no error r"Overriding member does not match the overridden member:[\s\S]*"
     attr »myInstanceAttribute«: String
-    // $TEST$ no error "Overriding member does not match the overridden member."
+    // $TEST$ no error r"Overriding member does not match the overridden member:[\s\S]*"
     static attr »myStaticAttribute«: String
 
-    // $TEST$ no error "Overriding member does not match the overridden member."
+    // $TEST$ no error r"Overriding member does not match the overridden member:[\s\S]*"
     attr »myOwnInstanceAttribute«: Int
-    // $TEST$ no error "Overriding member does not match the overridden member."
+    // $TEST$ no error r"Overriding member does not match the overridden member:[\s\S]*"
     static attr »myOwnStaticAttribute«: Int
 
 
-    // $TEST$ no error "Overriding member does not match the overridden member."
+    // $TEST$ no error r"Overriding member does not match the overridden member:[\s\S]*"
     fun »myInstanceMethod«(a: Int = 0) -> r: Int
-    // $TEST$ no error "Overriding member does not match the overridden member."
+    // $TEST$ no error r"Overriding member does not match the overridden member:[\s\S]*"
     static fun »myStaticMethod«(a: Int = 0) -> r: Int
 
-    // $TEST$ no error "Overriding member does not match the overridden member."
+    // $TEST$ no error r"Overriding member does not match the overridden member:[\s\S]*"
     fun »myInstanceMethod«() -> r: Int
-    // $TEST$ no error "Overriding member does not match the overridden member."
+    // $TEST$ no error r"Overriding member does not match the overridden member:[\s\S]*"
     static fun »myStaticMethod«() -> r: Int
 
-    // $TEST$ no error "Overriding member does not match the overridden member."
+    // $TEST$ no error r"Overriding member does not match the overridden member:[\s\S]*"
     fun »myOwnInstanceMethod«(a: Int = 0) -> r: Int
-    // $TEST$ no error "Overriding member does not match the overridden member."
+    // $TEST$ no error r"Overriding member does not match the overridden member:[\s\S]*"
     static fun »myOwnStaticMethod«(a: Int = 0) -> r: Int
 }
 
 class MyClass2 sub MySuperClass {
-    // $TEST$ error "Overriding member does not match the overridden member."
+    // $TEST$ error r"Overriding member does not match the overridden member:[\s\S]*"
     attr »myInstanceAttribute«: String
-    // $TEST$ no error "Overriding member does not match the overridden member."
+    // $TEST$ no error r"Overriding member does not match the overridden member:[\s\S]*"
     static attr »myStaticAttribute«: String
 
-    // $TEST$ no error "Overriding member does not match the overridden member."
+    // $TEST$ no error r"Overriding member does not match the overridden member:[\s\S]*"
     attr »myInstanceAttribute«: Int
-    // $TEST$ no error "Overriding member does not match the overridden member."
+    // $TEST$ no error r"Overriding member does not match the overridden member:[\s\S]*"
     static attr »myStaticAttribute«: Int
 
-    // $TEST$ no error "Overriding member does not match the overridden member."
+    // $TEST$ no error r"Overriding member does not match the overridden member:[\s\S]*"
     attr »myOwnInstanceAttribute«: Int
-    // $TEST$ no error "Overriding member does not match the overridden member."
+    // $TEST$ no error r"Overriding member does not match the overridden member:[\s\S]*"
     static attr »myOwnStaticAttribute«: Int
 
 
-    // $TEST$ error "Overriding member does not match the overridden member."
+    // $TEST$ error r"Overriding member does not match the overridden member:[\s\S]*"
     fun »myInstanceMethod«() -> r: Int
-    // $TEST$ no error "Overriding member does not match the overridden member."
+    // $TEST$ no error r"Overriding member does not match the overridden member:[\s\S]*"
     static fun »myStaticMethod«() -> r: Int
 
-    // $TEST$ no error "Overriding member does not match the overridden member."
+    // $TEST$ no error r"Overriding member does not match the overridden member:[\s\S]*"
     fun »myInstanceMethod«(a: Int = 0) -> r: Int
-    // $TEST$ no error "Overriding member does not match the overridden member."
+    // $TEST$ no error r"Overriding member does not match the overridden member:[\s\S]*"
     static fun »myStaticMethod«(a: Int = 0) -> r: Int
 
-    // $TEST$ no error "Overriding member does not match the overridden member."
+    // $TEST$ no error r"Overriding member does not match the overridden member:[\s\S]*"
     fun »myOwnInstanceMethod«(a: Int = 0) -> r: Int
-    // $TEST$ no error "Overriding member does not match the overridden member."
+    // $TEST$ no error r"Overriding member does not match the overridden member:[\s\S]*"
     static fun »myOwnStaticMethod«(a: Int = 0) -> r: Int
 }
diff --git a/...-ds-lang/tests/resources/validation/types/named types/missing type parameter/main.sdstest b/...-ds-lang/tests/resources/validation/types/named types/missing type parameter/main.sdstest
@@ -30,7 +30,7 @@ fun myFunction(
     p7: MyClassWithTwoTypeParameters»<>«,
     // $TEST$ error "The type parameter 'V' must be set here."
     p8: MyClassWithTwoTypeParameters»<Int>«,
-    // $TEST$ no error r"The type parameters? .* must be set here\."
+    // $TEST$ error "The type parameters 'K', 'V' must be set here."
     p9: MyClassWithTwoTypeParameters»<T = Int>«,
 
 
@@ -52,7 +52,7 @@ fun myFunction(
     q7: MyEnum.MyEnumVariantWithTwoTypeParameters»<>«,
     // $TEST$ error "The type parameter 'V' must be set here."
     q8: MyEnum.MyEnumVariantWithTwoTypeParameters»<Int>«,
-    // $TEST$ no error r"The type parameters? .* must be set here\."
+    // $TEST$ error "The type parameters 'K', 'V' must be set here."
     q9: MyEnum.MyEnumVariantWithTwoTypeParameters»<T = Int>«,