Add auto completion of enums

Author: vetlek

server/src/language-service/completionProvider.ts

@@ -251,20 +251,15 @@ export function getObjectCompletion(
             ).map((obj) => xvrToCompletionItem(obj, range))
         );
     }
+    const enums = getEnumCompletions(obj, currentAttr.attr);
+    const completions = [...enums, ...references];
     if (isEndAttribute(offset, currentAttr.attr)) {
+        completions.push(...getObjectAttributeCompletion(obj, offset, doc));
         if (currentAttr.last) {
-            return [
-                ...getObjectAttributeCompletion(obj, offset, doc),
-                ...references,
-                ...snippets,
-            ];
+            completions.push(...snippets);
         }
-        return [
-            ...getObjectAttributeCompletion(obj, offset, doc),
-            ...references,
-        ];
     }
-    return references;
+    return completions;
 }
 
 function getCurrentAttr(
@@ -312,6 +307,7 @@ function getObjectAttributeCompletion(
                 value: formatObjectAttribute(attr),
                 kind: "markdown",
             },
+            sortText: `2${attr.name}`,
             textEdit: TextEdit.replace(rangeNewLine.range, text),
             insertTextMode: InsertTextMode.asIs,
             insertTextFormat: InsertTextFormat.Snippet,
@@ -351,6 +347,28 @@ function isReferenceAttribute(obj: SepticObject, attr: Attribute): boolean {
     return objectInfo.refs.attributes.includes(attr.key);
 }
 
+function getEnumCompletions(obj: SepticObject, attr: Attribute): CompletionItem[] {
+    const objectInfo = SepticMetaInfoProvider.getInstance().getObjectDocumentation(obj.type);
+    if (!objectInfo) {
+        return [];
+    }
+    let attrDoc = objectInfo.attributes.find((a) => a.name === attr.key);
+    if (!attrDoc) {
+        return [];
+    }
+    if (attrDoc.dataType !== "enum") {
+        return [];
+    }
+    return attrDoc.enums.map((value) => {
+        return {
+            label: value,
+            kind: CompletionItemKind.EnumMember,
+            detail: `Enum member of ${attrDoc.name}`,
+            sortText: `1${value}`,
+        };
+    });
+}
+
 function isEndAttribute(offset: number, attr: Attribute): boolean {
     return offset >= attr.end;
 }
@@ -419,7 +437,7 @@ const priorityMapping: { [key: string]: number } = {
     "Tvr": 5,
 };
 
-function xvrToCompletionItem(obj: SepticObject, range: Range): CompletionItem {    
+function xvrToCompletionItem(obj: SepticObject, range: Range): CompletionItem {
     let priority = priorityMapping[obj.type] ?? 6;
     return {
         label: obj.identifier!.name,

server/src/septic/septicMetaInfo.ts

@@ -224,6 +224,7 @@ export class SepticMetaInfoProvider {
                     .join("\n"),
                 insertTextMode: InsertTextMode.asIs,
                 detail: obj.description,
+                sortText: `3${obj.prefix}`,
             };
             return compItem;
         });

server/src/test/completion.test.ts

@@ -219,7 +219,7 @@ describe("Test completion of object attributes", () => {
 
 describe("Test completion of attribute with references to xvrs", () => {
     it("Expect Xvrs for attribute that references Xvrs", () => {
-        const content = loadFile("completionAttrRefs.cnfg");
+        const content = loadFile("completion/completionAttrRefs.cnfg");
         const doc = TextDocument.create("", "", 0, content);
         const cnfg = parseSepticSync(doc.getText());
         const offset = doc.offsetAt(Position.create(13, 28));
@@ -230,7 +230,7 @@ describe("Test completion of attribute with references to xvrs", () => {
         expect(variableCompItems.length).to.equal(2);
     });
     it("Expect Mvrs for attribute that references Mvrs", () => {
-        const content = loadFile("completionAttrRefs.cnfg");
+        const content = loadFile("completion/completionAttrRefs.cnfg");
         const doc = TextDocument.create("", "", 0, content);
         const cnfg = parseSepticSync(doc.getText());
         const offset = doc.offsetAt(Position.create(17, 19));
@@ -242,7 +242,7 @@ describe("Test completion of attribute with references to xvrs", () => {
         expect(variableCompItems[0].label).to.equal("MvrTest");
     });
     it("Expect completion of xvr in-between existing attr values", () => {
-        const content = loadFile("completionAttrRefs.cnfg");
+        const content = loadFile("completion/completionAttrRefs.cnfg");
         const doc = TextDocument.create("", "", 0, content);
         const cnfg = parseSepticSync(doc.getText());
         const offset = doc.offsetAt(Position.create(27, 20));
@@ -253,7 +253,7 @@ describe("Test completion of attribute with references to xvrs", () => {
         expect(variableCompItems.length).to.equal(2);
     });
     it("Expect no completion of xvr non-reference attribute", () => {
-        const content = loadFile("completionAttrRefs.cnfg");
+        const content = loadFile("completion/completionAttrRefs.cnfg");
         const doc = TextDocument.create("", "", 0, content);
         const cnfg = parseSepticSync(doc.getText());
         const offset = doc.offsetAt(Position.create(20, 20));
@@ -265,6 +265,21 @@ describe("Test completion of attribute with references to xvrs", () => {
     });
 });
 
+describe("Test completion of attribute enum datatype", () => {
+    it("Expect Xvrs for attribute that references Xvrs", () => {
+        const content = "Evr: TestEvr\nUserInput=  \n";
+        const doc = TextDocument.create("", "", 0, content);
+        const cnfg = parseSepticSync(doc.getText());
+        const offset = doc.offsetAt(Position.create(1, 11));
+        const compItems = getObjectCompletion(offset, cnfg, cnfg, doc);
+        const variableCompItems = compItems.filter(
+            (item) => item.kind === CompletionItemKind.EnumMember
+        );
+        const enums = SepticMetaInfoProvider.getInstance().getObjectDocumentation("Evr")?.attributes.find(attr => attr.name === "UserInput")?.enums;
+        expect(variableCompItems.length).to.equal(enums?.length);
+    });
+});
+
 describe("Test calc completion", () => {
     it("Completion suggest Xvrs", () => {
         const text = `Mvr: TestMvr\nEvr:   TestEvr\nCalcPvr: TestCalc\nAlg= "  "\n`;