Fixes and updates as found and addressed in other extensions (#99)

* Fix filenames to avoid shadowing

* Upgrade to latest `pygls`

* Get fixes from other extensions

* Fix formatting

* Fix debug config

* Add prettier to recommended extensions.

* Use latest language client

Author: karthiknadig

.vscode/extensions.json

@@ -1,5 +1,5 @@
 {
   // See http://go.microsoft.com/fwlink/?LinkId=827846
   // for the documentation about the extensions.json format
-  "recommendations": ["dbaeumer.vscode-eslint", "amodio.tsl-problem-matcher"]
+  "recommendations": ["dbaeumer.vscode-eslint", "amodio.tsl-problem-matcher", "esbenp.prettier-vscode"]
 }

.vscode/launch.json

@@ -12,9 +12,6 @@
             "args": ["--extensionDevelopmentPath=${workspaceFolder}"],
             "outFiles": ["${workspaceFolder}/dist/**/*.js"],
             "preLaunchTask": "npm: watch",
-            "env": {
-                "DEBUGPY_ENABLED": "False"
-            },
             "presentation": {
                 "hidden": false,
                 "group": "",
@@ -34,7 +31,7 @@
             }
         },
         {
-            "name": "Python Test Debug",
+            "name": "Python Config for test explorer (hidden)",
             "type": "python",
             "request": "launch",
             "console": "integratedTerminal",
@@ -47,19 +44,22 @@
             }
         },
         {
-            "name": "Debug Extension",
+            "name": "Debug Extension (hidden)",
             "type": "extensionHost",
             "request": "launch",
             "args": ["--extensionDevelopmentPath=${workspaceFolder}"],
             "outFiles": ["${workspaceFolder}/dist/**/*.js"],
+            "env": {
+                "USE_DEBUGPY": "True"
+            },
             "presentation": {
                 "hidden": true,
                 "group": "",
                 "order": 4
             }
         },
         {
-            "name": "Python Server",
+            "name": "Python debug server (hidden)",
             "type": "python",
             "request": "attach",
             "listen": { "host": "localhost", "port": 5678 },
@@ -74,7 +74,7 @@
     "compounds": [
         {
             "name": "Debug Extension and Python",
-            "configurations": ["Python Server", "Debug Extension"],
+            "configurations": ["Python debug server (hidden)", "Debug Extension (hidden)"],
             "stopAll": true,
             "preLaunchTask": "npm: watch",
             "presentation": {

.vscode/settings.json

@@ -14,5 +14,9 @@
     "python.testing.unittestEnabled": false,
     "python.testing.pytestEnabled": true,
     "python.testing.cwd": "${workspaceFolder}",
-    "python.analysis.extraPaths": ["bundled/libs"]
+    "python.analysis.extraPaths": ["bundled/libs"],
+    "[typescript]": {
+        "editor.defaultFormatter": "esbenp.prettier-vscode",
+        "editor.formatOnSave": true
+    },
 }

LICENSE

@@ -1,6 +1,9 @@
 MIT License
 
-# TODO: Copyright (c) Microsoft Corporation.
+# TODO: If you want to keep using the MIT license, add your name here. 
+# To change the license, PREPEND it to this file.
+
+Copyright (c) Microsoft Corporation.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -40,7 +40,6 @@ After finishing the getting started part, this template would have added the fol
 
 1. A command `My Tool: Restart Server` (command Id: `mytool.restart`).
 1. Following setting:
-    - `mytool.logLevel`
     - `mytool.args`
     - `mytool.path`
     - `mytool.importStrategy`
@@ -54,11 +53,11 @@ After finishing the getting started part, this template would have added the fol
 
 ## Adding features from your tool
 
-Open `bundled/tool/server.py`, here is where you will do most of the changes. Look for `TODO` comments there for more details.
+Open `bundled/tool/lsp_server.py`, here is where you will do most of the changes. Look for `TODO` comments there for more details.
 
 Also look for `TODO` in other locations in the entire template:
 
-- `bundled/tool/runner.py` : You may need to update this in some special cases.
+- `bundled/tool/lsp_runner.py` : You may need to update this in some special cases.
 - `src/test/python_tests/test_server.py` : This is where you will write tests. There are two incomplete examples provided there to get you started.
 - All the markdown files in this template have some `TODO` items, be sure to check them out as well. That includes updating the LICENSE file, even if you want to keep it MIT License.
 
@@ -81,11 +80,11 @@ To debug both TypeScript and Python code use `Debug Extension and Python` debug
 
 To debug only TypeScript code, use `Debug Extension` debug config.
 
-To debug a already running server or in production server, use `Python Attach`, and select the process that is running `server.py`.
+To debug a already running server or in production server, use `Python Attach`, and select the process that is running `lsp_server.py`.
 
 ## Adding new Settings or Commands
 
-You can add new settings by adding details for the settings in `package.json` file. To pass this configuration to your python tool server (i.e, `server.py`) update the `settings.ts` as need. There are examples of different types of settings in that file that you can base your new settings on.
+You can add new settings by adding details for the settings in `package.json` file. To pass this configuration to your python tool server (i.e, `lsp_server.py`) update the `settings.ts` as need. There are examples of different types of settings in that file that you can base your new settings on.
 
 You can follow how `restart` command is implemented in `package.json` and `extension.ts` for how to add commands. You cam also contribute commands from Python via the Language Server Protocol.
 
@@ -131,11 +130,11 @@ To manually upgrade your local project:
 
 ## Troubleshooting
 
-### Changing path or name of `server.py` something else
+### Changing path or name of `lsp_server.py` something else
 
-If you want to change the name of `server.py` to something else, you can. Be sure to update `constants.ts` and `src\test\python_tests\lsp_test_client\session.py`.
+If you want to change the name of `lsp_server.py` to something else, you can. Be sure to update `constants.ts` and `src\test\python_tests\lsp_test_client\session.py`.
 
-Also make sure that the inserted paths in `server.py` are pointing to the right folders to pick up the dependent packages.
+Also make sure that the inserted paths in `lsp_server.py` are pointing to the right folders to pick up the dependent packages.
 
 ### Module not found errors
 

bundled/tool/_debug_server.py

@@ -34,6 +34,6 @@ def update_sys_path(path_to_add: str) -> None:
     # line and set breakpoints as appropriate.
     debugpy.breakpoint()
 
-SERVER_PATH = os.fspath(pathlib.Path(__file__).parent / "server.py")
-# NOTE: Set breakpoint in `server.py` before continuing.
+SERVER_PATH = os.fspath(pathlib.Path(__file__).parent / "lsp_server.py")
+# NOTE: Set breakpoint in `lsp_server.py` before continuing.
 runpy.run_path(SERVER_PATH, run_name="__main__")

bundled/tool/jsonrpc.py renamed to bundled/tool/lsp_jsonrpc.py

@@ -14,7 +14,7 @@
 from typing import BinaryIO, Dict, Optional, Sequence, Union
 
 CONTENT_LENGTH = "Content-Length: "
-RUNNER_SCRIPT = str(pathlib.Path(__file__).parent / "runner.py")
+RUNNER_SCRIPT = str(pathlib.Path(__file__).parent / "lsp_runner.py")
 
 
 def to_str(text) -> str:
@@ -131,7 +131,6 @@ def __init__(self):
         self._rpc: Dict[str, JsonRpc] = {}
         self._lock = threading.Lock()
         self._thread_pool = ThreadPoolExecutor(10)
-        atexit.register(self.stop_all_processes)
 
     def stop_all_processes(self):
         """Send exit command to all processes and shutdown transport."""
@@ -175,6 +174,7 @@ def get_json_rpc(self, workspace: str) -> JsonRpc:
 
 
 _process_manager = ProcessManager()
+atexit.register(_process_manager.stop_all_processes)
 
 
 def _get_json_rpc(workspace: str) -> Union[JsonRpc, None]:
@@ -244,11 +244,14 @@ def run_over_json_rpc(
         )
 
     if "error" in data:
+        result = data["result"] if "result" in data else ""
+        error = data["error"]
+
         if data.get("exception", False):
-            return RpcRunResult(data["result"], "", data["error"])
-        return RpcRunResult(data["result"], data["error"])
+            return RpcRunResult(result, "", error)
+        return RpcRunResult(result, error)
 
-    return RpcRunResult(data["result"], "")
+    return RpcRunResult(result, "")
 
 
 def shutdown_json_rpc():

bundled/tool/runner.py renamed to bundled/tool/lsp_runner.py

@@ -30,8 +30,8 @@ def update_sys_path(path_to_add: str, strategy: str) -> None:
 
 
 # pylint: disable=wrong-import-position,import-error
-import jsonrpc
-import utils
+import lsp_jsonrpc as jsonrpc
+import lsp_utils as utils
 
 RPC = jsonrpc.create_json_rpc(sys.stdin.buffer, sys.stdout.buffer)
 
@@ -55,7 +55,7 @@ def update_sys_path(path_to_add: str, strategy: str) -> None:
                 # If your tool supports a programmatic API then replace the function below
                 # with code for your tool. You can also use `utils.run_api` helper, which
                 # handles changing working directories, managing io streams, etc.
-                # Also update `_run_tool_on_document` and `_run_tool` functions in `server.py`.
+                # Also update `_run_tool_on_document` and `_run_tool` functions in `lsp_server.py`.
                 result = utils.run_module(
                     module=msg["module"],
                     argv=msg["argv"],