Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 676 Commits
.cargo		.cargo
.github		.github
crates		crates
docs		docs
examples		examples
packages		packages
scripts		scripts
submodules		submodules
.gitignore		.gitignore
.gitmodules		.gitmodules
.npmrc		.npmrc
.prettierignore		.prettierignore
CODEOWNERS		CODEOWNERS
CODE_OF_CONDUCT.md		CODE_OF_CONDUCT.md
Cargo.lock		Cargo.lock
Cargo.toml		Cargo.toml
LICENSE		LICENSE
ORG_CODE_OF_CONDUCT.md		ORG_CODE_OF_CONDUCT.md
README.md		README.md
commitlint.config.mjs		commitlint.config.mjs
eslint.config.mjs		eslint.config.mjs
justfile		justfile
package-lock.json		package-lock.json
package.json		package.json
prettier.config.mjs		prettier.config.mjs
rust-toolchain.toml		rust-toolchain.toml

Repository files navigation

`jco`

JavaScript tooling forWebAssembly Components

ABytecode Alliance project

Contributing |Chat on Zulip

Overview

Jco (jco) provides aJavascript-native toolchain for working withWebAssembly Components.

Jco aims to be a convenient multi-tool for the JS WebAssembly ecosystem.

With Jco (and related projects in this repository), you can:

Build WebAssembly components from Javascript/Typescript with the help ofcomponentize-js
"Transpile" WebAssembly components into ES modules that can run in environments like NodeJS and the browser, combining platform-native WebAssembly core support with the advanced features of WebAssembly Components
Run WebAssembly components whether single-shot applications or web servers (similar towasmtime run/wasmtime serve)
Reuse WebAssembly component workflows (e.g. building components, tranpsiling, etc) from your own JS projects
Utilizewasm-tools as a library from JS

Organization

As Jco aims to do many things, it contains many subprojects that are organized in this repository:

Subproject	Language	Directory	Description
`jco`	Javascript	`packages/jco`	The`jco` CLI
`jco-transpile`	Javascript	`packages/jco-transpile`	WebAssembly Component Transpilation functionaltiy
`preview2-shim`	Javascript	`packages/preview2-shim`	Library that provides a mapping ofWASI Preview 2 for NodeJS and Browsers
`preview3-shim`	Javascript	`packages/preview3-shim`	Library that provides a mapping of WASI Preview 3 for NodeJS
`js-component-bindgen`	Rust	`crates/js-component-bindgen`	Enables`jco transpile` and other features, reusing the Rust WebAssembly ecosystem
`js-component-bindgen-component`	Rust	`crates/js-component-bindgen-component`	WebAssembly component that (when transipled) makes`js-component-bindgen` available in JS`jco`
`wasm-tools-component`	Rust	`crates/wasm-tools-component`	WebAssembly component containing pieces of`wasm-tools` used by`jco`

Quickstart

Jco can be used as either a library import or as a CLI via thejco command.

To install it, usenpm (or your favoritenpm equivalent):

npm install @bytecodealliance/jco

Note

If you're using jco to build components, you should also installcomponentize-js, which is dynamically imported:

npm install @bytecodealliance/componentize-js

Building an example component

For instructions on how to build an example component, see theComponent model section on Javascript.

To see examples of common patterns, check out theexample components folder (examples/components).

Learn more

For a deeper guide on the intricacies of Jco, read theJco Book.

License

This project is licensed under the Apache 2.0 license with the LLVM exception.SeeLICENSE for more details.

Contributing

See theContributing chapter of the Jco book.

Unless you explicitly state otherwise, any contribution intentionally submittedfor inclusion in this project by you, as defined in the Apache-2.0 license,shall be licensed as above, without any additional terms or conditions.