diff --git a/.vscodeignore b/.vscodeignore index 6d93587..18bed61 100644 --- a/.vscodeignore +++ b/.vscodeignore @@ -11,3 +11,4 @@ package-lock.json eslint.config.ts *.ts dist/**/*.map +assets \ No newline at end of file diff --git a/README.md b/README.md index 600278b..5b3d27a 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ # SimplicityHL extension for VSCode -VSCode extension that provides syntax highlighting for the [SimplicityHL](https://github.com/BlockstreamResearch/SimplicityHL) programming language. +VSCode extension that provides syntax highlighting for the [SimplicityHL][1] programming language. -[Simplicity](https://github.com/BlockstreamResearch/simplicity) is a typed, combinator-based, functional language without loops or recursion, developed to be an alternative to Bitcoin script that is formally specified, and can be statically analyzed with upper bounds on computation resources prior to execution. +[Simplicity][2] is a typed, combinator-based, functional language without loops or recursion, developed to be an alternative to Bitcoin script that is formally specified, and can be statically analyzed with upper bounds on computation resources prior to execution. -SimplicityHL is a high-level language for writing Simplicity smart contracts. SimplicityHL looks and feels like [Rust](https://www.rust-lang.org), but is compiled to Simplicity bytecode. Developers write SimplicityHL transactions, which Bitcoin/Liquid nodes verify with the Simplicity script interpreter. +SimplicityHL is a high-level language for writing Simplicity smart contracts. SimplicityHL looks and feels like [Rust][3], but is compiled to Simplicity bytecode. Developers write SimplicityHL transactions, which Bitcoin/Liquid nodes verify with the Simplicity script interpreter. ## Features @@ -12,13 +12,13 @@ SimplicityHL is a high-level language for writing Simplicity smart contracts. Si - Compiler diagnostics, completion, hover, signature help, symbols, references, and go to definition - Opt-in imports and enums support in the language server and direct compiler commands -The extension installs or connects to the [SimplicityHL language server](https://github.com/BlockstreamResearch/simplicityhl-lsp), which provides language intelligence: +The extension installs or connects to the [SimplicityHL language server][4], which provides language intelligence: - Error diagnostics -![diagnostics](https://github.com/user-attachments/assets/54315645-464b-40c3-bb72-c6e8c4bc0ad5) +![diagnostics][6] - Completion of user-defined functions, imported items, built-ins, and jets -![completion](https://github.com/user-attachments/assets/bbc2b9de-c286-4d31-b47e-ac95885f8916) +![completion][7] ## Experimental features @@ -34,4 +34,13 @@ For local extension development, `simplicityhl.server.path` can point to a local ### Development -To install the extension manually or hack on the source code see [development.md](docs/development.md) +To install the extension manually or hack on the source code see [development.md][9] + +[1]: https://github.com/BlockstreamResearch/SimplicityHL +[2]: https://github.com/BlockstreamResearch/simplicity +[3]: https://www.rust-lang.org +[4]: https://github.com/BlockstreamResearch/simplicityhl-lsp +[5]: https://github.com/BlockstreamResearch/simfmt +[6]: https://raw.githubusercontent.com/BlockstreamResearch/simplicityhl-vscode/master/assets/error_diagnostic.gif +[7]: https://raw.githubusercontent.com/BlockstreamResearch/simplicityhl-vscode/master/assets/completion.gif +[8]: https://raw.githubusercontent.com/BlockstreamResearch/simplicityhl-vscode/master/docs/development.md \ No newline at end of file diff --git a/assets/completion.gif b/assets/completion.gif new file mode 100644 index 0000000..306d878 Binary files /dev/null and b/assets/completion.gif differ diff --git a/assets/error_diagnostic.gif b/assets/error_diagnostic.gif new file mode 100644 index 0000000..eddc166 Binary files /dev/null and b/assets/error_diagnostic.gif differ