imbytecat/tauri-shell
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat: 统一使用 tauri 命令并完善文档和注释

Browse Source 
- 统一使用 `tauri` 命令替代 `cargo tauri`，更新文档中相关命令和说明，并完善 `sidecar.rs` 模块的 API 注释。
This commit is contained in:
imbytecat
2026-01-16 23:19:58 +08:00
parent 720f68f51f
commit b812c143f3
1 changed files with 5 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
AGENTS.md
View File

@@ -10,13 +10,14 @@
- **设计理念**: Tauri 仅提供原生桌面能力（文件对话框、系统通知等），Web 逻辑全部由 Sidecar Server 处理 - **设计理念**: Tauri 仅提供原生桌面能力（文件对话框、系统通知等），Web 逻辑全部由 Sidecar Server 处理
- **异步运行时**: Tokio - **异步运行时**: Tokio
- **Rust 版本**: 1.92.0+ - **Rust 版本**: 1.92.0+
- **工具管理**: 使用 mise 管理 Rust 和 Tauri CLI 版本（见 `mise.toml`）
## 构建、测试、运行命令 ## 构建、测试、运行命令
### 开发运行 ### 开发运行
```bash ```bash
# 开发模式运行 (带 hot-reload) # 开发模式运行 (带 hot-reload)
cargo tauri dev tauri dev
# 仅运行 Rust 二进制 (不推荐，需要手动启动 Sidecar Server) # 仅运行 Rust 二进制 (不推荐，需要手动启动 Sidecar Server)
cargo run cargo run
@@ -31,7 +32,7 @@ cargo build
cargo build --release cargo build --release
# Tauri 应用打包 (生成安装程序) # Tauri 应用打包 (生成安装程序)
cargo tauri build tauri build
``` ```
### 代码检查 ### 代码检查
@@ -85,7 +86,7 @@ tauri-shell/
│ ├── lib.rs # 核心应用逻辑 (注册插件、命令、状态) │ ├── lib.rs # 核心应用逻辑 (注册插件、命令、状态)
│ ├── commands/ │ ├── commands/
│ │ └── mod.rs # 原生桌面功能命令 (文件对话框、通知等) │ │ └── mod.rs # 原生桌面功能命令 (文件对话框、通知等)
│ └── sidecar.rs # Sidecar Server 进程管理 (启动、端口扫描、清理) │ └── sidecar.rs # Sidecar 进程管理 (启动、端口扫描、清理)
├── binaries/ # Sidecar 二进制文件 ├── binaries/ # Sidecar 二进制文件
│ └── server-* # Sidecar Server 可执行文件 (示例: server) │ └── server-* # Sidecar Server 可执行文件 (示例: server)
├── capabilities/ # Tauri v2 权限配置 ├── capabilities/ # Tauri v2 权限配置
@@ -227,7 +228,7 @@ async fn is_port_available(port: u16) -> bool { }
- **`lib.rs`**: 主入口，负责注册插件、命令、状态管理 - **`lib.rs`**: 主入口，负责注册插件、命令、状态管理
- **`commands/mod.rs`**: 所有 Tauri 命令集中定义，命令必须是 `pub fn` - **`commands/mod.rs`**: 所有 Tauri 命令集中定义，命令必须是 `pub fn`
- **`sidecar.rs`**: Sidecar 进程管理逻辑，导出公共 API - **`sidecar.rs`**: Sidecar 进程管理逻辑，导出公共 API（`spawn_sidecar`, `cleanup_sidecar_process`）
```rust ```rust
// lib.rs - 模块声明 // lib.rs - 模块声明