Implement Custom Messages (#56)

Author: rcosta358

README.md

@@ -25,7 +25,7 @@ To set up the extension locally, install the LiquidJava extension in the [VS Cod
 <dependency>
     <groupId>io.github.liquid-java</groupId>
     <artifactId>liquidjava-api</artifactId>
-    <version>0.0.3</version>
+    <version>0.0.4</version>
 </dependency>
 ```
 
@@ -36,7 +36,7 @@ repositories {
 }
 
 dependencies {
-    implementation 'io.github.liquid-java:liquidjava-api:0.0.3'
+    implementation 'io.github.liquid-java:liquidjava-api:0.0.4'
 }
 ```
 

client/README.md

@@ -22,7 +22,7 @@ Additionally, to use LiquidJava in your project, you'll need the following depen
 <dependency>
     <groupId>io.github.liquid-java</groupId>
     <artifactId>liquidjava-api</artifactId>
-    <version>0.0.3</version>
+    <version>0.0.4</version>
 </dependency>
 ```
 
@@ -33,7 +33,7 @@ repositories {
 }
 
 dependencies {
-    implementation 'io.github.liquid-java:liquidjava-api:0.0.3'
+    implementation 'io.github.liquid-java:liquidjava-api:0.0.4'
 }
 ```
 

client/server/language-server-liquidjava.jar

@@ -67,6 +67,7 @@ export type RefinementError = BaseDiagnostic & {
     translationTable: TranslationTable;
     expected: ValDerivationNode;
     found: ValDerivationNode;
+    customMessage: string;
 }
 
 export type StateConflictError = BaseDiagnostic & {
@@ -82,6 +83,7 @@ export type StateRefinementError = BaseDiagnostic & {
     translationTable: TranslationTable;
     expected: string;
     found: string;
+    customMessage: string;
 }
 
 export type ArgumentMismatchError = BaseDiagnostic & {

client/src/types/diagnostics.ts

@@ -30,10 +30,12 @@ export function renderErrors(errors: LJError[], expandedErrors: Set<number>): st
 
 const errorContentRenderers: Partial<Record<LJError['type'], (error: LJError) => string>> = {
     'refinement-error': (e: RefinementError) => /*html*/`
+        ${e.customMessage ? renderSection('Message', e.customMessage) : ''}
         ${renderSection('Expected', e.expected.value)}
         ${renderCustomSection('Found', renderDerivationNode(e, e.found))}
     `,
     'state-refinement-error': (e: StateRefinementError) => /*html*/`
+        ${e.customMessage ? renderSection('Message', e.customMessage) : ''}
         ${renderSection('Expected', e.expected)}
         ${renderSection('Found', e.found)}
     `,

client/src/webview/views/verification/errors.ts

@@ -9,6 +9,18 @@
       "end": "\\)",
       "name": "meta.annotation.refinement.liquidjava",
       "patterns": [
+        {
+          "begin": "\\b(msg)\\s*=\\s*(\")",
+          "beginCaptures": {
+            "1": { "name": "variable.parameter.annotation.liquidjava" },
+            "2": { "name": "string.quoted.double.java" }
+          },
+          "end": "\"",
+          "endCaptures": {
+            "0": { "name": "string.quoted.double.java" }
+          },
+          "contentName": "string.quoted.double.java"
+        },
         {
           "begin": "\"",
           "end": "\"",
@@ -33,6 +45,18 @@
           "match": "\\b(from|to)\\b",
           "name": "variable.parameter.annotation.liquidjava"
         },
+        {
+          "begin": "\\b(msg)\\s*=\\s*(\")",
+          "beginCaptures": {
+            "1": { "name": "variable.parameter.annotation.liquidjava" },
+            "2": { "name": "string.quoted.double.java" }
+          },
+          "end": "\"",
+          "endCaptures": {
+            "0": { "name": "string.quoted.double.java" }
+          },
+          "contentName": "string.quoted.double.java"
+        },
         {
           "begin": "\"",
           "end": "\"",

client/syntaxes/liquidjava.json

@@ -179,7 +179,7 @@
 		<dependency>
 			<groupId>io.github.liquid-java</groupId>
 			<artifactId>liquidjava-verifier</artifactId>
-			<version>0.0.11</version>
+			<version>0.0.12</version>
 		</dependency>
 		<dependency>
 			<groupId>tools.aqua</groupId>

server/pom.xml

@@ -9,10 +9,10 @@
  * DTO for serializing RefinementError instances to JSON
  */
 public record RefinementErrorDTO(String category, String type, String title, String message, String file, ErrorPosition position,
-        TranslationTableDTO translationTable, ValDerivationNode expected, ValDerivationNode found) {
+        TranslationTableDTO translationTable, ValDerivationNode expected, ValDerivationNode found, String customMessage) {
 
     public static RefinementErrorDTO from(RefinementError error) {
         return new RefinementErrorDTO("error", "refinement-error", error.getTitle(), error.getMessage(), error.getFile(),
-                error.getPosition(), TranslationTableDTO.from(error.getTranslationTable()), error.getExpected(), error.getFound());
+                error.getPosition(), TranslationTableDTO.from(error.getTranslationTable()), error.getExpected(), error.getFound(), error.getCustomMessage());
     }
 }

server/src/main/java/dtos/errors/RefinementErrorDTO.java

@@ -8,11 +8,11 @@
  * DTO for serializing StateRefinementError instances to JSON
  */
 public record StateRefinementErrorDTO(String category, String type, String title, String message, String file, ErrorPosition position,
-        TranslationTableDTO translationTable, String expected, String found) {
+        TranslationTableDTO translationTable, String expected, String found, String customMessage) {
 
     public static StateRefinementErrorDTO from(StateRefinementError error) {
         return new StateRefinementErrorDTO("error", "state-refinement-error", error.getTitle(), error.getMessage(), error.getFile(),
                 error.getPosition(), TranslationTableDTO.from(error.getTranslationTable()), error.getExpected(),
-                error.getFound());
+                error.getFound(), error.getCustomMessage());
     }
 }