Agent Skills › muratgur/ordinus › ipc-contract-design

ipc-contract-design

GitHub

定义和维护 Ordinus 的 IPC 契约，规范通道命名、类型及 Zod 校验，确保主进程与渲染器间通信的安全性与稳定性。

.codex/skills/ipc-contract-design/SKILL.md muratgur/ordinus

触发场景

新增或修改 window.ordinus API 调整 ipcMain 处理逻辑变更共享请求响应类型

安装

npx skills add muratgur/ordinus --skill ipc-contract-design -g -y

更多选项

非标准路径

npx skills add https://github.com/muratgur/ordinus/tree/master/.codex/skills/ipc-contract-design -g -y

不安装直接使用

npx skills use muratgur/ordinus@ipc-contract-design

指定 Agent (Claude Code)

npx skills add muratgur/ordinus --skill ipc-contract-design -a claude-code -g -y

安装 repo 全部 skill

npx skills add muratgur/ordinus --all -g -y

预览 repo 内 skill

npx skills add muratgur/ordinus --list

SKILL.md

Frontmatter

{
    "name": "ipc-contract-design",
    "description": "Design and maintain Ordinus typed IPC contracts. Use when adding or changing window.ordinus APIs, ipcMain handlers, ipc channel names, shared request\/response types, Zod schemas, preload bridge methods, or renderer calls into main process."
}

IPC Contract Design

Objective

Keep Ordinus IPC small, typed, explicit, and stable enough for the renderer to act as a safe UI over main-process capabilities.

Contract Shape

Define channel names in src/shared/ipc.ts.
Define shared request/response schemas and types in src/shared/contracts.ts.
Register handlers in main process modules, not renderer.
Expose renderer-facing methods through window.ordinus in preload.
Use feature-shaped methods such as workspace.selectFolder() instead of generic transport methods.

Workflow

Name the user-facing capability before creating an IPC method.
Add or update shared types and Zod schemas.
Add the IPC channel constant.
Implement the main handler and validate untrusted input.
Add the narrow preload method that invokes that channel.
Consume the method in renderer through window.ordinus.
Run typecheck, lint, and build.

Guidelines

Keep method names domain-oriented: app.getInfo, db.getStatus, workspace.selectFolder.
Prefer one explicit method over a generic catch-all channel.
Keep renderer errors user-readable and main errors diagnostic enough to debug.
When IPC responses drive renderer status, empty states, or error copy, align user-visible naming with DESIGN.md.
Do not add IPC for future features until there is an immediate caller.
Do not return secrets, raw environment details, or unrestricted local paths unless the UI truly needs them.

Anti-Patterns

window.ordinus.invoke(channel, payload).
Passing raw command strings from renderer to main.
Duplicating response shapes separately in main and renderer.
Letting renderer decide privileged policy such as workspace boundaries or executable paths.