feat(cli): Support using LSP workspace folder as default project root for the LSP server. (#269)

* feat(cli): Support using LSP workspace folder as default project root

* docs.

* Auto generate docs

* remove duplicate CI runs

---------

Co-authored-by: Davidyz <[email protected]>

Author: Davidyz

.github/workflows/panvimdoc.yml

@@ -1,7 +1,6 @@
 name: panvimdoc
 
 on: 
-  push:
   pull_request:
 
 permissions:

doc/VectorCode-cli.txt

@@ -808,8 +808,11 @@ Note that:
 1. For easier parsing, `--pipe` is assumed to be enabled in LSP mode;
 2. A `vectorcode.lock` file will be created in your `db_path` directory **if you’re using the bundled chromadb server**. Please do not delete it while a
 vectorcode process is running;
-3. The LSP server supports `vectorise`, `query` and `ls` subcommands. The other
-subcommands may be added in the future.
+3. The LSP server supports `vectorise`, `query`, `ls` and `files` subcommands. The other
+subcommands may be added in the future;
+4. If the `--project_root` parameter is not provided, the LSP server will try to use the
+workspace folders <https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#workspace_workspaceFolders>
+provided by the LSP client as the project root (if available).
 
 
 MCP SERVER ~

docs/cli.md

@@ -730,8 +730,11 @@ Note that:
 2. A `vectorcode.lock` file will be created in your `db_path` directory __if
    you're using the bundled chromadb server__. Please do not delete it while a
    vectorcode process is running;
-3. The LSP server supports `vectorise`, `query` and `ls` subcommands. The other
-   subcommands may be added in the future.
+3. The LSP server supports `vectorise`, `query`, `ls` and `files` subcommands. The other
+   subcommands may be added in the future;
+4. If the `--project_root` parameter is not provided, the LSP server will try to use the 
+   [workspace folders](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#workspace_workspaceFolders)
+   provided by the LSP client as the project root (if available).
 
 ### MCP Server
 

src/vectorcode/lsp_main.py

@@ -7,6 +7,7 @@
 import traceback
 import uuid
 from typing import cast
+from urllib.parse import urlparse
 
 import shtab
 from chromadb.types import Where
@@ -88,6 +89,15 @@ async def execute_command(ls: LanguageServer, args: list[str]):
         parsed_args = await parse_cli_args(args)
         logger.info("Parsed command arguments: %s", parsed_args)
         if parsed_args.project_root is None:
+            workspace_folders = ls.workspace.folders
+            if len(workspace_folders.keys()) == 1:
+                _, workspace_folder = workspace_folders.popitem()
+                lsp_dir = urlparse(workspace_folder.uri).path
+                if os.path.isdir(lsp_dir):
+                    logger.debug(f"Using LSP workspace {lsp_dir} as project root.")
+                    DEFAULT_PROJECT_ROOT = lsp_dir
+            elif len(workspace_folders) > 1:  # pragma: nocover
+                logger.info("Too many LSP workspace folders. Ignoring them...")
             if DEFAULT_PROJECT_ROOT is not None:
                 parsed_args.project_root = DEFAULT_PROJECT_ROOT
                 logger.warning("Using DEFAULT_PROJECT_ROOT: %s", DEFAULT_PROJECT_ROOT)

tests/test_lsp.py

@@ -3,6 +3,7 @@
 from unittest.mock import AsyncMock, MagicMock, patch
 
 import pytest
+from lsprotocol.types import WorkspaceFolder
 from pygls.exceptions import JsonRpcInternalError, JsonRpcInvalidRequest
 from pygls.server import LanguageServer
 
@@ -20,6 +21,7 @@ def mock_language_server():
     ls.progress.create_async = AsyncMock()
     ls.progress.begin = MagicMock()
     ls.progress.end = MagicMock()
+    ls.workspace = MagicMock()
     return ls
 
 
@@ -92,7 +94,6 @@ async def test_execute_command_query_default_proj_root(
         patch("builtins.open", MagicMock()) as mock_open,
     ):
         global DEFAULT_PROJECT_ROOT
-
         mock_config.project_root = None
         mock_parse_cli_args.return_value = mock_config
         mock_get_query_result_files.return_value = ["/test/file.txt"]
@@ -115,6 +116,46 @@ async def test_execute_command_query_default_proj_root(
         mock_language_server.progress.end.assert_called()
 
 
+@pytest.mark.asyncio
+async def test_execute_command_query_workspace_dir(mock_language_server, mock_config):
+    workspace_folder = WorkspaceFolder(uri="file:///dummy_dir", name="dummy_dir")
+    with (
+        patch(
+            "vectorcode.lsp_main.parse_cli_args", new_callable=AsyncMock
+        ) as mock_parse_cli_args,
+        patch("vectorcode.lsp_main.ClientManager"),
+        patch("vectorcode.lsp_main.get_collection", new_callable=AsyncMock),
+        patch(
+            "vectorcode.lsp_main.build_query_results", new_callable=AsyncMock
+        ) as mock_get_query_result_files,
+        patch("os.path.isfile", return_value=True),
+        patch("os.path.isdir", return_value=True),
+        patch("builtins.open", MagicMock()) as mock_open,
+    ):
+        mock_language_server.workspace = MagicMock()
+        mock_language_server.workspace.folders = {"dummy_dir": workspace_folder}
+        mock_config.project_root = None
+        mock_parse_cli_args.return_value = mock_config
+        mock_get_query_result_files.return_value = ["/test/file.txt"]
+
+        # Configure the MagicMock object to return a string when read() is called
+        mock_file = MagicMock()
+        mock_file.__enter__.return_value.read.return_value = "{}"  # Return valid JSON
+        mock_open.return_value = mock_file
+
+        # Mock the merge_from method
+        mock_config.merge_from = AsyncMock(return_value=mock_config)
+
+        result = await execute_command(mock_language_server, ["query", "test"])
+
+        assert isinstance(result, list)
+        mock_language_server.progress.begin.assert_called()
+        mock_language_server.progress.end.assert_called()
+        assert (
+            mock_get_query_result_files.call_args.args[1].project_root == "/dummy_dir"
+        )
+
+
 @pytest.mark.asyncio
 async def test_execute_command_ls(mock_language_server, mock_config):
     mock_config.action = CliAction.ls