Implement support for css.customData (#44)

* Implement support for css.customData

* comment

* schema

Author: rchl

LSP-css.sublime-settings

@@ -9,6 +9,7 @@
 		// "colorProvider": true,
 	},
 	"initializationOptions": {
+		"handledSchemas": ["file"],
 		"provideFormatter": true,
 	},
 	"settings": {

language-server/compile-language-server.sh

@@ -41,7 +41,8 @@ fi
 temp_zip="src-${ref}.zip"
 curl -L "${GITHUB_REPO_URL}/archive/${ref}.zip" -o "${temp_zip}"
 unzip -z "${temp_zip}" | tr -d '\r' > update-info.log
-unzip "${temp_zip}" && rm -f "${temp_zip}"
+unzip "${temp_zip}"  # ignore errors as there are some special file names that cause them
+rm -f "${temp_zip}" || exit
 mv "${GITHUB_REPO_NAME}-"* "${GITHUB_REPO_NAME}"
 
 popd || exit
@@ -56,7 +57,7 @@ pushd "${SRC_DIR}" || exit
 npm install
 
 # @see https://github.com/microsoft/vscode/blob/main/extensions/package.json
-npm install -D typescript@^4.8.3
+npm install -D typescript@^4.8.4
 
 popd || exit
 
@@ -72,7 +73,6 @@ cat << EOF > tsconfig.mod.json
 {
     "extends": "./tsconfig.json",
     "compilerOptions": {
-        "skipLibCheck": true,
         "outDir": "./out"
     },
     "include": [

language-server/css-language-features/server/out/cssServer.js

@@ -182,7 +182,7 @@ function startServer(connection, runtime) {
             if (document) {
                 await dataProvidersReady;
                 const stylesheet = stylesheets.get(document);
-                return getLanguageService(document).findDocumentSymbols(document, stylesheet);
+                return getLanguageService(document).findDocumentSymbols2(document, stylesheet);
             }
             return [];
         }, [], `Error while computing document symbols for ${documentSymbolParams.textDocument.uri}`, token);

language-server/package-lock.json

@@ -12,12 +12,12 @@
   "dependencies": {
     "vscode-css-languageservice": "^6.1.1",
     "vscode-languageserver": "^8.1.0-next.1",
-    "vscode-uri": "^3.0.5"
+    "vscode-uri": "^3.0.6"
   },
   "devDependencies": {
     "@types/mocha": "^9.1.1",
     "@types/node": "16.x",
-    "typescript": "^4.8.3"
+    "typescript": "^4.8.4"
   },
   "scripts": {
     "compile": "gulp compile-extension:css-language-features-server",

language-server/package.json

@@ -1,2 +1,2 @@
 Archive:  src-main.zip
-da506e9b8d86a7265d53255ef8a8603d792d74f5
+3e407526a1e2ff22cacb69c7e353e81a12f41029

language-server/update-info.log

@@ -1,6 +1,8 @@
-from LSP.plugin.core.typing import Tuple
-from lsp_utils import NpmClientHandler
-import os
+from .types import CustomDataChangedNotification
+from LSP.plugin import Session, filename_to_uri
+from LSP.plugin.core.typing import List
+from lsp_utils import ApiWrapperInterface, NpmClientHandler
+from os import path
 
 
 def plugin_loaded():
@@ -14,7 +16,7 @@ def plugin_unloaded():
 class LspCssPlugin(NpmClientHandler):
     package_name = __package__
     server_directory = "language-server"
-    server_binary_path = os.path.join(
+    server_binary_path = path.join(
         server_directory,
         "css-language-features",
         "server",
@@ -24,6 +26,20 @@ class LspCssPlugin(NpmClientHandler):
     )
 
     @classmethod
-    def minimum_node_version(cls) -> Tuple[int, int, int]:
-        # this should be aligned with VSCode's Nodejs version
-        return (14, 0, 0)
+    def required_node_version(cls) -> str:
+        return '>=14'
+
+    def on_ready(self, api: ApiWrapperInterface) -> None:
+        session = self.weaksession()
+        if not session:
+            return
+        self.resolve_custom_data_paths(session)
+
+    def resolve_custom_data_paths(self, session: Session) -> None:
+        custom_data_paths = session.config.settings.get('css.customData')  # type: List[str]
+        resolved_custom_data_paths = []  # type: List[str]
+        for folder in session.get_workspace_folders():
+            # Converting to URI as server can't handle reading the content if it's a file path.
+            resolved_custom_data_paths.extend(
+                [filename_to_uri(path.abspath(path.join(folder.path, p))) for p in custom_data_paths])
+        session.send_notification(CustomDataChangedNotification.create(resolved_custom_data_paths))

plugin.py

@@ -18,6 +18,25 @@
           "definitions": {
             "PluginConfig": {
               "properties": {
+                "initializationOptions": {
+                  "type": "object",
+                  "additionalProperties": false,
+                  "properties": {
+                    "handledSchemas": {
+                      "type": "array",
+                      "items": {
+                        "type": "string"
+                      },
+                      "default": ["file"],
+                      "markdownDescription": "Types of protocols that the server supports for URIs provided through `css.customData`."
+                    },
+                    "provideFormatter": {
+                      "type": "boolean",
+                      "default": true,
+                      "markdownDescription": "Whether server provides formatter capabilities."
+                    }
+                  },
+                },
                 "settings": {
                   "additionalProperties": false,
                   "properties": {

sublime-package.json

@@ -0,0 +1,14 @@
+from LSP.plugin import Notification
+from LSP.plugin.core.typing import List
+
+
+FilePath = str
+
+
+class CustomDataChangedNotification:
+    Type = 'css/customDataChanged'
+    Params = List[FilePath]
+
+    @classmethod
+    def create(cls, params: Params) -> Notification:
+        return Notification(cls.Type, [params])