summaryrefslogtreecommitdiffhomepage
path: root/packages/web/src/content/docs/zh-cn/plugins.mdx
diff options
context:
space:
mode:
authorchenmi <[email protected]>2026-02-17 20:06:39 +0800
committerGitHub <[email protected]>2026-02-17 06:06:39 -0600
commit4fd3141ab5d43a55566042982fb4459b5716e140 (patch)
treea1faa0f22784999fffcace0a1f8853709a232b0d /packages/web/src/content/docs/zh-cn/plugins.mdx
parent8d0a303af48da5e6c6d5287ef2144bfb49ca13d0 (diff)
downloadopencode-4fd3141ab5d43a55566042982fb4459b5716e140.tar.gz
opencode-4fd3141ab5d43a55566042982fb4459b5716e140.zip
docs: improve zh-cn and zh-tw documentation translations (#13942)
Diffstat (limited to 'packages/web/src/content/docs/zh-cn/plugins.mdx')
-rw-r--r--packages/web/src/content/docs/zh-cn/plugins.mdx89
1 files changed, 44 insertions, 45 deletions
diff --git a/packages/web/src/content/docs/zh-cn/plugins.mdx b/packages/web/src/content/docs/zh-cn/plugins.mdx
index 69810e67c..0df6d1ee6 100644
--- a/packages/web/src/content/docs/zh-cn/plugins.mdx
+++ b/packages/web/src/content/docs/zh-cn/plugins.mdx
@@ -1,21 +1,21 @@
---
title: 插件
-description: 编写您自己的插件来扩展 opencode。
+description: 编写自己的插件来扩展 OpenCode。
---
-插件允许您通过挂钩各种事件和自定义行为来扩展 opencode。您可以创建插件来添加新功能、与外部服务集成或修改 opencode 的默认行为。
+插件允许你通过挂钩各种事件和自定义行为来扩展 OpenCode。你可以创建插件来添加新功能、集成外部服务,或修改 OpenCode 的默认行为。
-例如,查看社区创建的[插件](/docs/ecosystem#plugins)。
+如需了解示例,请查看社区创建的[插件](/docs/ecosystem#plugins)。
---
## 使用插件
-有两种加载插件的方法。
+有两种方式加载插件。
---
-### 从本地文件
+### 从本地文件加载
将 JavaScript 或 TypeScript 文件放置在插件目录中。
@@ -26,7 +26,7 @@ description: 编写您自己的插件来扩展 opencode。
---
-### 来自 npm
+### 从 npm 加载
在配置文件中指定 npm 包。
@@ -37,43 +37,42 @@ description: 编写您自己的插件来扩展 opencode。
}
```
-支持常规和范围的 npm 包。
+支持常规和带作用域的 npm 包。
浏览[生态系统](/docs/ecosystem#plugins)中的可用插件。
---
-### 插件是如何安装的
+### 插件的安装方式
-**npm 插件** 在启动时使用 Bun 自动安装。包及其依赖项缓存在 `~/.cache/opencode/node_modules/` 中。
+**npm 插件**在启动时使用 Bun 自动安装。包及其依赖项会缓存在 `~/.cache/opencode/node_modules/` 中。
-**本地插件**直接从插件目录加载。要使用外部包,您必须在配置目录中创建`package.json`(请参阅[依赖关系](#dependencies)),或将插件发布到npm和[将其添加到您的配置中](/docs/config#plugins)。
+**本地插件**直接从插件目录加载。如果需要使用外部包,你必须在配置目录中创建 `package.json`(参见[依赖项](#dependencies)),或者将插件发布到 npm 并[将其添加到配置中](/docs/config#plugins)。
---
### 加载顺序
-插件从所有源加载,所有挂钩按顺序运行。加载顺序为:
+插件从所有来源加载,所有钩子按顺序执行。加载顺序为:
1. 全局配置 (`~/.config/opencode/opencode.json`)
-2. 项目配置(`opencode.json`)
-3. 插件全局目录 (`~/.config/opencode/plugins/`)
-4. 项目插件目录(`.opencode/plugins/`)
+2. 项目配置 (`opencode.json`)
+3. 全局插件目录 (`~/.config/opencode/plugins/`)
+4. 项目插件目录 (`.opencode/plugins/`)
-具有相同的名称和版本,但是重复的 npm 包将被加载一次。,本地插件和名称相似的 npm 插件都是分开加载的。
+名称和版本相同的重复 npm 包只会加载一次。但本地插件和名称相似的 npm 插件会分别独立加载。
---
-## 创建一个插件
+## 创建插件
-插件是一个 **JavaScript/TypeScript 模块多个**,它导出一个或插件
-功能。每个函数接收一个上下文对象并返回一个钩子对象。
+插件是一个 **JavaScript/TypeScript 模块**,它导出一个或多个插件函数。每个函数接收一个上下文对象,并返回一个钩子对象。
---
-### 依赖关系
+### 依赖项
-本地插件和自定义工具可以使用外部 npm 包。将 `package.json` 添加到您的配置目录,其中包含您需要的依赖项。
+本地插件和自定义工具可以使用外部 npm 包。在配置目录中添加一个 `package.json`,列出所需的依赖项。
```json title=".opencode/package.json"
{
@@ -83,7 +82,7 @@ description: 编写您自己的插件来扩展 opencode。
}
```
-opencode 在启动时运行 `bun install` 来安装这些。然后你的插件和工具就可以导入它们了。
+OpenCode 会在启动时运行 `bun install` 来安装这些依赖项。之后你的插件和工具就可以导入它们了。
```ts title=".opencode/plugins/my-plugin.ts"
import { escape } from "shescape"
@@ -113,19 +112,19 @@ export const MyPlugin = async ({ project, client, $, directory, worktree }) => {
}
```
-插件函数接收:
+插件函数接收以下参数:
- `project`:当前项目信息。
- `directory`:当前工作目录。
- `worktree`:git 工作树路径。
-- `client`:用于与AI交互的opencodeSDK客户端。
-- `$`:Bun的[外壳API](https://bun.com/docs/runtime/shell)用于执行命令。
+- `client`:用于与 AI 交互的 OpenCode SDK 客户端。
+- `$`:Bun 的 [Shell API](https://bun.com/docs/runtime/shell),用于执行命令。
---
### TypeScript 支持
-对于 TypeScript 插件,您可以从插件包中导入类型:
+对于 TypeScript 插件,你可以从插件包中导入类型:
```ts title="my-plugin.ts" {1}
import type { Plugin } from "@opencode-ai/plugin"
@@ -141,7 +140,7 @@ export const MyPlugin: Plugin = async ({ project, client, $, directory, worktree
### 事件
-插件可以订阅事件,如下面的示例部分所示。以下是可用的不同事件的列表。
+插件可以订阅事件,如下方示例部分所示。以下是所有可用事件的列表。
#### 命令事件
@@ -211,13 +210,13 @@ export const MyPlugin: Plugin = async ({ project, client, $, directory, worktree
## 示例
-以下是一些可用于扩展 opencode 的插件示例。
+以下是一些可用于扩展 OpenCode 的插件示例。
---
### 发送通知
-当某些事件发生时发送通知:
+在特定事件发生时发送通知:
```js title=".opencode/plugins/notification.js"
export const NotificationPlugin = async ({ project, client, $, directory, worktree }) => {
@@ -232,17 +231,17 @@ export const NotificationPlugin = async ({ project, client, $, directory, worktr
}
```
-我们在 macOS 上使用 `osascript` AppleScript。这里我们用它运行来发送通知。
+这里使用 `osascript` 在 macOS 上运行 AppleScript 来发送通知。
:::note
-如果您使用 opencode 桌面应用程序,它可以在响应准备就绪或会话错误时自动发送系统通知。
+如果你使用 OpenCode 桌面应用,它可以在响应就绪或会话出错时自动发送系统通知。
:::
---
### .env 保护
-阻止opencode读取`.env`文件:
+阻止 OpenCode 读取 `.env` 文件:
```javascript title=".opencode/plugins/env-protection.js"
export const EnvProtection = async ({ project, client, $, directory, worktree }) => {
@@ -260,7 +259,7 @@ export const EnvProtection = async ({ project, client, $, directory, worktree })
### 注入环境变量
-将环境变量注入所有shell执行(AI工具和用户终端):
+将环境变量注入所有 Shell 执行(AI 工具和用户终端):
```javascript title=".opencode/plugins/inject-env.js"
export const InjectEnvPlugin = async () => {
@@ -277,7 +276,7 @@ export const InjectEnvPlugin = async () => {
### 自定义工具
-插件还可以向 opencode 添加自定义工具:
+插件还可以为 OpenCode 添加自定义工具:
```ts title=".opencode/plugins/custom-tools.ts"
import { type Plugin, tool } from "@opencode-ai/plugin"
@@ -300,19 +299,19 @@ export const CustomToolsPlugin: Plugin = async (ctx) => {
}
```
-`tool` 帮助器创建一个可以调用的自定义工具的opencode。它采用 Zod 模式函数并返回一个工具定义:
+`tool` 辅助函数用于创建 OpenCode 可调用的自定义工具。它接受一个 Zod schema 函数,并返回一个工具定义,包含:
-- `description`:该工具的作用
-- `args`:Zod 模式的工具参数
-- `execute`:调用工具时运行的函数
+- `description`:工具的功能描述
+- `args`:工具参数的 Zod schema
+- `execute`:工具被调用时执行的函数
-您的自定义工具将可与内置工具一起用于opencode。
+你的自定义工具将与内置工具一起在 OpenCode 中可用。
---
-### 日志
+### 日志记录
-使用 `client.app.log()` 而不是 `console.log` 进行成型日志记录:
+使用 `client.app.log()` 代替 `console.log` 进行结构化日志记录:
```ts title=".opencode/plugins/my-plugin.ts"
export const MyPlugin = async ({ client }) => {
@@ -327,13 +326,13 @@ export const MyPlugin = async ({ client }) => {
}
```
-级别:`debug`、`info`、`warn`、`error`。详情请参见【SDK文档](https://opencode.ai/docs/sdk)。
+日志级别:`debug`、`info`、`warn`、`error`。详情请参阅 [SDK 文档](https://opencode.ai/docs/sdk)。
---
### 压缩钩子
-自定义压缩会话时包含的上下文:
+自定义会话压缩时包含的上下文:
```ts title=".opencode/plugins/compaction.ts"
import type { Plugin } from "@opencode-ai/plugin"
@@ -355,9 +354,9 @@ Include any state that should persist across compaction:
}
```
-`experimental.session.compacting`钩子在LLM生成驱动机之前触发。使用它来填充默认压缩提示会丢失的特定于域的上下文。
+`experimental.session.compacting` 钩子在 LLM 生成续接摘要之前触发。使用它来注入默认压缩提示词可能遗漏的领域特定上下文。
-您还可以通过设置`output.prompt`来完全替换压缩提示:
+你还可以通过设置 `output.prompt` 来完全替换压缩提示词:
```ts title=".opencode/plugins/custom-compaction.ts"
import type { Plugin } from "@opencode-ai/plugin"
@@ -382,4 +381,4 @@ Format as a structured prompt that a new agent can use to resume work.
}
```
-当设置`output.prompt`时,它会取代完全默认的压缩提示。在这种情况下,`output.context` 内存将被忽略。
+当设置了 `output.prompt` 时,它会完全替换默认的压缩提示词。在这种情况下,`output.context` 数组将被忽略。