LSP-astro/plugin.py at main · sublimelsp/LSP-astro · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
from __future__ import annotations
from pathlib import Path, WindowsPath
from typing import TYPE_CHECKING

from lsp_utils import NpmClientHandler

if TYPE_CHECKING:
    from LSP.plugin import ClientConfig
    from LSP.plugin import WorkspaceFolder
    from sublime import Window, View

__all__ = ["LspAstroPlugin", "plugin_loaded", "plugin_unloaded"]


def plugin_loaded() -> None:
    LspAstroPlugin.setup()


def plugin_unloaded() -> None:
    LspAstroPlugin.cleanup()


class LspAstroPlugin(NpmClientHandler):
    package_name = __package__
    server_directory = "language-server"
    server_binary_path = Path(
        server_directory, "node_modules", "@astrojs", "language-server", "bin", "nodeServer.js"
    )

    @classmethod
    def is_allowed_to_start(
        cls,
        window: Window,
        initiating_view: View | None = None,
        workspace_folders: list[WorkspaceFolder] | None = None,
        configuration: ClientConfig | None = None
    ) -> str | None:
        """
        Determines if the session is allowed to start.

        :returns:
            A string describing the reason why we should not start a language server session,
            or `None` if we should go ahead and start a session.
        """
        if configuration is None:
            return

        # prefer explicit `typescript.tsdk` from LSP-astro.sublime-settings
        if configuration.initialization_options.get("typescript.tsdk"):
            return

        typescript_path = None
        typescript_relpath = Path("node_modules", "typescript", "lib")

        def find_typescript_path(path: Path) -> Path | None:
            """
            Find typescript in the package specified ``path`` belongs to.

            :param path:
                The absolute path of a directory to use as starting point

            :returns:
                The absolute path to typescript language-server if exists.
            """
            for root in (path, *path.parents):
                if (root / "package.json").is_file():
                    typescript_path = root / typescript_relpath
                    if typescript_path.is_dir():
                        return typescript_path

            return None

        # try to find package root and typescript based on current file to support
        # nested packages, which are not directly added as folder to sidebar
        if initiating_view:
            file_name = initiating_view.file_name()
            if file_name:
                typescript_path = find_typescript_path(Path(file_name).parent)

        # try to find typescript from first workspace folder
        if not typescript_path and workspace_folders:
            typescript_path = find_typescript_path(Path(workspace_folders[0].path))

        # use typescript bundled with LSP-astro
        if not typescript_path:
            bundled_path = Path(cls._server_directory_path(), typescript_relpath)
            if bundled_path.is_dir():
                typescript_path = bundled_path

        if not typescript_path:
            return

        # Escape Windows path separators
        # see: https://github.com/sublimelsp/LSP-astro/issues/120
        value = str(typescript_path)
        if isinstance(typescript_path, WindowsPath):
            value = value.replace("\\", "\\\\")

        configuration.initialization_options.set("typescript.tsdk", value)

    @classmethod
    def minimum_node_version(cls) -> tuple[int, int, int]:
        return (14, 0, 0)