hover show detail feature + minor bug fix #1

vkameswaran · 2024-05-02T18:00:33Z

Shows details on hover: gives class name + variable values for instances and assigned value for variables. Minor bug fix for when bracket is in a word.

Greptile Summary

Introduced hover feature to display class names and variable values
Fixed bug for handling brackets within words
Added hoverProvider capability in package.json
New utility function remove_special_character for text cleanup

greptile-apps-local

Pull Request Summary

Hover Feature: Introduces a hover feature that displays class names and variable values for instances, as well as assigned values for variables.
Bug Fix: Fixes a minor bug related to handling brackets within words.
Utility Function: Adds a new utility function remove_special_character to support the hover feature by cleaning up class names or variable values.
Extension Configuration: Updates package.json to add the hoverProvider capability, enabling the new hover information feature.

Notes

The new utility function remove_special_character could be reused in other parts of the codebase where similar string cleaning is required.

greptile-apps-local · 2024-05-23T01:18:07Z

src/vscode-atopile/bundled/tool/lsp_server.py

+@LSP_SERVER.feature(lsp.TEXT_DOCUMENT_HOVER)
+def hover_definition(params: lsp.HoverParams) -> Optional[lsp.Hover]:
+    if not params.text_document.uri.startswith("file://"):
+        return lsp.CompletionList(is_incomplete=False, items=[])


Returning lsp.CompletionList in a hover handler is incorrect. It should return None instead.

greptile-apps

Pull Request Summary

Hover Feature Enhancement: Introduces a new hover feature that displays class names and variable values for instances, and assigned values for variables, enhancing the user experience with more detailed information.
Bug Fix: Addresses a minor bug related to handling brackets within words, improving overall text processing.
Utility Function Addition: Adds remove_special_character in lsp_utils.py to clean up words by removing specific special characters, supporting the hover feature and bug fix.
Extension Capability Update: Updates package.json to include hoverProvider capability, integrating the new hover feature into the extension.

Notes:

The new utility function remove_special_character could be reused in other text processing features for consistency.

greptile-apps · 2024-05-23T01:23:54Z

src/vscode-atopile/bundled/tool/lsp_server.py

+@LSP_SERVER.feature(lsp.TEXT_DOCUMENT_HOVER)
+def hover_definition(params: lsp.HoverParams) -> Optional[lsp.Hover]:
+    if not params.text_document.uri.startswith("file://"):
+        return lsp.CompletionList(is_incomplete=False, items=[])


Returning lsp.CompletionList for hover feature is incorrect. It should return None instead.

greptile-apps · 2024-05-23T01:23:54Z

src/vscode-atopile/package.json

@@ -39,7 +39,8 @@
        "virtualWorkspaces": {
            "supported": false,
            "description": "Virtual Workspaces are not supported with atopile."
-        }
+        },
+        "hoverProvider" : "true"


The value for hoverProvider should be a boolean. Change "true" to true.

greptile-apps-local · 2024-05-27T21:54:43Z

src/vscode-atopile/bundled/tool/lsp_server.py

+        pass
+    else:
+        # TODO: deal with assignments made to super
+        output_str += f"**class**: {str(atopile.address.get_name(instance.supers[0].address))}\n\n"


Consider handling cases where instance.supers might be empty.

greptile-apps-local · 2024-05-27T21:55:05Z

src/vscode-atopile/bundled/tool/lsp_utils.py

+def remove_special_character(word: str) -> str:
+    return "".join(e for e in word if e not in "(){}")
+


Consider adding a docstring to explain the purpose and usage of this function.

hover show detail feature + minor bug fix

d7f83e1