convex-rust 0.1.0 → 0.1.2

package/README.md

@@ -9,7 +9,8 @@ Spec: `contracts/V8HOST.md` (guest ABI: `contracts/ABI.md`, manifest: `contracts
 
 ## Quickstart
 
-In an existing Convex project (`npx convex dev` has been run once, so `convex/_generated` and a deployment exist),
+In an existing, configured Convex project (`npx convex dev` has been run once, which creates/links the deployment and
+`convex/_generated`; or, for CI / deploy-key users, `CONVEX_DEPLOY_KEY` is set in the environment),
 with [rustup](https://rustup.rs) installed:
 
 ```sh
@@ -27,7 +28,8 @@ comes from that file; if toolchain or target is missing `build` shows the exact
 asks `Run ... now? (Y/n)` (never silently; with no TTY it just fails with the command).
 `npx convex-rust doctor` checks cargo, rustup, toolchain + target, the shipped `convex_fn` crate and `wasm-opt`.
 `wasm-opt` (binaryen, `brew install binaryen`) is optional: it makes release wasm about 30% smaller (`-O3`).
-Wasm SIMD is on by default (`--no-simd` to opt out). Instance reuse, `CONVEX_RUST_TRACE` and build flags: docs/rust/cloud.md.
+The first `build` downloads the crates (and, only if a dependency compiles C code, the ~180 MB wasi-sdk), so it can take a
+few minutes; later builds take seconds. Wasm SIMD is on by default (`--no-simd` to opt out). Instance reuse, `CONVEX_RUST_TRACE` and build flags: docs/rust/cloud.md.
 
 The scaffolded crate depends on `convex_fn` by path into `node_modules/convex-rust/rust/convex_fn` (shipped in this
 package; nothing is fetched from crates.io for it). Commit `convex/rust/Cargo.lock`, `src/_generated/api.rs` and
@@ -124,6 +126,14 @@ surfaces as `Uncaught Error: <panic message> at file:line`.
 
 See `docs/rust/cloud.md` for the full guide.
 
+## Troubleshooting
+
+- `ExperimentalWarning: localStorage is not available because --localstorage-file was not provided` on every `convex`
+  command comes from the stock `convex` CLI on newer Node (webstorage) and is harmless. Silence it with
+  `NODE_OPTIONS=--no-experimental-webstorage`.
+- npm 11 `install-scripts ... esbuild ... not yet covered by allowScripts` comes from `convex`'s own esbuild dependency and
+  is harmless (its postinstall is only an optimization). To silence it: `npm install-scripts approve esbuild`.
+
 ## Limitations
 
 - Convex default-runtime limits apply (30 minute actions, 64 MiB RAM documented, code size per the [limits page](https://docs.convex.dev/production/state/limits), actions only, no `"use node"`).

package/dist/cli/bin.js

@@ -164,8 +164,8 @@ async function main(argv) {
             console.error([
                 "",
                 "Next:",
-                "  npx convex-rust build        # compiles the crate (first build downloads crates, ~1 min), writes the wasm + TS wrappers",
-                "  npx convex dev --once        # pushes it (or: npx convex deploy). Needs a configured project: run `npx convex dev` once first.",
+                "  npx convex-rust build        # compiles the crate, writes the wasm + TS wrappers (the first build downloads crates and can take a few minutes; later builds take seconds)",
+                "  npx convex dev --once        # pushes it (or: npx convex deploy). Needs a configured Convex project: run `npx convex dev` once (creates/links one), or set CONVEX_DEPLOY_KEY (CI).",
                 `  npx convex run rust/example:greet '{"name":"you"}'`,
                 "",
                 `While editing Rust, run \`npx convex-rust dev\` next to \`npx convex dev\`. Commit ${rel}/Cargo.lock and ${rel}/src/_generated/api.rs.`,

package/package.json

@@ -1,8 +1,17 @@
 {
   "name": "convex-rust",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "\"use rust\" for stock Convex: write Convex actions in Rust, compiled to wasm and hosted inside a normal Convex action (cloud or self-hosted).",
   "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/toomingos/convex-rust.git",
+    "directory": "packages/convex-rust"
+  },
+  "homepage": "https://github.com/toomingos/convex-rust/tree/main/packages/convex-rust#readme",
+  "bugs": {
+    "url": "https://github.com/toomingos/convex-rust/issues"
+  },
   "keywords": [
     "convex",
     "rust",