Merge pull request #1 from USTC-KnowledgeComputingLab/copilot/create-deno-hello-world

Add Deno WASM example with Rust hello world library

Author: hzhangxyz

.gitignore

@@ -0,0 +1,9 @@
+# Rust
+/target
+
+# WASM build artifacts (committed for convenience)
+# Uncomment the line below if you don't want to commit the pkg directory
+# /pkg
+
+# Cargo.lock is committed for this example project
+# For library crates, you may want to add it to .gitignore

Cargo.lock

@@ -0,0 +1,16 @@
+[package]
+name = "javascript-library-in-rust-example"
+version = "0.1.0"
+edition = "2021"
+
+[lib]
+crate-type = ["cdylib", "rlib"]
+
+[package.metadata.wasm-pack.profile.release]
+wasm-opt = false
+
+[dependencies]
+wasm-bindgen = "0.2.106"
+
+[profile.release]
+opt-level = "s"

Cargo.toml

@@ -1 +1,144 @@
-# javascript-library-in-rust-example
+# JavaScript Library in Rust Example
+
+A simple example demonstrating how to create a Rust library that can be used in JavaScript/TypeScript via WebAssembly (WASM), specifically designed for Deno.
+
+## Overview
+
+This project showcases:
+- Writing a Rust library with exported functions
+- Compiling Rust to WebAssembly using `wasm-pack`
+- Using the WASM module in Deno with TypeScript
+
+## Project Structure
+
+```
+.
+├── Cargo.toml                 # Rust project configuration
+├── src/
+│   └── lib.rs                 # Rust source code with exported functions
+├── pkg/                       # Generated WASM package (after build)
+│   ├── javascript_library_in_rust_example.js
+│   ├── javascript_library_in_rust_example.d.ts
+│   └── javascript_library_in_rust_example_bg.wasm
+└── examples/
+    └── deno/
+        ├── deno.json          # Deno configuration
+        └── example.ts         # Deno example using the WASM library
+```
+
+## Prerequisites
+
+- [Rust](https://www.rust-lang.org/tools/install) (1.56 or later)
+- [wasm-pack](https://rustwasm.github.io/wasm-pack/installer/) - Build tool for Rust WASM
+- [Deno](https://deno.land/) - JavaScript/TypeScript runtime
+
+### Installation
+
+```bash
+# Install Rust (if not already installed)
+curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
+
+# Install wasm-pack
+cargo install wasm-pack
+
+# Install Deno
+curl -fsSL https://deno.land/x/install/install.sh | sh
+```
+
+## Building the WASM Library
+
+Build the Rust library to WebAssembly:
+
+```bash
+wasm-pack build --target deno
+```
+
+This will:
+1. Compile the Rust code to WebAssembly
+2. Generate JavaScript bindings
+3. Generate TypeScript definitions
+4. Place everything in the `pkg/` directory
+
+## Available Functions
+
+The library exports three simple functions:
+
+- `hello()`: Returns a "Hello, World!" message
+- `greet(name: string)`: Returns a personalized greeting
+- `add(a: number, b: number)`: Adds two numbers together
+
+## Running the Deno Example
+
+After building the WASM library, run the example:
+
+```bash
+cd examples/deno
+deno run --allow-read example.ts
+```
+
+Or using the Deno task:
+
+```bash
+cd examples/deno
+deno task dev
+```
+
+### Expected Output
+
+```
+=== Rust WASM Library Demo in Deno ===
+
+1. Calling hello():
+   Hello, World from Rust WASM!
+
+2. Calling greet('Deno'):
+   Hello, Deno! Welcome to Rust WASM in Deno!
+
+3. Calling add(5, 7):
+   Result: 12
+
+4. More examples:
+   greet('World') = Hello, World! Welcome to Rust WASM in Deno!
+   add(10, 20) = 30
+   add(-5, 5) = 0
+
+✅ All examples completed successfully!
+```
+
+## Development
+
+### Running Tests
+
+Test the Rust code:
+
+```bash
+cargo test
+```
+
+### Modifying the Library
+
+1. Edit `src/lib.rs` to add or modify functions
+2. Rebuild with `wasm-pack build --target deno`
+3. The changes will be available in the `pkg/` directory
+
+## How It Works
+
+1. **Rust Code**: Functions in `src/lib.rs` are marked with `#[wasm_bindgen]` to export them to JavaScript
+2. **Compilation**: `wasm-pack` compiles Rust to WASM and generates JavaScript/TypeScript bindings
+3. **Import**: Deno imports the generated JavaScript module which loads and interfaces with the WASM binary
+4. **Execution**: JavaScript/TypeScript code can call the exported Rust functions naturally
+
+## TypeScript Support
+
+The generated package includes TypeScript definitions (`.d.ts` files), providing full type safety and IDE autocompletion when using the library in TypeScript.
+
+## License
+
+This is an example project for educational purposes.
+
+## Resources
+
+- [Rust and WebAssembly](https://rustwasm.github.io/docs/book/)
+- [wasm-bindgen Documentation](https://rustwasm.github.io/wasm-bindgen/)
+- [Deno Manual](https://deno.land/manual)
+- [WebAssembly](https://webassembly.org/)

README.md

@@ -0,0 +1,17 @@
+#!/bin/bash
+# Build script for the WASM library
+
+set -e
+
+echo "Building Rust library to WASM for Deno..."
+wasm-pack build --target deno
+
+echo ""
+echo "✅ Build completed successfully!"
+echo ""
+echo "The WASM package has been generated in the 'pkg/' directory."
+echo ""
+echo "To run the Deno example:"
+echo "  cd examples/deno"
+echo "  deno run --allow-read example.ts"
+echo ""