Updated READMEs and deps. Implemented Go to References.

Author: KyrylR

.github/workflows/lsp-ci.yml

@@ -0,0 +1,62 @@
+name: LSP CI
+
+on:
+  pull_request:
+    paths:
+      - 'lsp/**'
+      - '.github/workflows/lsp-ci.yml'
+  push:
+    branches:
+      - master
+    paths:
+      - 'lsp/**'
+      - '.github/workflows/lsp-ci.yml'
+
+jobs:
+  fmt:
+    name: Rustfmt (lsp)
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Rust (stable)
+        uses: dtolnay/rust-toolchain@stable
+        with:
+          components: rustfmt
+
+      - name: Check formatting
+        working-directory: lsp
+        run: cargo fmt --all -- --check
+
+  clippy:
+    name: Clippy (lsp)
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Rust (stable)
+        uses: dtolnay/rust-toolchain@stable
+        with:
+          components: clippy
+
+      - name: Run clippy
+        working-directory: lsp
+        run: cargo clippy --all-targets --all-features
+
+  tests:
+    name: Tests (lsp)
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Rust (stable)
+        uses: dtolnay/rust-toolchain@stable
+
+      - name: Run tests
+        working-directory: lsp
+        run: cargo test --all-features -- --nocapture
+
+

.github/workflows/publish-lsp.yml

@@ -0,0 +1,95 @@
+name: Publish simplicityhl-lsp
+
+on:
+  push:
+    tags:
+      - 'simplicityhl-lsp-v*'
+  workflow_dispatch: {}
+  release:
+    types: [published]
+
+jobs:
+  lint:
+    name: Lint (lsp)
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Rust (stable)
+        uses: dtolnay/rust-toolchain@stable
+        with:
+          components: clippy, rustfmt
+
+      - name: Rustfmt check
+        working-directory: lsp
+        run: cargo fmt --all -- --check
+
+      - name: Clippy
+        working-directory: lsp
+        run: cargo clippy --all-targets --all-features -D warnings
+
+  tests:
+    name: Tests (lsp)
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Rust (stable)
+        uses: dtolnay/rust-toolchain@stable
+
+      - name: Run tests
+        working-directory: lsp
+        run: cargo test --all-features -- --nocapture
+
+  publish:
+    name: Publish simplicityhl-lsp to crates.io
+    needs: [lint, tests]
+    runs-on: ubuntu-latest
+    environment: release
+    concurrency:
+      group: publish-lsp-${{ github.ref }}
+      cancel-in-progress: false
+    permissions:
+      id-token: write
+      contents: read
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Rust (stable)
+        uses: actions-rust-lang/setup-rust-toolchain@v1
+        with:
+          toolchain: stable
+
+      - name: Verify tag matches crate version
+        shell: bash
+        run: |
+          set -euo pipefail
+          TAG="${GITHUB_REF##*/}"
+          VERSION_TAG="${TAG#simplicityhl-lsp-v}"
+          CRATE_VERSION=$(cargo metadata --manifest-path lsp/Cargo.toml --no-deps --format-version=1 | jq -r '.packages[] | select(.name=="simplicityhl-lsp").version')
+          echo "Tag version: $VERSION_TAG"
+          echo "Crate version: $CRATE_VERSION"
+          if [ "$VERSION_TAG" != "$CRATE_VERSION" ]; then
+            echo "Tag version ($VERSION_TAG) does not match crate version ($CRATE_VERSION)"
+            exit 1
+          fi
+
+      - name: Check package
+        working-directory: lsp
+        run: cargo package
+
+      - name: Authenticate with crates.io
+        id: auth
+        uses: rust-lang/crates-io-auth-action@v1
+
+      - name: Publish
+        env:
+          CARGO_REGISTRY_TOKEN: ${{ steps.auth.outputs.token }}
+        working-directory: lsp
+        run: cargo publish
+
+

Cargo.toml

@@ -39,7 +39,7 @@ getrandom = { version = "0.2", features = ["js"] }
 
 [workspace]
 members = ["codegen"]
-exclude = ["fuzz", "bitcoind-tests"]
+exclude = ["fuzz", "bitcoind-tests", "lsp"]
 
 [lints.clippy]
 # Exclude lints we don't think are valuable.

README.md

@@ -20,7 +20,7 @@ Take a look at the [example programs](https://github.com/BlockstreamResearch/Sim
 
 ## MSRV
 
-This crate should compile with any feature combination on **Rust 1.78.0** or higher.
+This crate should compile with any feature combination on **Rust 1.79.0** or higher.
 
 ## Simplicity's need for a high-level language
 

clippy.toml

@@ -1,4 +1,4 @@
-msrv = "1.78.0"
+msrv = "1.79.0"
 # We have an error type, `RichError`, of size 144. This is pushing it but probably fine.
 large-error-threshold = 145
 

lsp/.gitignore

@@ -0,0 +1,19 @@
+# rust executables files
+target/
+debug/
+
+# client executables files
+node_modules/
+out/
+
+.pnpm-debug.log
+
+*.ast 
+dist/
+
+# vscode package
+*.vsix
+
+# lock files
+Cargo.lock
+**/pnpm-lock.yaml

lsp/Cargo.toml

@@ -0,0 +1,34 @@
+[package]
+name = "simplicityhl-lsp"
+version = "0.2.0"
+edition = "2021"
+rust-version = "1.79"
+description = "Language Server Protocol (LSP) server for SimplicityHL."
+license = "MIT OR Apache-2.0"
+repository = "https://github.com/BlockstreamResearch/SimplicityHL"
+homepage = "https://github.com/BlockstreamResearch/SimplicityHL/tree/master/lsp"
+readme = "README.md"
+documentation = "https://docs.rs/simplicityhl-lsp"
+keywords = ["simplicity", "liquid", "bitcoin", "elements", "lsp"]
+
+[dependencies]
+tokio = { version = "1.47.1", features = ["full"] }
+serde_json = "1.0.143"
+tower-lsp-server = "0.22.1"
+
+env_logger = "0.11.8"
+thiserror = "2.0.17"
+
+ropey = "1.6.1"
+miniscript = "12"
+simplicityhl = { version = "0.3.0" }
+
+[lints.rust]
+unsafe_code = "deny"
+unused_variables = "warn"
+dead_code = "warn"
+unreachable_code = "warn"
+unused_mut = "warn"
+
+[lints.clippy]
+pedantic = "warn"

lsp/README.md

@@ -0,0 +1,102 @@
+# SimplicityHL LSP
+
+Language Server for [SimplicityHL language](https://simplicity-lang.org/).
+
+## Features
+
+- Basic diagnostic for SimplicityHL code
+  
+![diagnostics](assets/diagnostics.gif)
+
+- Completions of built-ins, jets and functions
+
+![completion](assets/completion.gif)
+
+- Hover for built-ins, jets and functions, with support of documentation
+
+![hover](assets/hover.gif)
+
+- Go to definition for functions
+
+![goto-definition](assets/goto-definition.gif)
+
+## Installation
+
+Clone this repository and install using Cargo:
+
+```bash
+https://github.com/distributed-lab/simplicityhl-lsp
+cd simplicityhl-lsp
+cargo install --path .
+```
+
+## Integration with editors
+
+### Neovim
+
+#### LSP
+
+0. Install `simplicityhl-lsp` to your `PATH`.
+
+1. Include this Lua snippet to your Neovim config:
+
+```lua
+vim.filetype.add({
+	extension = {
+		simf = "simf",
+	},
+})
+
+vim.lsp.config["simplicityhl-lsp"] = { cmd = { "simplicityhl-lsp" }, filetypes = { "simf" }, settings = {} }
+vim.lsp.enable("simplicityhl-lsp")
+```
+
+2. Open `.simf` file and check that LSP is active ("attached"):
+
+```vim
+:checkhealth vim.lsp
+```
+
+#### Tree-sitter (Highlighting)
+
+Currently, the Language Server does not provide any syntax highlighting on its own, but you can install tree-sitter for SimplicityHL:
+
+0. Set up the [`nvim-treesitter`](https://github.com/nvim-treesitter/nvim-treesitter/tree/main) plugin.
+
+1. Include this Lua snippet in your Neovim config to register parser:
+
+```lua
+vim.api.nvim_create_autocmd("User", {
+	pattern = "TSUpdate",
+	callback = function()
+		require("nvim-treesitter.parsers").simplicityhl = {
+			install_info = {
+				url = "https://github.com/distributed-lab/tree-sitter-simplicityhl",
+				queries = "queries",
+			},
+			filetype = "simf",
+			tier = 0,
+		}
+	end,
+})
+
+vim.treesitter.language.register("simplicityhl", { "simf" })
+
+vim.api.nvim_create_autocmd("FileType", {
+	pattern = { "simf" },
+	callback = function()
+		vim.treesitter.start()
+	end,
+})
+```
+
+2. Restart Neovim and run:
+
+```vim
+:TSInstall simplicityhl
+```
+
+If everything is working correctly, you should see syntax highlighting in `.simf` files.
+
+**Note:** This method is compatible only with `nvim-treesitter` v0.10 or newer.
+