GH-1642: moved stereotype definition locoation to inline action in the tree view and switched the locaiton information to a dedicated attribute

Author: martinlippert

headless-services/spring-boot-language-server/src/main/java/org/springframework/ide/vscode/boot/java/commands/JsonNodeHandler.java

@@ -29,8 +29,6 @@
 
 import org.eclipse.lsp4j.DocumentSymbol;
 import org.eclipse.lsp4j.Location;
-import org.eclipse.lsp4j.Position;
-import org.eclipse.lsp4j.Range;
 import org.jmolecules.stereotype.api.Stereotype;
 import org.jmolecules.stereotype.catalog.StereotypeCatalog;
 import org.jmolecules.stereotype.tooling.LabelProvider;
@@ -52,6 +50,7 @@
 public class JsonNodeHandler<A, C> implements NodeHandler<A, StereotypePackageElement, StereotypeClassElement, StereotypeMethodElement, C> {
 
 	private static final String LOCATION = "location";
+	private static final String REFERENCE = "reference";
 
 	public static final String ICON = "icon";
 	public static final String TEXT = "text";
@@ -88,27 +87,26 @@ public void handleStereotype(Stereotype stereotype, NodeContext context) {
 			var definition = catalog.getDefinition(stereotype);
 			var sources = definition.getSources();
 
-			Location location = null;
+			String reference = null;
 			for (Object source : sources) {
 				if (source instanceof URL) {
 					try {
-						String uri = ((URL)source).toURI().toString();
-						location = new Location(uri, new Range(new Position(0, 0), new Position(0, 0)));
+						reference = ((URL)source).toURI().toASCIIString();
 					} catch (URISyntaxException e) {
 						// ignore
 					}
 				}
 				else if (source instanceof Location) {
-					location = ((Location) source);
+					reference = ((Location) source).getUri();
 				}
 			}
 
-			final Location finalLocation = location;
+			final String referenceUri = reference;
 			addChild(node -> node
 				.withAttribute(TEXT, labels.getStereotypeLabel(stereotype))
 				.withAttribute(ICON, StereotypeIcons.getIcon(stereotype))
 				.withAttribute(HOVER, "defined in: " + sources.toString())
-				.withAttribute(LOCATION, finalLocation)
+				.withAttribute(REFERENCE, referenceUri)
 			);
 		}
 	}

vscode-extensions/vscode-spring-boot/lib/Main.ts

@@ -187,7 +187,16 @@ export function activate(context: ExtensionContext): Thenable<ExtensionAPI> {
         const structureManager = new StructureManager();
         const explorerTreeProvider = new ExplorerTreeProvider(structureManager);
         context.subscriptions.push(window.createTreeView('explorer.spring', { treeDataProvider: explorerTreeProvider, showCollapseAll: true }));
-        context.subscriptions.push(commands.registerCommand("vscode-spring-boot.structure.refresh", () => structureManager.refresh(true))); 
+        context.subscriptions.push(commands.registerCommand("vscode-spring-boot.structure.refresh", () => structureManager.refresh(true)));
+        context.subscriptions.push(commands.registerCommand("vscode-spring-boot.structure.openReference", (node) => {
+            if (node && node.getReferenceValue) {
+                const reference = node.getReferenceValue();
+                if (reference) {
+                    // Reference is a specific URL that should be passed to java.open.file command
+                    commands.executeCommand('java.open.file', reference);
+                }
+            }
+        })); 
 
         context.subscriptions.push(commands.registerCommand('vscode-spring-boot.ls.start', () => client.start().then(() => {
             // Boot LS is fully started

vscode-extensions/vscode-spring-boot/lib/explorer/nodes.ts

@@ -20,6 +20,12 @@ export class StereotypedNode extends SpringNode {
         const item = super.getTreeItem();
         item.label = this.n.attributes.text;
         item.iconPath = this.computeIcon();
+        
+        // Add context value if reference attribute exists
+        if (this.n.attributes.reference) {
+            item.contextValue = "stereotypedNodeWithReference";
+        }
+        
         if (this.n.attributes.location) {
             const location = this.n.attributes.location as Location;
             // Hard-coded range. Not present... likely not serialized correctly.
@@ -34,6 +40,10 @@ export class StereotypedNode extends SpringNode {
         return item;
     }
 
+    getReferenceValue(): any {
+        return this.n.attributes.reference;
+    }
+
     computeIcon() {
         return new ThemeIcon(this.n.attributes.icon);
 /*        switch (this.n.attributes.icon) {

vscode-extensions/vscode-spring-boot/package.json

@@ -203,6 +203,13 @@
           "command": "vscode-spring-boot.live.hide.active",
           "group": "Spring Boot"
         }
+      ],
+      "view/item/context": [
+        {
+          "command": "vscode-spring-boot.structure.openReference",
+          "when": "view == explorer.spring && viewItem == stereotypedNodeWithReference",
+          "group": "inline"
+        }
       ]
     },
     "commands": [
@@ -296,6 +303,12 @@
         "title": "Apply Changes",
         "category": "Spring Boot Agent",
         "enablement": "false"
+      },
+      {
+        "command": "vscode-spring-boot.structure.openReference",
+        "title": "Open Reference",
+        "category": "Spring Boot",
+        "icon": "$(link-external)"
       }
     ],
     "configuration": [