docs: consolidate design documentation and standardize crate English
This commit is contained in:
@@ -1,7 +1,5 @@
|
||||
# Rust Component Model instance Plugin template
|
||||
# Rust Component Instance Plugin雛形
|
||||
|
||||
This offline authoring template declares the proposed `yoi:plugin/instance@1.0.0` world. Yoi currently provides no Plugin installation or Worker execution path.
|
||||
提案段階の`yoi:plugin/instance@1.0.0`を対象にしたオフラインpackageの雛形である。YoiはPluginのインストールやWorker内での実行を提供していない。
|
||||
|
||||
The example contains request/response Tool and Service ingress shapes that a future sandboxed Server Plugin platform may support. Their host API and grant metadata is inert in the current product and grants no authority.
|
||||
|
||||
Build with `cargo component build --release` (or the project-specific build command used by your package), then run `yoi plugin check .` and `yoi plugin pack .` against the explicit directory. Passing offline validation does not install or authorize the package.
|
||||
Tool・Serviceの要求と応答は将来の実行境界を検討するための例である。host APIやgrantのmetadataは現在の製品では権限を付与せず、オフライン検査の成功も実行の許可を意味しない。
|
||||
|
||||
@@ -1,37 +1,5 @@
|
||||
# Rust Component Tool Template
|
||||
# Rust Component Plugin雛形
|
||||
|
||||
This is the embedded starter template for a Yoi Component Model Tool Plugin written with the first-party Rust PDK.
|
||||
提案段階の`yoi:plugin/tool@1.0.0`を対象にしたオフラインpackageの雛形である。YoiはPluginのインストールやWorker内での実行を提供していない。
|
||||
|
||||
## What this template demonstrates
|
||||
|
||||
- Offline package metadata targeting the proposed `yoi:plugin/tool@1.0.0` world.
|
||||
- Guest-side runtime binding setup through the PDK.
|
||||
- Typed JSON input parsing through `run_json_tool` via `export_component_tool!`.
|
||||
- Typed JSON output serialization with `ToolOutput::json`.
|
||||
- Structured, bounded `ToolError` output for user-visible Tool failures.
|
||||
|
||||
The PDK is guest-side only. It does not grant filesystem, network, or environment authority. Yoi currently provides no Plugin installation or Worker execution path; this template is retained for offline package authoring.
|
||||
|
||||
## Checkout/development dependency
|
||||
|
||||
Inside the Yoi checkout this template uses a local path dependency and declares an empty `[workspace]` so it can be checked in place without becoming a member of Yoi's root workspace:
|
||||
|
||||
```toml
|
||||
yoi-plugin-pdk = { path = "../../../../crates/plugin-pdk" }
|
||||
```
|
||||
|
||||
If this template is copied to an independent Plugin repository, pin a Yoi source commit with `rev` instead of tracking a branch. Use the repository root `.git` URL, not the browser `/src/branch/...` URL:
|
||||
|
||||
```toml
|
||||
yoi-plugin-pdk = { git = "https://gitea.hareworks.net/Hare/yoi.git", package = "yoi-plugin-pdk", rev = "<pinned-yoi-commit-sha>" }
|
||||
```
|
||||
|
||||
`plugin.component.wasm` in the template is a text placeholder so `yoi plugin check` and `yoi plugin pack` can exercise deterministic local package validation immediately. Replace it with a real built component before treating the offline package as verified.
|
||||
|
||||
## Next steps
|
||||
|
||||
1. Replace package/plugin ids, names, descriptions, and Tool schema.
|
||||
2. Replace `EchoInput` / `EchoOutput` and `handle_echo` with your Tool logic.
|
||||
3. Build the Rust component artifact for `wasm32-unknown-unknown`, replacing the placeholder `plugin.component.wasm`.
|
||||
4. Run `yoi plugin check .` and `yoi plugin pack . --output ./my-plugin.yoi-plugin`.
|
||||
5. Retain the package as an offline artifact. Yoi does not currently install or execute it.
|
||||
guest側の型付き入出力とエラー表現はRust PDKが担当し、ファイル・ネットワーク・環境への権限は付与しない。`plugin.component.wasm`はpackage検査用のテキストplaceholderであり、実行可能なcomponentの証拠にはならない。
|
||||
|
||||
Reference in New Issue
Block a user