docs(rust-plugins): update readme

[fu050409]

Summary by CodeRabbit

• Documentation
  • Revised the plugin description to highlight enhanced WebAssembly integration and support for modules generated via popular packaging tools.
  • Added practical usage instructions demonstrating how to import WASM packages directly as ESM modules without requiring an initialization query.

[coderabbitai]

Walkthrough

The README for the @farmfe/plugin-wasm plugin was updated to clarify the plugin’s purpose and improve its usage instructions. The description now emphasizes seamless WebAssembly integration and compatibility with wasm-pack generated modules. Additionally, the documentation now shows how to import WASM packages directly as ESM modules without needing the ?init query. There were no modifications to any exported or public entities.

Changes

File	Change Summary
rust-plugins/.../README.md	Updated the plugin description to emphasize seamless WebAssembly integration and support for wasm-pack generated modules. Added new usage instructions for importing WASM packages directly as ESM modules; existing production build note remains unchanged.

Poem

I'm a bunny with a coding stride,
Hoping through docs with a joyful glide.
WASM now sings with a fresh, new beat,
Direct ESM imports make it oh-so-sweet.
Happy hops to clear docs—let's keep our code neat!

---

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

rust-plugins/wasm/README.md (1)

3-3: Suggestion: Reword Plugin Description for Improved Parallelism and Clarity

Consider rephrasing the description on line 3 for a more parallel structure. For example, changing it to:
"A Farm plugin for seamless integration with WebAssembly and support for wasm-pack generated modules."
This small tweak can enhance the readability and consistency of the message.

-A Farm plugin for seamless WebAssembly integration and support `wasm-pack` generated modules.
+A Farm plugin for seamless integration with WebAssembly and support for `wasm-pack` generated modules.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d8d487b and 006c0b7.

📒 Files selected for processing (1)

• rust-plugins/wasm/README.md (2 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (7)

• GitHub Check: call-rust-build / Build and Upload Artifacts - linux-arm64-musl
• GitHub Check: call-rust-build / Build and Upload Artifacts - win32-arm64-msvc
• GitHub Check: call-rust-build / Build and Upload Artifacts - win32-ia32-msvc
• GitHub Check: call-rust-build / Build and Upload Artifacts - darwin-x64
• GitHub Check: call-rust-build / Build and Upload Artifacts - darwin-arm64
• GitHub Check: call-rust-build / Build and Upload Artifacts - linux-x64-musl
• GitHub Check: call-rust-build / Build and Upload Artifacts - linux-x64-gnu

🔇 Additional comments (1)

rust-plugins/wasm/README.md (1)

51-57: Approval: Clear New Usage Instructions for Direct WASM Module Import

The new section starting at line 51 clearly explains that users can directly import WASM packages as ECMAScript modules without the ?init query. The accompanying TypeScript code sample is concise and effectively demonstrates this capability.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

rust-plugins/wasm/README.md (2)

3-3: Updated Plugin Description Evaluation
The updated description clearly conveys the plugin’s expanded functionality by emphasizing seamless WebAssembly integration and support for modules generated by wasm-pack. Consider tweaking the wording slightly for improved readability, e.g., “support for wasm-pack-generated modules.”

---

51-57: Direct ESM Import Documentation
The newly added section about directly importing WASM packages as ESM modules (without using the ?init query) is clear and adds useful flexibility to the usage instructions. Optionally, you might include a brief note discussing any configuration differences or benefits of this approach to further assist developers.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d8d487b and 006c0b7.

📒 Files selected for processing (1)

• rust-plugins/wasm/README.md (2 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (7)

• GitHub Check: call-rust-build / Build and Upload Artifacts - linux-arm64-musl
• GitHub Check: call-rust-build / Build and Upload Artifacts - win32-arm64-msvc
• GitHub Check: call-rust-build / Build and Upload Artifacts - win32-ia32-msvc
• GitHub Check: call-rust-build / Build and Upload Artifacts - darwin-x64
• GitHub Check: call-rust-build / Build and Upload Artifacts - darwin-arm64
• GitHub Check: call-rust-build / Build and Upload Artifacts - linux-x64-musl
• GitHub Check: call-rust-build / Build and Upload Artifacts - linux-x64-gnu