add new option to enable/disable analysing unused references

Author: d-biehl

package.json

@@ -461,6 +461,12 @@
             "markdownDescription": "Enables 'robotidy' code formatting, if installed. See [robotidy](https://github.com/MarketSquare/robotframework-tidy)",
             "scope": "resource"
           },
+          "robotcode.analysis.findUnusedReferences": {
+            "type": "boolean",
+            "default": false,
+            "markdownDescription": "Find and reports unused keyword and variable references.",
+            "scope": "resource"
+          },
           "robotcode.analysis.diagnosticMode": {
             "type": "string",
             "enum": [

robotcode/language_server/common/parts/diagnostics.py

@@ -82,6 +82,7 @@ def __init__(self, protocol: LanguageServerProtocol) -> None:
         super().__init__(protocol)
 
         self.workspace_loaded_event = Event()
+
         self._workspace_load_lock = Lock()
         self._workspace_loaded = False
 
@@ -92,7 +93,6 @@ def __init__(self, protocol: LanguageServerProtocol) -> None:
         self._current_workspace_task: Optional[asyncio.Task[WorkspaceDiagnosticReport]] = None
 
         self.in_get_workspace_diagnostics = Event(True)
-        self._collect_full_diagnostics = False
 
     def extend_capabilities(self, capabilities: ServerCapabilities) -> None:
         if (
@@ -107,15 +107,6 @@ def extend_capabilities(self, capabilities: ServerCapabilities) -> None:
                 work_done_progress=True,
             )
 
-    @property
-    def collect_full_diagnostics(self) -> bool:
-        return self._collect_full_diagnostics
-
-    async def set_collect_full_diagnostics(self, value: bool) -> None:
-        if self._collect_full_diagnostics != value:
-            self._collect_full_diagnostics = value
-            await self.refresh()
-
     @async_tasking_event_iterator
     async def collect(sender, document: TextDocument, full: bool) -> DiagnosticsResult:  # NOSONAR
         ...
@@ -216,8 +207,6 @@ async def _text_document_diagnostic(
         self._logger.debug(lambda: f"textDocument/diagnostic for {text_document}")
 
         try:
-            # await self.ensure_workspace_loaded()
-
             document = await self.parent.documents.get(text_document.uri)
             if document is None:
                 raise JsonRPCErrorException(ErrorCodes.INVALID_PARAMS, f"Document {text_document!r} not found")
@@ -274,13 +263,6 @@ async def _get_diagnostics() -> WorkspaceDiagnosticReport:
             result: List[WorkspaceDocumentDiagnosticReport] = []
 
             for doc in self.parent.documents.documents:
-                if self._current_workspace_task is None:
-                    raise JsonRPCErrorException(
-                        ErrorCodes.SERVER_CANCELLED,
-                        "ServerCancelled",
-                        data=DiagnosticServerCancellationData(True),
-                    )
-
                 doc_result = await self.get_document_diagnostics(doc)
 
                 if doc_result.result_id is not None and any(
@@ -301,7 +283,7 @@ async def _get_diagnostics() -> WorkspaceDiagnosticReport:
 
         async def _get_partial_diagnostics() -> WorkspaceDiagnosticReport:
             async with self.parent.window.progress(
-                f"Analyse {'full ' if self.collect_full_diagnostics else ''} Workspace",
+                "Analyse Workspace",
                 progress_token=work_done_token,
                 cancellable=False,
             ) as progress:
@@ -315,7 +297,7 @@ async def _task(doc: TextDocument) -> None:
                         else:
                             name = path.relative_to(folder.uri.to_path())
 
-                        progress.report(f"Analyse {'full ' if self.collect_full_diagnostics else ''} {name}")
+                        progress.report(f"Analyse {name}")
 
                     doc_result = await self.get_document_diagnostics(doc)
 
@@ -349,12 +331,6 @@ async def _task(doc: TextDocument) -> None:
                 for doc in self.parent.documents.documents:
                     if await self.get_diagnostics_mode(doc.uri) == DiagnosticsMode.WORKSPACE:
                         await _task(doc)
-                        if self._current_workspace_task is None:
-                            raise JsonRPCErrorException(
-                                ErrorCodes.SERVER_CANCELLED,
-                                "ServerCancelled",
-                                data=DiagnosticServerCancellationData(True),
-                            )
 
                 return WorkspaceDiagnosticReport(items=[])
 
@@ -368,11 +344,15 @@ async def _task(doc: TextDocument) -> None:
             task = create_sub_task(_get_diagnostics() if partial_result_token is None else _get_partial_diagnostics())
             self._current_workspace_task = task
             try:
-                result = await task
-                await self.set_collect_full_diagnostics(True)
-                return result
+                return await task
             except asyncio.CancelledError:
                 self._logger.debug("workspace/diagnostic canceled")
+                if self._current_workspace_task is None:
+                    raise JsonRPCErrorException(
+                        ErrorCodes.SERVER_CANCELLED,
+                        "ServerCancelled",
+                        data=DiagnosticServerCancellationData(True),
+                    )
                 raise
             finally:
                 if self._current_workspace_task == task:

robotcode/language_server/robotframework/configuration.py

@@ -79,6 +79,7 @@ class AnalysisConfig(ConfigBase):
     progress_mode: AnalysisProgressMode = AnalysisProgressMode.SIMPLE
     max_project_file_count: int = 1000
     references_code_lens: bool = False
+    find_unused_references: bool = False
 
 
 @config_section("robotcode")

robotcode/language_server/robotframework/parts/diagnostics.py

@@ -16,6 +16,7 @@
 )
 from ...common.parts.diagnostics import DiagnosticsResult
 from ...common.text_document import TextDocument
+from ..configuration import AnalysisConfig
 from ..diagnostics.analyzer import Analyzer
 from ..utils.ast_utils import (
     HeaderAndBodyBlock,
@@ -49,11 +50,8 @@ def __init__(self, parent: RobotLanguageServerProtocol) -> None:
 
     @language_id("robotframework")
     async def namespace_invalidated(self, sender: Any, document: TextDocument) -> None:
-        # await asyncio.sleep(2)
-        # await self.parent.diagnostics.cancel_workspace_diagnostics()
-        # await self.parent.diagnostics.cancel_document_diagnostics(document)
-        # await self.parent.diagnostics.set_collect_full_diagnostics(False)
-        pass
+        await self.parent.diagnostics.cancel_document_diagnostics(document)
+        await self.parent.diagnostics.cancel_workspace_diagnostics()
 
     @language_id("robotframework")
     @threaded()
@@ -249,8 +247,11 @@ async def _collect_model_errors(self, document: TextDocument, full: bool) -> Dia
     @threaded()
     @_logger.call
     async def collect_unused_references(self, sender: Any, document: TextDocument, full: bool) -> DiagnosticsResult:
-        if not full:
+        config = await self.parent.workspace.get_configuration(AnalysisConfig, document.uri)
+
+        if not full or not config.find_unused_references:
             return DiagnosticsResult(self.collect_unused_references, [])
+
         return await document.get_cache(self._collect_unused_references, full)
 
     async def _collect_unused_references(self, document: TextDocument, full: bool) -> DiagnosticsResult: