Merge BlockstreamResearch#123: Add VSCode extension with syntax highlighter

86971c8 Add VSCode extension with syntax highlighter (Michael Zaikin)

Pull request description:

  This PR adds a minimal extension for VSCode that highlights *.simf files and also enables basic things like auto commenting/uncommenting (when you press cmd+/).

ACKs for top commit:
  apoelstra:
    ACK 86971c8; successfully ran local tests

Tree-SHA512: 5e4f5e38fc5e2087fdf61c795bd46ff985ae054b7e6b66ae1197c6d4a9bd1507f3bcb228708dea8c8f451dba14e3868a893eda9146c1dd7cc41a172c4d1cbdce

Author: apoelstra

.gitignore

@@ -18,3 +18,9 @@ target/
 
 # mdbook HTML output dir
 book/book/
+
+# Node.js modules
+node_modules/
+
+# VSCode extension package
+*.vsix

README.md

@@ -65,3 +65,7 @@ The compiler produces a base64-encoded Simplicity program. Witness data will be
 ```bash
 ./target/debug/simc examples/test.simf examples/test.wit
 ```
+
+### VSCode extension
+
+See the installation [instructions](./vscode/README.md).

vscode/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Simfony contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE. 

vscode/README.md

@@ -0,0 +1,77 @@
+# Simfony extension for VSCode
+
+VSCode extension that provides syntax highlighting for the [Simfony](https://docs.simfony.dev/) programming language.
+
+## Features
+
+- Syntax highlighting for .simf files
+- Basic language configuration (brackets, comments)
+
+## Installation
+
+Install Node.js (v14 or later recommended).
+
+### Local Installation
+
+1. Clone this repository
+2. Navigate to the extension directory:
+   ```bash
+   cd vscode
+   ```
+3. Install dependencies:
+   ```bash
+   npm install
+   ```
+4. Package the extension:
+   ```bash
+   npm install -g @vscode/vsce
+   vsce package
+   ```
+   This will create a `.vsix` file in the current directory.
+
+5. Install the extension in VSCode:
+   - Launch VS Code
+   - Go to the Extensions view (Ctrl+Shift+X)
+   - Click on the "..." menu in the top-right of the Extensions view
+   - Select "Install from VSIX..."
+   - Navigate to and select the `.vsix` file you created
+
+### Alternative Installation Method
+
+You can also install the extension directly from the source code:
+
+1. Copy the `vscode` folder (rename it if necessary) to your VSCode extensions directory:
+   - Windows: `%USERPROFILE%\.vscode\extensions`
+   - macOS/Linux: `~/.vscode/extensions`
+
+2. Restart VSCode
+
+## Development
+
+1. Clone this repository and cd into `vscode` directory
+2. Run `npm install`
+3. Open the project in VS Code
+4. Press F5 to start debugging (this will launch a new VSCode window with the extension loaded)
+5. Make changes to the extension
+6. Reload the debugging window to see your changes (Ctrl+R or Cmd+R)
+
+### Reloading the Extension During Development
+
+When making changes to the extension, you can reload it without uninstalling and reinstalling:
+
+1. **Using the Command Palette**:
+   - Press `Ctrl+Shift+P` (or `Cmd+Shift+P` on macOS)
+   - Type "Developer: Reload Window" and select it
+
+2. **Using keyboard shortcut**:
+   - Press `Ctrl+R` (or `Cmd+R` on macOS)
+
+3. **For extensions installed from folder**:
+   - Make your changes to the extension files
+   - Run the "Developer: Reload Window" command as described above
+   - VSCode will reload with the updated extension
+
+4. **For more substantial changes**:
+   - If you've made significant changes to the extension's structure or manifest
+   - You may need to restart VSCode completely (close and reopen)
+   - In some cases, you might need to run the command "Developer: Restart Extension Host"

vscode/language-configuration.json

@@ -0,0 +1,22 @@
+{
+    "comments": {
+        "lineComment": "//"
+    },
+    "brackets": [
+        ["{", "}"],
+        ["[", "]"],
+        ["(", ")"]
+    ],
+    "autoClosingPairs": [
+        { "open": "{", "close": "}" },
+        { "open": "[", "close": "]" },
+        { "open": "(", "close": ")" },
+        { "open": "\"", "close": "\"" }
+    ],
+    "surroundingPairs": [
+        ["{", "}"],
+        ["[", "]"],
+        ["(", ")"],
+        ["\"", "\""]
+    ]
+} 

vscode/package-lock.json

@@ -0,0 +1,31 @@
+{
+  "name": "simfony-language",
+  "displayName": "Simfony Language Support",
+  "description": "Syntax highlighting and autocompletion for Simfony language",
+  "version": "0.0.1",
+  "publisher": "blockstream",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/BlockstreamResearch/simfony"
+  },
+  "engines": {
+    "vscode": "^1.85.0"
+  },
+  "categories": [
+    "Programming Languages"
+  ],
+  "contributes": {
+    "languages": [{
+      "id": "simfony",
+      "aliases": ["Simfony", "simfony"],
+      "extensions": [".simf"],
+      "configuration": "./language-configuration.json"
+    }],
+    "grammars": [{
+      "language": "simfony",
+      "scopeName": "source.simfony",
+      "path": "./syntaxes/simfony.tmLanguage.json"
+    }]
+  },
+  "license": "MIT"
+}