Merge pull request #7 from dhil/wasmfx-merge

Merge with upstream

Author: dhil

.github/workflows/main.yml

@@ -60,6 +60,8 @@ jobs:
     runs-on: ${{ matrix.os }}
     steps:
     - uses: actions/checkout@v4
+      with:
+        submodules: true
     - name: Install Rust
       run: rustup update stable --no-self-update && rustup default stable
     - name: Install wasm32-unknown-unknown target

.gitmodules

@@ -0,0 +1,15 @@
+[submodule "tests/codegen/wasi-filesystem"]
+	path = tests/codegen/wasi-filesystem
+	url = https://github.com/WebAssembly/wasi-filesystem
+[submodule "tests/codegen/wasi-http"]
+	path = tests/codegen/wasi-http
+	url = https://github.com/WebAssembly/wasi-http
+[submodule "tests/codegen/wasi-cli"]
+	path = tests/codegen/wasi-cli
+	url = https://github.com/WebAssembly/wasi-cli
+[submodule "tests/codegen/wasi-io"]
+	path = tests/codegen/wasi-io
+	url = https://github.com/WebAssembly/wasi-io
+[submodule "tests/codegen/wasi-clocks"]
+	path = tests/codegen/wasi-clocks
+	url = https://github.com/WebAssembly/wasi-clocks

Cargo.lock

@@ -18,7 +18,7 @@ resolver = "2"
 
 [workspace.package]
 edition = "2021"
-version = "0.23.0"
+version = "0.24.0"
 
 [workspace.dependencies]
 anyhow = "1.0.72"
@@ -34,14 +34,14 @@ wasm-encoder  = { git = "https://github.com/wasmfx/wasmfx-tools", tag = "v1.202.
 wit-parser    = { git = "https://github.com/wasmfx/wasmfx-tools", tag = "v1.202.0" }
 wit-component = { git = "https://github.com/wasmfx/wasmfx-tools", tag = "v1.202.0" }
 
-wit-bindgen-core = { path = 'crates/core', version = '0.23.0' }
-wit-bindgen-c = { path = 'crates/c', version = '0.23.0' }
-wit-bindgen-rust = { path = "crates/rust", version = "0.23.0" }
-wit-bindgen-teavm-java = { path = 'crates/teavm-java', version = '0.23.0' }
-wit-bindgen-go = { path = 'crates/go', version = '0.23.0' }
-wit-bindgen-csharp = { path = 'crates/csharp', version = '0.23.0' }
-wit-bindgen-markdown = { path = 'crates/markdown', version = '0.23.0' }
-wit-bindgen = { path = 'crates/guest-rust', version = '0.23.0', default-features = false }
+wit-bindgen-core = { path = 'crates/core', version = '0.24.0' }
+wit-bindgen-c = { path = 'crates/c', version = '0.24.0' }
+wit-bindgen-rust = { path = "crates/rust", version = "0.24.0" }
+wit-bindgen-teavm-java = { path = 'crates/teavm-java', version = '0.24.0' }
+wit-bindgen-go = { path = 'crates/go', version = '0.24.0' }
+wit-bindgen-csharp = { path = 'crates/csharp', version = '0.24.0' }
+wit-bindgen-markdown = { path = 'crates/markdown', version = '0.24.0' }
+wit-bindgen = { path = 'crates/guest-rust', version = '0.24.0', default-features = false }
 
 [[bin]]
 name = "wit-bindgen"

Cargo.toml

@@ -320,15 +320,13 @@ e.g. Java, Kotlin, Clojure, Scala, etc.
 
 ### Guest: TinyGo
 
-Go code can be compiled for the `wasm32-wasi` target using the [TinyGo](https://tinygo.org/) compiler. For example, the following command compiles `main.go` to a wasm modules with WASI support:
+You can compile Go code into a Wasm module using the [TinyGo](https://tinygo.org/) compiler. For example, the following command compiles `main.go` to a WASI module:
 
 `tinygo build -target=wasi main.go`
 
-> Note: the current TinyGo bindgen only supports TinyGo version v0.27.0 or later.
+> Note: the current TinyGo `bindgen` requires TinyGo version v0.27.0 or later.
 
-To start in Go a `*.go` and `*.h` C header file are generated for your
-project to use. These files are generated with the [`wit-bindgen` CLI
-command][cli-install] in this repository.
+When using `wit-bindgen tiny-go` bindgen, `*.go` and `*.h` C header file are generated for your project. These files are generated with the [`wit-bindgen` CLI command][cli-install] in this repository.
 
 ```sh
 wit-bindgen tiny-go ./wit
@@ -338,35 +336,42 @@ wit-bindgen tiny-go ./wit
 # Generating "host_component_type.o"
 ```
 
-If your Go code uses `result` or `option` type, a second Go file `host_types.go` will be generated. This file contains the Go types that correspond to the `result` and `option` types in the WIT file.
+If your Go code uses `result` or `option` type, an additional Go file `host_types.go` will be generated. This file contains the Go types that correspond to the `result` and `option` types in the WIT file.
 
-Some example code using this would then look like
+An example of using the generated Go code would look like:
+
+Initialize Go:
+```bash
+go mod init example.com
+```
+
+Create your Go main file:
 
 ```go
 // my-component.go
 package main
 
 import (
-    gen "host/gen"
+	api "example.com/api"
 )
 
 func init() {
     a := HostImpl{}
-    gen.SetHost(a)
+    api.SetHost(a)
 }
 
 type HostImpl struct {
 }
 
 func (e HostImpl) Run() {
-  gen.Print("Hello, world!")
+  api.HostPrint("Hello, world!")
 }
 
-//go:generate wit-bindgen tiny-go ../wit --out-dir=gen
+//go:generate wit-bindgen tiny-go wit --out-dir=api
 func main() {}
 ```
 
-This can then be compiled with `tinygo` and assembled into a component with:
+This setup allows you to invoke `go generate`, which generates the bindings for the Go code into an `api` directory. Afterward, you can compile your Go code into a WASI module using the TinyGo compiler. Lastly you can componentize the module using `wasm-tools`:
 
 ```sh
 go generate # generate bindings for Go

README.md

@@ -56,6 +56,11 @@ macro_rules! codegen_test {
                         "worlds-with-types",
                         "variants-unioning-types",
                         "go_params",
+                        "wasi-cli",
+                        "wasi-clocks",
+                        "wasi-filesystem",
+                        "wasi-http",
+                        "wasi-io",
                     ]
                     .contains(&$name)
                     {