ruby_wasm 2.5.0.pre.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7ae1888b47708e127d63f9ca22d6c3b0e052bf8e466c3ca6e732966ed17efa5f
+  data.tar.gz: 818a32d985fa7bd2c25dadda8990ca7d399731bb0cd6f643f74f7082db87fe66
+SHA512:
+  metadata.gz: a9e2266baeaca22fd6b76151105707bec020907f312f310f6d177e57e37bf520bb514b7166f65bd7780281b858d0b2c1a4a39605fe5d852074222c386b4c4f43
+  data.tar.gz: 56ccd07cea6b6c18f8401ef3a7e222de3586b8279054d58ee8af7140fde0cb3809439450bf18c98cae8e7d8a41449814f7d0d18df4ff5744ccc3517d831e0796

data/.clang-format

@@ -0,0 +1,8 @@
+---
+Language: Cpp
+BasedOnStyle: LLVM
+IndentPPDirectives: AfterHash
+---
+Language: JavaScript
+DisableFormat: true
+---

data/CONTRIBUTING.md

@@ -0,0 +1,124 @@
+# How to Contribute
+
+Thank you for your interest in contributing to ruby.wasm!
+This document describes development setup and pointers for diving into this project.
+
+## Install dependencies
+
+```console
+$ git clone https://github.com/ruby/ruby.wasm
+$ cd ruby.wasm
+$ ./bin/setup
+$ rake --tasks
+```
+
+## Building and Testing [`ruby-wasm-wasi`](./packages/npm-packages/ruby-wasm-wasi)
+
+```console
+# Download a prebuilt Ruby release (if you don't need to re-build Ruby)
+$ rake build:download_prebuilt
+
+# Build Ruby (if you need to build Ruby by yourself)
+$ rake build:head-wasm32-unknown-wasi-full-js-debug
+
+# Build npm package
+$ rake npm:ruby-head-wasm-wasi
+# Test npm package
+$ rake npm:ruby-head-wasm-wasi:check
+```
+
+If you need to re-build Ruby, please clean `./rubies` directory, and run `rake npm:ruby-head-wasm-wasi` again.
+
+## Building CRuby from source
+
+If you want to build CRuby for WebAssembly from source yourself, follow the below instructions.
+
+> **Warning**
+> If you just want to build npm packages, you don't need to build CRuby from source.
+> You can download a prebuilt Ruby release by `rake build:download_prebuilt`.
+
+### For WASI target
+
+You can build CRuby for WebAssembly/WASI on Linux (x86_64) or macOS (x86_64, arm64).
+For WASI target, dependencies are automatically downloaded on demand, so you don't need to install them manually.
+
+To select a build profile, see [profiles section in README](https://github.com/ruby/ruby.wasm#profiles).
+
+```console
+# Build only a specific combination of ruby version, profile, and target
+$ rake build:head-wasm32-unknown-wasi-full
+# Clean up the build directory
+$ rake build:head-wasm32-unknown-wasi-full:clean
+# Force to re-execute "make install"
+$ rake build:head-wasm32-unknown-wasi-full:remake
+
+# Output is in the `rubies` directory
+$ tree -L 3 rubies/head-wasm32-unknown-wasi-full-js
+rubies/head-wasm32-unknown-wasi-full-js/
+├── usr
+│   └── local
+│       ├── bin
+│       ├── include
+│       ├── lib
+│       └── share
+```
+
+### For Emscripten target
+
+To build CRuby for WebAssembly/Emscripten, you need to install [Emscripten](https://emscripten.org).
+Please follow the official instructions to install.
+
+```console
+# Build only a specific combination of ruby version, profile, and target
+$ rake build:head-wasm32-unknown-emscripten-full-js
+# Output is in the `rubies` directory
+$ tree -L 3 rubies/head-wasm32-unknown-emscripten-full-js
+rubies/head-wasm32-unknown-emscripten-full
+└── usr
+    └── local
+        ├── bin
+        ├── include
+        ├── lib
+        └── share
+```
+
+## Code Formatting
+
+This project uses multiple code formatters for each language.
+To format all files, run `rake format`.
+Please make sure to run this command before submitting a pull request.
+
+## Re-bindgen from `.wit` files
+
+If you update [`*.wit`](https://github.com/WebAssembly/component-model/blob/ed90add27ae845b2e2b9d7db38a966d9f78aa4c0/design/mvp/WIT.md), which describe the interface of a WebAssembly module, either imported or exported, you need to re-generate glue code from `*.wit`.
+
+To re-generate them, you need to install the Rust compiler `rustc` and Cargo, then run `rake check:bindgen`.
+
+The rake task installs [`wit-bindgen`](https://github.com/bytecodealliance/wit-bindgen) on demand, then just execute it for each generated code
+
+If you see `missing executable: cargo`, please make sure `cargo` is installed correctly in your `PATH`.
+
+## Release Process
+
+To bump up npm package version, please follow the below steps:
+
+```
+$ rake 'bump_version[0.6.0]'
+$ git commit -m"Bump version to 0.6.0"
+$ git tag 0.6.0
+$ git push origin 0.6.0
+```
+
+## Release Channels
+
+Each npm package in this project provides two release channels: `latest` and `next`. The `latest` channel is for stable releases, and `next` channel is for pre-release.
+
+e.g. For [`@ruby/wasm-wasi`](https://www.npmjs.com/package/@ruby/wasm-wasi)
+
+```console
+$ npm install --save @ruby/wasm-wasi@latest
+# or if you want the nightly snapshot
+$ npm install --save @ruby/wasm-wasi@next
+# or you can specify the exact snapshot version
+$ npm install --save @ruby/wasm-wasi@2.4.1-2023-12-25-a
+```