Introduce legend concept tree (finos#71)

* Introduce legend concept tree * Move commands to constants * Introduce constant for legend language id * Fix licence check
goldmansachs · Jun 3, 2024 · ccbdae6 · ccbdae6
1 parent 9604940
commit ccbdae6
Show file tree

Hide file tree

Showing 8 changed files with 559 additions and 11 deletions.
diff --git a/icons/legend.svg b/icons/legend.svg
diff --git a/license-check-and-add-config.json b/license-check-and-add-config.json
@@ -1,5 +1,5 @@
 {
-  "ignore": ["*.json", ".vscode-test", "lib", ".github", "*.vsix", "server", "*"],
+  "ignore": ["*.json", "icons/*.svg", "build", ".vscode-test", "lib", ".github", "*.vsix", "server", "*"],
   "license": "./scripts/copyright/COPYRIGHT_HEADER.txt",
   "licenseFormats": {
     "ts": {

diff --git a/package.json b/package.json
@@ -18,9 +18,22 @@
           "title": "Results",
           "icon": ""
         }
+      ],
+      "activitybar": [
+        {
+          "id": "legend-activity-bar-menu",
+          "title": "Legend",
+          "icon": "./icons/legend.svg"
+        }
       ]
     },
     "views": {
+      "legend-activity-bar-menu": [
+        {
+          "id": "legendConceptTree",
+          "name": "Concept Tree"
+        }
+      ],
       "resultsViewContainer": [
         {
           "id": "executionView",
@@ -43,7 +56,11 @@
         "view": "executionView",
         "contents": "Execution in progress...",
         "when": "isExecutionHappening"
-      }
+      },
+      {
+        "view": "legendConceptTree",
+        "contents": "[Load](command:legend.conceptTree.refresh) Legend concpets."
+      }  
     ],
     "commands": [
       {
@@ -53,14 +70,34 @@
       },
       {
         "command": "legend.extension.output",
-        "title": "Show Legend Extension Output",
+        "title": "Show Extension Output",
         "category": "Legend"
       },
       {
         "command": "legend.reload",
-        "title": "Reload Legend Extension",
+        "title": "Reload Extension",
         "category": "Legend"
-      }
+      },
+      {
+        "command": "legend.conceptTree.show",
+        "title": "Show In Concept Tree",
+        "category": "Legend"  
+      },      
+      {
+        "command": "legend.conceptTree.navigate",
+        "title": "GoTo",
+        "icon": "$(go-to-file)"        
+      },
+      {
+        "command": "legend.conceptTree.focusOnElement",
+        "title": "Focus Current Concept",
+        "icon": "$(target)"
+      },         
+      {
+        "command": "legend.conceptTree.refresh",
+        "title": "Refresh",
+        "icon": "$(refresh)"
+      }      
     ],
     "configuration": {
       "type": "object",
@@ -113,7 +150,11 @@
         "id": "legend",
         "extensions": [
           ".pure"
-        ]
+        ],
+        "icon": {
+          "dark": "./icons/legend.svg",
+          "light": "./icons/legend.svg"
+        }        
       }
     ],
     "grammars": [
@@ -130,7 +171,54 @@
           "title": "Legend REPL (Beta)"
         }
       ]
-    }
+    },
+    "menus": {
+      "view/item/context": [
+        {
+          "command": "legend.conceptTree.navigate",
+          "when": "view == legendConceptTree && viewItem != package",
+          "group": "inline"
+        }    
+      ],
+      "view/title": [
+        {
+          "command": "legend.conceptTree.focusOnElement",
+          "when": "view == legendConceptTree",
+          "group": "navigation"
+        },
+        {
+            "command": "legend.conceptTree.refresh",
+            "when": "view == legendConceptTree",
+            "group": "navigation"
+        }
+      ],
+      "editor/context": [
+        {
+          "group": "Legend",
+          "submenu": "legend.editor.context",
+          "when": "editorTextFocus && editorLangId == legend"
+        }  
+      ],
+      "legend.editor.context": [
+        {
+          "group": "Legend",
+          "command": "legend.conceptTree.show"
+        }  
+      ]
+    },
+    "submenus": [
+      {
+          "id": "legend.editor.context",
+          "label": "Legend"
+      }
+    ],
+    "keybindings":[
+      {
+        "command": "legend.conceptTree.show",
+        "key": "ctrl+shift+l",
+        "mac": "shift+cmd+l"
+      }
+    ] 
   },
   "scripts": {
     "test": "npm run build && node ./lib/tests/runTest.js",

diff --git a/src/LegendLanguageClient.ts b/src/LegendLanguageClient.ts
@@ -23,12 +23,25 @@ import {
   TEST_CASES_REQUEST_ID,
   EXECUTE_TESTS_REQUEST_ID,
   VIRTUAL_FILE_SYSTEM_FILE_REQUEST_ID,
+  ENTITIES_REQUEST_ID,
 } from './utils/Const';
 import type { PlainObject } from './utils/SerializationUtils';
-import { LanguageClient } from 'vscode-languageclient/node';
+import {
+  LanguageClient,
+  type TextDocumentIdentifier,
+} from 'vscode-languageclient/node';
 import type { LegendTest } from './model/LegendTest';
 import type { ExecuteTestRequest } from './model/ExecuteTestRequest';
 import type { LegendTestExecutionResult } from './model/LegendTestExecutionResult';
+import { LegendEntity } from './model/LegendEntity';
+
+export class LegendEntitiesRequest {
+  private textDocuments!: TextDocumentIdentifier[];
+
+  constructor(textDocuments: TextDocumentIdentifier[]) {
+    this.textDocuments = textDocuments;
+  }
+}
 
 export class LegendLanguageClient extends LanguageClient {
   async sendTDSRequest(
@@ -80,4 +93,28 @@ export class LegendLanguageClient extends LanguageClient {
       return this.sendRequest(EXECUTE_TESTS_REQUEST_ID, uri.toString());
     }
   }
+
+  async entities(
+    request: LegendEntitiesRequest,
+    token?: CancellationToken,
+  ): Promise<LegendEntity[]> {
+    let promise: Promise<PlainObject<LegendTestExecutionResult>[]>;
+
+    if (token) {
+      promise = this.sendRequest<PlainObject<LegendTestExecutionResult>[]>(
+        ENTITIES_REQUEST_ID,
+        request,
+        token,
+      );
+    } else {
+      promise = this.sendRequest<PlainObject<LegendTestExecutionResult>[]>(
+        ENTITIES_REQUEST_ID,
+        request,
+      );
+    }
+
+    return promise.then((res) =>
+      res.map((x) => LegendEntity.serialization.fromJson(x)),
+    );
+  }
 }