update Zig and ZLS versions

The zls.wasm and zig.tar.gz have also been commited to source control.

Author: Techatrix

.github/workflows/deploy.yml

@@ -2,7 +2,7 @@ name: Deploy
 
 on:
   push:
-    branches: [ "main" ]
+    branches: ["main"]
   workflow_dispatch:
 
 permissions:
@@ -15,27 +15,18 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
-      - run: wget https://zig.pm/zls/downloads/wasm32-wasi/bin/zls.wasm -O src/zls.wasm
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 22
 
       - run: |
-          mkdir zigarchive
-          cd zigarchive
-          curl $(curl https://ziglang.org/download/index.json | jq .master.src.tarball -r) | xz -d | tar -xvf - --strip-components=1
-          cd ..
-          tar -cz zigarchive/lib/std > src/zig.tar.gz
-
-      - uses: actions/setup-node@v3
-        with:
-          node-version: 18
+          npm ci
+          npx parcel build 404.html
 
-      - run: npm ci
-      
-      - run: ./node_modules/.bin/parcel build 404.html
-      
-      - uses: actions/[email protected]
+      - uses: actions/upload-pages-artifact@v3
         with:
           path: "dist/"
 
-      - uses: actions/deploy-pages@v1.2.3
+      - uses: actions/deploy-pages@v4

.gitignore

@@ -1,7 +1,5 @@
 node_modules
 dist
 .parcel-cache
-zig.tar.gz
-zls.wasm
-zig_debug.wasm
 .env
+repos

README.md

@@ -1,15 +1,13 @@
-# zls in the browser
+# Zig and ZLS in the browser
 
 Works pretty well in a bunch of browsers, but note the required security headers.
 
 ## Installing
 
-* Compile zls for `wasm32-wasi` and place `zls.wasm` in `src`
-* Additionally, place `zig.tar.gz` (make sure that the name matches) from the website in `src`
-  * If you've downloaded Zig and built from source following `ZIG_WASM.md`, you can also use this command:
-    ```bash
-    tar -C /path/to/zig -cz lib/std >src/zig.tar.gz
-    ```
+You can either:
+
+- Use it online: https://playground.zigtools.org/
+- Run it locally:
 
 ```bash
 npm install
@@ -18,6 +16,24 @@ npm run serve
 
 Enjoy!
 
+### Update artifacts
+
+For the time being, the following artifacts have been commited to source control:
+
+- `src/zls.wasm` - A build of [ZLS](https://github.com/zigtools/zls) (ReleaseSmall, wasm32-wasi, VERSION_TBA)
+- `src/zig.wasm` - A build of [Zig](https://github.com/ziglang/zig) (ReleaseSmall, wasm32-wasi, 0.14.0 with `./zig.patch` applied)
+- `src/zig.tar.gz` - The source code of [Zig](https://github.com/ziglang/zig). Only the `lib/std` subdirectory is needed.
+
+The `./compile.sh` script can be used to create these artifacts:
+
+```bash
+./compile zls
+./compile zig
+./compile zig_tarball
+```
+
+Compiling Zig and ZLS may require different Zig compiler versions.
+
 ## TODOs
 
 - [ ] Stop using `SharedArrayBuffer`s (they're awesome but a nightmare to deploy)

ZIG_WASM.md

@@ -0,0 +1,99 @@
+#!/usr/bin/env bash
+
+# Requirements:
+# - zig
+# - jq
+# - tar
+# - wasm-opt (binaryen)
+
+set -e
+
+ZIG_SOURCE_TAG="0.14.0"
+ZIG_REQUIRED_COMPILER_VERSION="0.14.0"
+
+ZLS_SOURCE_COMMIT="f9b97383206c05626a21b0f24f89630aa91c072b"
+ZLS_REQUIRED_COMPILER_VERSION="0.15.0-dev.355+206bd1ced"
+
+if command -v zig >/dev/null 2>&1; then
+    ZIG_VERSION=$(zig version) 
+    echo "Found Zig $ZIG_VERSION"
+else
+    echo "zig is not installed or not in PATH"
+    exit 1
+fi
+
+if command -v jq >/dev/null 2>&1; then
+    echo "Found jq"
+else
+    echo "jq is not installed or not in PATH"
+    exit 1
+fi
+
+if command -v wasm-opt >/dev/null 2>&1; then
+    HAS_WASM_OPT=1;
+    echo "Found $(wasm-opt --version)"
+else
+    echo "wasm-opt is not installed or not in PATH"
+fi
+
+compile_zls() {
+    if [ "$ZIG_VERSION" != "$ZLS_REQUIRED_COMPILER_VERSION" ]; then
+        echo "ZLS must be compiled with Zig $ZLS_REQUIRED_COMPILER_VERSION but got $ZIG_VERSION"
+        exit 1
+    fi
+
+    if [ ! -d repos/zls ]; then
+        git clone https://github.com/zigtools/zls.git repos/zls
+        git -C repos/zls checkout --detach $ZLS_SOURCE_COMMIT
+    fi
+    ( cd repos/zls && zig build -Dtarget=wasm32-wasi -Doptimize=ReleaseSmall )
+    if [ -n "$HAS_WASM_OPT" ]; then
+        wasm-opt repos/zls/zig-out/bin/zls.wasm -o src/zls.wasm -O --enable-bulk-memory --enable-mutable-globals --enable-nontrapping-float-to-int --enable-sign-ext
+    else
+        cp repos/zls/zig-out/bin/zls.wasm src/zls.wasm
+    fi
+
+    echo "Created src/zls.wasm"
+}
+
+compile_zig() {
+    if [ "$ZIG_VERSION" != "$ZIG_REQUIRED_COMPILER_VERSION" ]; then
+        echo "Zig must be compiled with Zig $ZIG_REQUIRED_COMPILER_VERSION but got $ZIG_VERSION"
+        exit 1
+    fi
+
+    if [ ! -d repos/zig ]; then
+        git clone https://github.com/ziglang/zig.git repos/zig --branch $ZIG_SOURCE_TAG --depth 1
+        git -C repos/zig apply ../../zig.patch
+    fi
+    ( cd repos/zig && zig build -Dtarget=wasm32-wasi -Doptimize=ReleaseSmall -Dno-lib -Ddev=wasm)
+    if [ -n "$HAS_WASM_OPT" ]; then
+        wasm-opt repos/zig/zig-out/bin/zig.wasm -o src/zig.wasm -O --enable-bulk-memory --enable-mutable-globals --enable-nontrapping-float-to-int --enable-sign-ext
+    else
+        cp repos/zig/zig-out/bin/zig.wasm src/zig.wasm
+    fi
+
+    echo "Created src/zig.wasm"
+}
+
+create_zig_tarball() {
+    tar -czf src/zig.tar.gz -C $(zig env | jq .lib_dir -r)/.. lib/std
+
+    echo "Created src/zig.tar.gz"
+}
+
+case $1 in
+  "zls")
+    compile_zls
+    ;;
+  "zig")
+    compile_zig
+    ;;
+  "zig_tarball")
+    create_zig_tarball
+    ;;
+
+  *)
+    exit 1
+    ;;
+esac

compile.sh

@@ -227,11 +227,11 @@ export abstract class LspClient {
     public handleMessage(message: JsonRpcMessage) {
         if (message.method === "workspace/configuration") {
             const configParams = message.params as LSP.ConfigurationParams;
-            let resp: (string | null)[] = [];
+            let resp: unknown[] = [];
 
             for (const item of configParams.items) {
-                if (item.section === "zls.zig_lib_path") {
-                    resp.push("/lib");
+                if (item.section === "zls.prefer_ast_check_as_child_process") {
+                    resp.push(false);
                 } else {
                     resp.push(null);
                 }

src/lsp/index.ts

@@ -1,7 +1,7 @@
 import { WASI, PreopenDirectory, Fd, File, ConsoleStdout, OpenFile, Inode } from "@bjorn3/browser_wasi_shim";
 import { getLatestZigArchive } from "../utils";
 // @ts-ignore
-import zlsWasm from "url:../zig_release.wasm";
+import zlsWasm from "url:../zig.wasm";
 
 let currentlyRunning = false;
 async function run(source: string) {
@@ -14,7 +14,15 @@ async function run(source: string) {
     // -fno-llvm -fno-lld is set explicitly to ensure the native WASM backend is
     // used in preference to LLVM. This may be removable once the non-LLVM
     // backends become more mature.
-    let args = ["zig.wasm", "build-exe", "main.zig", "-Dtarget=wasm32-wasi", "-fno-llvm", "-fno-lld"];
+    let args = [
+        "zig.wasm",
+        "build-exe",
+        "main.zig",
+        "-fno-llvm",
+        "-fno-lld",
+        "-fno-ubsan-rt",
+        "-fno-entry", // prevent the native webassembly backend from adding a start function to the module 
+    ];
     let env = [];
     let fds = [
         new OpenFile(new File([])), // stdin

src/workers/zig.ts

@@ -74,15 +74,15 @@ onmessage = (event) => {
 (async () => {
     let libDirectory = await getLatestZigArchive();
 
-    let args = ["zls.wasm", "--enable-debug-log"];
+    let args = ["zls.wasm"];
     let env = [];
     let fds = [
         new Stdio(StdioKind.stdin), // stdin
         new Stdio(StdioKind.stdout), // stdout
         ConsoleStdout.lineBuffered((line) => postMessage({ stderr: line })), // stderr
-        new PreopenDirectory(".", new Map([
-            ["lib", new Directory(libDirectory.contents)]
-        ])),
+        new PreopenDirectory(".", new Map([])),
+        new PreopenDirectory("/lib", libDirectory.contents),
+        new PreopenDirectory("/cache", new Map()),
     ];
     let wasi = new WASI(args, env, fds, { debug: false });