feat: 添加对 Farm@1.3+ 版本 Rust 插件的使用说明

[wang-yi-bit64]

新增 rust plugin 在 farm@1.3的说明文档

Summary by CodeRabbit

• Documentation
  • Updated documentation to include a new usage pattern for Rust plugins starting from version 1.3, allowing them to be imported and used as functions similar to JS plugins.
  • Added examples demonstrating the new function call syntax for Rust plugins in both English and Chinese documentation.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
farm-fe-github-io	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Apr 21, 2025 4:07pm

[coderabbitai]

Walkthrough

The documentation for using Rust plugins in Farm was updated in both the English and Chinese guides. The changes introduce and explain a new usage pattern available from version 1.3 onwards, where Rust plugins can be imported and used as functions within the configuration file, similar to JavaScript plugins. The new examples demonstrate how to import a Rust plugin and invoke it with options. No code or API changes were made; only documentation was updated to reflect this new approach.

Changes

File(s)	Change Summary
docs/using-plugins.md, i18n/zh/docusaurus-plugin-content-docs/current/using-plugins.md	Updated documentation to add and explain a new usage pattern for Rust plugins from Farm v1.3+, showing how they can now be imported and invoked as functions in the configuration file. Existing content remains unchanged.

Poem

In the docs, a new tale unfolds,
Rust plugins as functions—so bold!
Now with a hop and a call,
They work just like JS, after all.
From English to Chinese, the story's the same,
Farm 1.3+ brings a new plugin game!
🐇✨

Tip

⚡💬 Agentic Chat (Pro Plan, General Availability)

• We're introducing multi-step agentic chat in review comments and issue comments, within and outside of PR's. This feature enhances review and issue discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments and add commits to existing pull requests.

---

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 58334b9 and 2cd9d40.

📒 Files selected for processing (2)

• docs/using-plugins.md (1 hunks)
• i18n/zh/docusaurus-plugin-content-docs/current/using-plugins.md (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (2)

• docs/using-plugins.md
• i18n/zh/docusaurus-plugin-content-docs/current/using-plugins.md

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

• GitHub Check: Test deployment

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.
• @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: 2

🧹 Nitpick comments (3)

docs/using-plugins.md (2)

77-88: Align example formatting with existing snippets
The new code block has extra blank lines and inconsistent indentation compared to earlier examples. Consider trimming leading/trailing blank lines and aligning indentation to match surrounding patterns:

- ```ts title="farm.config.ts"
- import reactPlugin from "@farmfe/plugin-react";
-
- export default defineConfig({
-   plugins: [
-      // Use the function approach to call Rust plugins
-     reactPlugin({
-       // Settings
-     })
-   ],
- });
- ```
+ ```ts title="farm.config.ts"
+ import reactPlugin from "@farmfe/plugin-react";
+
+ export default defineConfig({
+   plugins: [
+     // Use the function approach to call Rust plugins
+     reactPlugin({
+       // Settings
+     })
+   ]
+ });
+ ```

---

91-93: Capitalize “Rust” in tip heading
For consistency with other sections, capitalize "Rust" in the tip text:

- :::tip
- To learn more about rust plugins, see [Rust Plugins](/docs/plugins/official-plugins/overview#rust-plugins)
+ :::tip
+ To learn more about Rust plugins, see [Rust Plugins](/docs/plugins/official-plugins/overview#rust-plugins)

i18n/zh/docusaurus-plugin-content-docs/current/using-plugins.md (1)

88-88: 统一 “Rust” 大写
为保持与英文文档一致，请将 “rust 插件” 改为 “Rust 插件”：

- :::tip
- 要了解有关 rust 插件的更多信息，请参阅 [Rust 插件](/docs/plugins/official-plugins/overview#rust-插件)
+ :::tip
+ 要了解有关 Rust 插件的更多信息，请参阅 [Rust 插件](/docs/plugins/official-plugins/overview#rust-插件)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 3dcbe25 and 58334b9.

📒 Files selected for processing (2)

• docs/using-plugins.md (1 hunks)
• i18n/zh/docusaurus-plugin-content-docs/current/using-plugins.md (1 hunks)

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

• GitHub Check: Test deployment