aboutsummaryrefslogtreecommitdiff
path: root/vendor/libghostty-vt/PACKAGING.md
diff options
context:
space:
mode:
authorCan Celik <ogulcancelik@gmail.com>2026-09-10 21:51:57 +0300
committerGitHub <noreply@github.com>2026-09-10 21:51:57 +0300
commit425c86179791cd32e2d4ce0ae7f269940b4b0663 (patch)
treee52c4383a6d69216cbe2a32638bf90841d7e2189 /vendor/libghostty-vt/PACKAGING.md
parent90e947a6e26e02f10ec7f1694c4eb5b78a86406b (diff)
chore: upgrade libghostty and preserve terminal behavior (#3906)
Diffstat (limited to 'vendor/libghostty-vt/PACKAGING.md')
-rw-r--r--vendor/libghostty-vt/PACKAGING.md53
1 files changed, 53 insertions, 0 deletions
diff --git a/vendor/libghostty-vt/PACKAGING.md b/vendor/libghostty-vt/PACKAGING.md
index 1483b859..8cb42251 100644
--- a/vendor/libghostty-vt/PACKAGING.md
+++ b/vendor/libghostty-vt/PACKAGING.md
@@ -122,3 +122,56 @@ relevant to package maintainers:
often necessary for system packages to specify a specific minimum Linux
version, glibc, etc. Run `zig targets` to a get a full list of available
targets.
+
+## WebAssembly (libghostty-vt)
+
+libghostty-vt can be built for WebAssembly for use in browsers and other
+wasm runtimes:
+
+```sh
+zig build -Demit-lib-vt -Dtarget=wasm32-freestanding -Doptimize=ReleaseSmall
+```
+
+This produces `zig-out/bin/ghostty-vt.wasm`.
+
+Some notes for packaging the wasm module:
+
+- The build enables the `simd128` feature by default. Every browser engine
+ has supported it for years (Chrome 91, Firefox 89, Safari 16.4) and it is
+ a large performance win for VT parsing. If you target an unusual runtime
+ without SIMD support, opt out with `-Dcpu=generic`.
+
+- Optional feature areas can be compiled out with `-Dvt-features` to
+ significantly reduce binary size. The flag takes comma-separated
+ modifications applied to the default all-enabled feature set,
+ `-Dcpu`-style: `+feature` (or bare `feature`) enables, `-feature`
+ disables, and the special name `all` refers to every feature. Hyphens
+ and underscores are interchangeable in feature names. For example, a
+ read-only terminal viewer only needs the render state API:
+
+ ```sh
+ zig build -Demit-lib-vt -Dtarget=wasm32-freestanding \
+ -Doptimize=ReleaseSmall -Dvt-features=-all,+render-state
+ ```
+
+ This roughly halves the compressed module size versus the default
+ build. An interactive terminal typically wants
+ `-Dvt-features=-all,+render-state,+input-encode,+selection,+color`.
+ Disabled features drop both their C API exports and any escape
+ sequence handling (the sequences are still consumed and safely
+ ignored). See the `Features` struct in `src/terminal/build_options.zig`
+ for the full list of features and what each one covers.
+
+- `ReleaseSmall` is the recommended optimization mode for the web. Running
+ the result through [Binaryen's](https://github.com/WebAssembly/binaryen)
+ `wasm-opt -O3` shrinks it by roughly a further 10% without hurting
+ performance.
+
+- `ReleaseFast` measures 10-20% faster than `ReleaseSmall` on escape-heavy
+ terminal workloads, but the artifact is dominated by DWARF debug info.
+ If you want the speed, strip it: `wasm-opt -O3 --strip-dwarf` reduces a
+ ReleaseFast build from over 5MB to roughly 1.1MB (versus roughly 0.8MB
+ for ReleaseSmall). When invoking `wasm-opt`, pass the feature flags for
+ what the module uses, e.g. `--enable-simd --enable-bulk-memory
+--enable-sign-ext --enable-nontrapping-float-to-int --enable-multivalue
+--enable-reference-types`.