refactor: clean up types and linting

Author: rchl

plugin.py

@@ -1,22 +1,34 @@
 from __future__ import annotations
+
 from LSP.plugin import Notification
-from LSP.plugin.core.types import cast
-from LSP.plugin.core.typing import Any, Callable, List, Mapping, Required, Tuple, TypedDict, Union
-from LSP.plugin.core.protocol import Error, ExecuteCommandParams, LSPAny, Location
+from LSP.plugin.core.protocol import Error
 from LSP.plugin.locationpicker import LocationPicker
+from LSP.protocol import ExecuteCommandParams
+from LSP.protocol import Location
+from LSP.protocol import LSPAny
 from lsp_utils import notification_handler
 from lsp_utils import NpmClientHandler
 from pathlib import Path
+from typing import Any
+from typing import Callable
+from typing import cast
+from typing import final
+from typing import List
+from typing import Tuple
+from typing import TypedDict
+from typing import Union
+from typing_extensions import override
 import sublime
 
-PACKAGE_NAME = __package__
+PACKAGE_NAME = str(__package__)
 SERVER_DIRECTORY = 'server'
 SERVER_NODE_MODULES = Path(SERVER_DIRECTORY) / 'node_modules'
-SERVER_BINARY_PATH =  SERVER_NODE_MODULES / '@vue' / 'language-server' / 'bin' / 'vue-language-server.js'
+SERVER_BINARY_PATH = SERVER_NODE_MODULES / '@vue' / 'language-server' / 'bin' / 'vue-language-server.js'
 
 
 class TypescriptTsserverCommandParams(TypedDict):
-    file: Required[str]
+    file: str
+
 
 TsserverRequestParams = Tuple[Tuple[int, str, Union[TypescriptTsserverCommandParams, List[str]]]]
 
@@ -29,38 +41,41 @@ def plugin_unloaded():
     LspVuePlugin.cleanup()
 
 
+@final
 class LspVuePlugin(NpmClientHandler):
     package_name = PACKAGE_NAME
     server_directory = SERVER_DIRECTORY
-    server_binary_path = SERVER_BINARY_PATH
+    server_binary_path = str(SERVER_BINARY_PATH)
 
     @classmethod
+    @override
     def required_node_version(cls) -> str:
         return '>=18'
 
-    def on_pre_server_command(self, command: Mapping[str, Any], done_callback: Callable[[], None]) -> bool:
+    @override
+    def on_pre_server_command(self, command: ExecuteCommandParams, done_callback: Callable[[], None]) -> bool:
         command_name = command['command']
         if command_name == 'editor.action.showReferences':
-            _, __, references = command['arguments']
-            self._handle_show_references(references)
+            _, __, references = command.get('arguments', [None, None, None])
+            self._handle_show_references(cast(list[Location], references))
             done_callback()
             return True
         return False
 
-    def _handle_show_references(self, references: List[Location]) -> None:
+    def _handle_show_references(self, references: list[Location]) -> None:
         session = self.weaksession()
         if not session:
             return
         view = sublime.active_window().active_view()
         if not view:
             return
         if len(references) == 1:
-            args = {
-                'location': references[0],
-                'session_name': session.config.name,
-            }
             window = view.window()
             if window:
+                args: dict[str, Any] = {
+                    'location': references[0],
+                    'session_name': session.config.name,
+                }
                 window.run_command('lsp_open_location', args)
         elif references:
             LocationPicker(view, session, references, side_by_side=False)
@@ -87,12 +102,13 @@ def on_tsserver_request(self, params: TsserverRequestParams) -> None:
             'command': 'typescript.tsserverRequest',
             'arguments': [
                 command_name,
-                cast(LSPAny, command_params),
-                { 'isAsync': True, 'lowPriority': True },
+                command_params,
+                {'isAsync': True, 'lowPriority': True},
             ]
         }
-        session.execute_command(execute_command_params, progress=False) \
-            .then(lambda result: self._on_execute_command_response(seq, result))
+        session.execute_command(execute_command_params, progress=False).then(
+            lambda result: self._on_execute_command_response(seq, result)
+        )
 
     def _on_execute_command_response(self, seq: int, result: LSPAny | Error) -> None:
         session = self.weaksession()

pyproject.toml

@@ -0,0 +1,49 @@
+[tool.pyright]
+pythonVersion = "3.8"
+reportAny = "none"
+reportExplicitAny = "none"
+reportImplicitOverride = "none"
+reportIncompatibleMethodOverride = "none"
+reportMissingModuleSource = "none"
+reportUnannotatedClassAttribute = "none"
+reportUnknownArgumentType = "none"
+reportUnknownMemberType = "none"
+reportUnknownVariableType = "none"
+reportUnusedCallResult = "none"
+
+[tool.ruff]
+line-length = 120
+target-version = "py38"
+
+[tool.ruff.format]
+quote-style = "preserve"
+indent-style = "space"
+# Respect magic trailing commas.
+skip-magic-trailing-comma = false
+# Automatically detect the appropriate line ending.
+line-ending = "auto"
+
+[tool.ruff.lint.isort]
+case-sensitive = false
+force-single-line = true
+from-first = true
+no-sections = true
+order-by-type = false
+required-imports = ["from __future__ import annotations"]
+
+[tool.tox]
+env_list = ["py3"]
+skipsdist = true
+
+[tool.tox.env_run_base]
+deps = [
+    "pyright==1.1.408",
+    "ruff==0.15.0",
+]
+commands = [
+    # mypy disabled for main code as it doesn't currently support cyclic definitions - https://github.com/python/mypy/issues/731
+    ["pyright"],
+    ["ruff", "check"],
+    ["ruff", "format", "--check"],
+]
+