Various fixes and improvements

.envrc

@@ -0,0 +1 @@
+use flake

.gitignore

@@ -111,4 +111,8 @@ venv.bak/
 # mypy
 .mypy_cache/
 
-.DS_Store
+.DS_Store
+/.direnv/
+
+# VS Code extensions
+/vscode-extensions

.vscode/extensions.json

@@ -0,0 +1,7 @@
+{
+  "recommendations": [
+    "ms-python.python",
+    "ms-python.debugpy",
+    "connor4312.esbuild-problem-matchers"
+  ]
+}

CHANGELOG.md

@@ -7,6 +7,32 @@ and this project adheres to [Semantic Versioning][semver].
 
 ## [unreleased]
 
+## [0.3.0] (released 2025-05-09)
+
+### Added
+- dev: debug adapter and protocol
+
+### Changed
+- Use Nix flake for creating development setup.
+- User virtual env is used for client VS Code extension so it can be interacted
+  with from the CLI easily.
+- Python is searched in user virtual env (env variable VIRUAL_ENV) or using
+  setup from MS Python extension.
+- Moved to pyproject.toml
+- dropped dependency to setuptools pkg_resources
+- use flit for build
+- moved to logging module for server and deps
+- Removed dependency to vsce (change in textx-gen-vscode)
+- improved dynamic syntax highlighting
+- more robust LSP server connection handling
+- LSP server restarts on client close
+- improved IO LSP communication
+
+### Fixed
+- added lsprotocol server dependency
+- race condition on activation
+- better error reporting on installation failure and other errors
+
 ## [0.1.2] (released 12/30/2019)
 
 ### Fixed

README.md

@@ -14,10 +14,6 @@ and a _Visual Studio Code_ extension:
 
 - _[client](https://github.com/textX/textX-LS/tree/master/client)_
 
-## :warning: This project got a new maintainer
-
-After several years of inactivity this project is in a transition to a new maintainer.
-Please see [this announcement](https://github.com/textX/textX-LS/issues/68).
 
 ## Required textX Generator Plugins
 
@@ -47,13 +43,17 @@ Building a custom VS Code extension for newly registered language is delegated t
 
 ## Development Setup
 
-This project requires _python 3.6_ and _node v10.16_ for development.
-
 **Installation steps:**
 
-1. `python -m venv env && source env/bin/activate`
-1. `pip install -r requirements.txt`
-1. `cd client && npm i`
+1. Install [Nix](https://nixos.org/download/) (used for reproducible envs).
+   Be sure to configure flake feature by adding:
+   ```
+   experimental-features = nix-command flakes
+   ```
+   to `~/.config/nix/nix.conf`. See more here: https://nixos.wiki/wiki/flakes
+
+1. `nix develop` - will create a shell with all dependencies. See [direnv tool](https://direnv.net/)
+   which can be used to automate this step.
 
 To register _pre-commit_ hooks, run: `pre-commit install`
 To run _pre-commit_ hooks manually: `pre-commit run --all-files`
@@ -62,10 +62,29 @@ To run _pre-commit_ hooks manually: `pre-commit run --all-files`
 
 In order to run the extension, **client** directory must be added as a workspace folder or opened as a root project.
 
+E.g. you can run:
+
+``` sh
+code --extensions-dir vscode-extensions client
+```
+
 Now, switch to _debug_ view, choose `Server + Client` option and press _F5_.
 
 A new VS Code window should be opened in [examples](./examples) directory.
 
+Alternatively, you can run server as a separate process from the cli. See script
+`textX-LS/server/run_server.sh`. In that case choose debug configuration `Launch
+Client` in VS Code.
+
+Logging of LSP messages is done to the user log folder:
+
+| Platform | Log file                                                                               |
+|----------|----------------------------------------------------------------------------------------|
+| Linux    | `~/.local/state/textX/textx_ls_server.log` or `~/.cache/textX/log/textx_ls_server.log` |
+| macOS    | `~/Library/Logs/textX/textx_ls_server.log`                                             |
+| Windows  | `%LOCALAPPDATA%\textX\Logs\textx_ls_server.log`                                        |
+
+
 ## CI/CD and Artifacts
 
 Take a look at [build process](./azure-devops/README.md).

client/.vscode/extensions.json

@@ -1,5 +1,11 @@
 {
   // See http://go.microsoft.com/fwlink/?LinkId=827846
   // for the documentation about the extensions.json format
-  "recommendations": ["dbaeumer.vscode-eslint", "connor4312.esbuild-problem-matchers", "ms-vscode.extension-test-runner"]
+  "recommendations": [
+    "dbaeumer.vscode-eslint",
+    "connor4312.esbuild-problem-matchers",
+    "ms-python.python",
+    "ms-python.debugpy",
+    "ms-vscode.extension-test-runner"
+  ]
 }

client/.vscode/tasks.json

@@ -21,7 +21,7 @@
             "type": "npm",
             "script": "watch:esbuild",
             "group": "build",
-            // "problemMatcher": "$esbuild-watch",
+            "problemMatcher": "$esbuild-watch",
             "isBackground": true,
             "label": "npm: watch:esbuild",
             "presentation": {

client/README.md

@@ -19,7 +19,7 @@ textX for VS Code extension provides a syntax highlighting and intellisense for
 
 There are two options for _installing_ a textX language project:
 
-- **editable mode** - by _right_ clicking on a project root directory, or a _setup.py_ file and clicking on `Install textX project`
+- **editable mode** - by _right_ clicking on a project root directory, or a _setup.py_, _setup.cfg_, or _pyproject.toml_ file and clicking on `Install textX project`
 - **from wheel** - by opening a _textX view_, clicking on a _plus_ (+) icon and choosing a wheel (previously built manually)
 
 Install in an editable mode|  Install from a wheel

client/bin/copy-wheels.sh

@@ -13,8 +13,10 @@ server_dist_dir="$server_dir/dist"
 
 
 # Build wheels
-cd $core_dir && python setup.py sdist bdist_wheel clean --all
-cd $server_dir && python setup.py sdist bdist_wheel clean --all
+rm "$core_dist_dir"/*
+rm "$server_dist_dir"/*
+cd $core_dir && flit build
+cd $server_dir && flit build
 
 # Copy wheels
 cd $core_dist_dir && cp *.whl $client_wheels_dir

client/make_package.sh

@@ -0,0 +1,7 @@
+#!/bin/sh
+rm -f dist/*
+rm -f wheels/*
+rm *.vsix
+npm run vscode:prepublish
+yes | vsce package
+