feat(server): show evaluated node value in the hover message

server/src/context.ts

@@ -5,6 +5,7 @@ import {
   TextDocuments,
 } from "vscode-languageserver/node.js";
 import * as TSParser from "tree-sitter";
+import Engine from "publicodes";
 
 export type GlobalConfig = {
   hasConfigurationCapability: boolean;
@@ -77,6 +78,8 @@ export type LSContext = {
   fileInfos: Map<FilePath, FileInfos>;
   diagnostics: Diagnostic[];
 
+  engine: Engine<string>;
+
   // TODO: maybe to remove
   ruleToFileNameMap: Map<DottedName, FilePath>;
   fileNameToRulesMap: Map<FilePath, DottedName[]>;

server/src/onHover.ts

@@ -2,6 +2,7 @@ import { HandlerResult, Hover, HoverParams } from "vscode-languageserver";
 import { LSContext } from "./context";
 import { getFullRefName } from "./treeSitter";
 import { fileURLToPath } from "url";
+import { serializeEvaluation, serializeUnit } from "publicodes";
 
 export default function (ctx: LSContext) {
   return (params: HoverParams): HandlerResult<Hover, void> => {
@@ -31,24 +32,19 @@ export default function (ctx: LSContext) {
     switch (node.type) {
       case "name": {
         try {
-          // TODO: could be extracted to an helper?
           const fullRefName = getFullRefName(
             ctx,
             fileURLToPath(textDocument.uri),
             node,
           );
 
           const rawRule = ctx.rawPublicodesRules[fullRefName];
+          const nodeValue = ctx.engine.evaluate(fullRefName);
 
-          const value =
-            `## ${rawRule?.titre ?? fullRefName}\n\n` +
-            Object.entries(rawRule ?? {})
-              .map(([key, value]) => {
-                if (key !== "titre") {
-                  return `### ${key}\n\n${value}`;
-                }
-              })
-              .join("\n\n");
+          // TODO: polish the hover message
+          const value = `**${rawRule?.titre ?? fullRefName}** (${serializeEvaluation(nodeValue)})
+${rawRule?.description ? `\n### Description\n\n${rawRule.description}\n\n` : ""}
+${rawRule?.note ? `### Note\n\n${rawRule.note}` : ""}`;
 
           return {
             contents: {
@@ -63,14 +59,6 @@ export default function (ctx: LSContext) {
           break;
         }
       }
-      default: {
-        return {
-          contents: {
-            kind: "markdown",
-            value: `(${node.type})`,
-          },
-        };
-      }
     }
   };
 }

server/src/server.ts

@@ -19,6 +19,7 @@ import validate from "./validate";
 import onDefinitionHandler from "./onDefinition";
 import onHoverHandler from "./onHover";
 import { semanticTokensFullProvider } from "./semanticTokens";
+import Engine from "publicodes";
 
 let ctx: LSContext = {
   // Create a connection for the server, using Node's IPC as a transport.
@@ -36,6 +37,7 @@ let ctx: LSContext = {
     hasWorkspaceFolderCapability: false,
     hasDiagnosticRelatedInformationCapability: false,
   },
+  engine: new Engine({}),
   fileInfos: new Map(),
   diagnostics: [],
   ruleToFileNameMap: new Map(),

server/src/validate.ts

@@ -1,7 +1,7 @@
 import { TextDocument } from "vscode-languageserver-textdocument";
 import { LSContext } from "./context";
 import Engine from "publicodes";
-import { Diagnostic, DiagnosticSeverity } from "vscode-languageserver/node.js";
+import { DiagnosticSeverity } from "vscode-languageserver/node.js";
 import { parseDocument } from "./parseRules";
 import { fileURLToPath, pathToFileURL } from "node:url";
 
@@ -56,8 +56,8 @@ export default async function validate(
     ctx.connection.console.log(
       `[validate] Parsing ${Object.keys(ctx.rawPublicodesRules).length} rules`,
     );
-    const engine = new Engine(ctx.rawPublicodesRules);
-    ctx.parsedRules = engine.getParsedRules();
+    ctx.engine = new Engine(ctx.rawPublicodesRules);
+    ctx.parsedRules = ctx.engine.getParsedRules();
     ctx.connection.console.log(
       `[validate] Parsed ${Object.keys(ctx.parsedRules).length} rules`,
     );