Merge pull request #46 from nolanderc/group-hover-info

groups hover items with the same documentation strings

Author: nolanderc

.github/workflows/pull-request.yml

@@ -21,7 +21,7 @@ jobs:
       - name: Setup Zig
         uses: goto-bus-stop/setup-zig@v2.1.1
         with:
-          version: ${{ ZIG_VERSION }}
+          version: ${{ vars.ZIG_VERSION }}
       - name: Build
         run: zig build -Dtarget=${{ matrix.target }}
   test-pull-request:
@@ -37,7 +37,7 @@ jobs:
       - name: Setup Zig
         uses: goto-bus-stop/setup-zig@v2.1.1
         with:
-          version: ${{ ZIG_VERSION }}
+          version: ${{ vars.ZIG_VERSION }}
       - name: Test
         run: zig build test
 

.github/workflows/release-artifacts.yml

@@ -13,7 +13,7 @@ jobs:
       - name: Setup Zig
         uses: goto-bus-stop/setup-zig@v2.1.1
         with:
-          version: ${{ ZIG_VERSION }}
+          version: ${{ vars.ZIG_VERSION }}
       - name: Build
         run: ./release.sh
       - name: Release

.gitignore

@@ -1,3 +1,4 @@
 zig-out
 zig-cache
 stderr.log
+__pycache__

src/main.zig

@@ -671,21 +671,42 @@ pub const Dispatch = struct {
             .{ .ignore_current = false },
         );
 
-        var text = std.ArrayList(u8).init(state.allocator);
-        defer text.deinit();
+        // group completions by their documentation.
+        var groups = std.StringArrayHashMap(std.ArrayListUnmanaged(*const lsp.CompletionItem))
+            .init(symbol_arena.allocator());
+        defer groups.deinit();
 
         for (completions.items) |*completion| {
-            if (std.mem.eql(u8, completion.label, token_text)) {
-                if (text.items.len != 0) {
-                    try text.appendSlice("\n\n---\n\n");
-                }
-                if (completion.detail) |detail| {
-                    try text.writer().print("```glsl\n{s}\n```", .{detail});
-                }
-                if (completion.documentation) |docs| {
-                    try text.appendSlice("\n\n");
-                    try text.appendSlice(docs.value);
+            if (!std.mem.eql(u8, completion.label, token_text)) continue;
+
+            const documentation_string = if (completion.documentation) |markup| markup.value else "";
+
+            const result = try groups.getOrPut(documentation_string);
+            if (!result.found_existing) result.value_ptr.* = .{};
+            try result.value_ptr.append(symbol_arena.allocator(), completion);
+        }
+
+        var text = std.ArrayList(u8).init(symbol_arena.allocator());
+        defer text.deinit();
+
+        for (groups.keys(), groups.values()) |description, group| {
+            if (text.items.len != 0) {
+                try text.appendSlice("\n\n---\n\n");
+            }
+
+            if (group.items.len != 0) {
+                try text.appendSlice("```glsl\n");
+                for (group.items) |completion| {
+                    if (completion.detail) |detail| {
+                        try text.writer().print("{s}\n", .{detail});
+                    }
                 }
+                try text.appendSlice("```\n");
+            }
+
+            if (description.len != 0) {
+                if (group.items.len != 0) try text.appendSlice("\n");
+                try text.appendSlice(description);
             }
         }