Add support for resolving workspaceDirectories (sublimelsp#30)

Implements code for parsing user-supplied "workspaceDirectories" setting
into "workingDirectory" that server receives. The relevant code from
vscode-eslint extension is here:
https://github.com/microsoft/vscode-eslint/blob/a296a01afc79089c49a4f5c9c2b75831a03494b0/client/src/extension.ts#L1183-L1255

Configuring "workspaceDirectories" using patterns (rather than paths) is
not supported as there is some crazy parsing code that is required for
that and I didn't feel like converting that to python:
https://github.com/microsoft/vscode-eslint/blob/a296a01afc79089c49a4f5c9c2b75831a03494b0/client/src/utils.ts#L77-L228

Resolves sublimelsp#18

Author: rchl

LSP-eslint.sublime-settings

@@ -35,5 +35,15 @@
 			"enable": true,
 			"mode": "all"
 		},
+		// An optional list of working directories or a setting on how those are auto-resolved.
+		//
+		// This setting will normally only be set per-project to provide a list of working
+		// directories. The server will consider those as bases for resolving // the eslint configuration.
+		//
+		// Refer to the `eslint.workingDirectories` documentation at https://github.com/Microsoft/vscode-eslint
+		// for more info.
+		//
+		// NOTE that the `{ "pattern": glob pattern }` variant is not supported in LSP-eslint.
+		"workingDirectories": null
 	}
 }

README.md

@@ -13,17 +13,13 @@ Open configuration file using command palette with `Preferences: LSP-eslint Sett
 
 Configuration file contains multiple configuration keys:
 
-#### scopes
+#### languages
 
-Defines which scopes ESLint can run in.
-
-#### syntaxes
-
-Defines which syntax files ESLint can run in.
+Defines on which types of files the ESLint server will run.
 
 #### settings
 
-ESLint configuration options. Refer to [documentation for VSCode extension](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint).
+ESLint configuration options. Refer to [documentation for VSCode extension](https://github.com/Microsoft/vscode-eslint).
 
 ### FAQ
 

plugin.py

@@ -1,6 +1,10 @@
 import os
+import posixpath
+import re
+import sublime
 import webbrowser
 
+from LSP.plugin.core.url import uri_to_filename
 from lsp_utils import NpmClientHandler
 
 
@@ -33,7 +37,71 @@ def on_workspace_configuration(self, params, configuration) -> None:
         if session:
             scope_uri = params.get('scopeUri')
             if scope_uri:
+                workspace_folder = None
                 for folder in session.get_workspace_folders():
                     if folder.includes_uri(scope_uri):
-                        configuration['workspaceFolder'] = folder.to_lsp()
+                        workspace_folder = folder
                         break
+                if workspace_folder:
+                    configuration['workspaceFolder'] = workspace_folder.to_lsp()
+                self.resolve_working_directory(configuration, scope_uri, workspace_folder)
+
+    def resolve_working_directory(self, configuration, scope_uri, workspace_folder) -> None:
+        working_directories = configuration.get('workingDirectories', None)
+        if isinstance(working_directories, list):
+            working_directory = None
+            workspace_folder_path = workspace_folder.path if workspace_folder else None
+            for entry in working_directories:
+                directory = None
+                no_cwd = False
+                if isinstance(entry, str):
+                    directory = entry
+                elif self.is_working_directory_item(entry, 'directory'):
+                    directory = entry.directory
+                    if isinstance(entry.get('!cwd', None), bool):
+                        no_cwd = entry['!cwd']
+                elif self.is_working_directory_item(entry, 'pattern'):
+                    print('LSP-eslint: workingDirectories configuration that uses "pattern" is not supported')
+                    continue
+                elif self.is_mode_item(entry):
+                    working_directory = entry
+                    continue
+
+                directory_value = None
+                if directory:
+                    file_path = uri_to_filename(scope_uri)
+                    if directory:
+                        directory = self.to_os_path(directory)
+                        if not os.path.isabs(directory) and workspace_folder_path:
+                            # Trailing '' will add trailing slash if missing.
+                            directory = os.path.join(workspace_folder_path, directory, '')
+                        if file_path.startswith(directory):
+                            directory_value = directory
+
+                if directory_value:
+                    if not working_directory or self.is_mode_item(working_directory):
+                        working_directory = { 'directory': directory_value, '!cwd': no_cwd }
+                    else:
+                        if len(working_directory['directory']) < len(directory_value):
+                            working_directory['directory'] = directory_value
+                            working_directory['!cwd'] = no_cwd
+            configuration['workingDirectory'] = working_directory
+            configuration.pop('workingDirectories', None)
+
+    def is_working_directory_item(self, item, configuration_key) -> bool:
+        if isinstance(item, dict):
+            value = item.get(configuration_key, None)
+            not_cwd = item.get('!cwd', None)
+            return isinstance(value, str) and (isinstance(not_cwd, bool) or not_cwd == None)
+        return False
+
+    def is_mode_item(self, item) -> bool:
+        if isinstance(item, dict):
+            mode = item.get('mode', None)
+            return isinstance(mode, str) and mode in ('auto', 'location')
+        return False
+
+    def to_os_path(self, path) -> str:
+        if sublime.platform == 'windows':
+            path = re.sub(r'^\/(\w)\/', r'\1:\\', path)
+        return os.path.normpath(path);