Guides

Contributing

The justfile, the Node test servers, CI and the docs site.

Every task is a just recipe; just lists them. CI runs the same recipes.

cargo install just cargo-hack cargo-nextest cargo-deny cargo-shear cargo-semver-checks cargo-sweep
just servers-setup   # npm packages of the Node test servers, test certificates
just servers         # start them (ports 4200-4206, 4210-4213; no Docker)
just ci              # fmt, cargo-shear + clippy per feature set, tests, docs, cargo-deny, package, plugin
just servers-stop
RecipeWhat
just testall tests (cargo nextest) and doctests, then the crate per feature
just test-offlinethe codec models and the unit tests that need no server
just load [clients] [events] [transport]many clients and events against a plain socket.io 4.8 server, then the in-process fake; every reply checked
just pluginthe Tauri plugin: Rust tests and guest-js (typecheck, vitest, build); needs pnpm
just plugin-examplebuilds the example Tauri app
just msrvthe crate and the plugin on Rust 1.85 with a lockfile resolved for it
just example <name>runs an example from examples/src/bin
just docs-dev / just docs-buildthis documentation site

Tests

Models (proptest), stories and the differential corpus, one test binary per crate (tests/it/); TESTING.md in the repository has the layout and the rules. Most stories run against the in-process fake servers of socketio-next-testing; the Node servers are needed for the differential tests, recovery, cookies and TLS.

CI

Every push to main and every pull request runs the tests on Linux, macOS and Windows, plus fmt, docs, cargo-deny, the package check and MSRV. A manual run (Actions → CI → Run workflow) with an empty version runs the extended checks; with a version it releases (PUBLISHING.md).

Documentation site

The site lives in docs/ (Nuxt, Nuxt Content, Nuxt UI) and is not part of the Cargo workspace or the published packages. Pages are Markdown under docs/content/; the changelogs and MSRV page are copied from the repository root by docs/scripts/sync.mjs.

just docs-dev     # http://localhost:3000
just docs-build   # static site in docs/.output/public

It is deployed to GitHub Pages by the docs workflow, which only runs by hand (Actions → docs → Run workflow).