开始

可复制

        Set up this Capacitor plugin in the project.

Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-patch`
Run the required Capacitor sync/update step after installation.
Read this markdown guide for the full setup steps: https://raw.githubusercontent.com/Cap-go/website/refs/heads/main/apps/docs/src/content/docs/docs/plugins/capacitor-patch/getting-started.mdx
Use that guide for platform-specific steps, native file edits, permissions, config changes, imports, and usage setup.
If that guide references other docs pages, read them too.

安装

您可以使用我们的 AI 助手设置来安装插件。使用以下命令将 Capgo 技能添加到您的 AI 工具中:

npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

然后使用以下提示:

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-patch` plugin in my project.

如果您prefer手动设置，安装插件并运行以下命令并遵循以下平台特定说明：

npm install @capgo/capacitor-patch
npx cap sync

该包直到您在Capacitor配置中选择补丁时才会执行。

选择补丁ID

列出所有已发货补丁：

npx capgo-capacitor-patch list --all

然后将应用程序需要的补丁ID添加到 capacitor.config.ts:

import type { CapacitorConfig } from '@capacitor/cli';

const config: CapacitorConfig = {
  appId: 'com.example.app',
  appName: 'Example',
  webDir: 'dist',
  plugins: {
    CapacitorPatch: {
      patches: ['upstream-pr-8418-android'],
      strict: true,
    },
  },
};

export default config;

重新运行同步：

npx cap sync

包补丁在运行之前 sync 和 update原生项目补丁在应用后 sync 和 update.

在应用前进行试验

使用 doctor 来检查所选补丁是否与您的已安装包版本匹配：

npx capgo-capacitor-patch doctor --phase package --strict

使用 apply 当您想手动运行所选补丁时：

npx capgo-capacitor-patch apply --phase package

配置选项

选项	类型	默认	描述
`recommended`	`boolean`	`false`	应用Capgo标记的补丁
`patches`	`string[]`	`[]`	应用显式补丁ID
`disabled`	`string[]`	`[]`	跳过选中补丁ID，即使它们被推荐
`strict`	`boolean`	`false`	当选中补丁不可用或无法应用时抛出

CLI命令

npx capgo-capacitor-patch list --all
npx capgo-capacitor-patch doctor
npx capgo-capacitor-patch apply

有用的选项：

--root <dir> 设置应用根目录。
--phase package|native|all 限制哪个补丁阶段运行。
--platform ios|android 在Capacitor钩子外应用平台过滤。
--strict 将选定的补丁失败视为错误。

工作流程

安装 @capgo/capacitor-patch.
运行 npx capgo-capacitor-patch list --all.
添加所选补丁 ID 到 plugins.CapacitorPatch.patches.
运行 npx capgo-capacitor-patch doctor --strict.
运行 npx cap sync.

当所选补丁目标 @capacitor/cli,补丁将应用到已安装的CLI包和下一个 cap 命令使用修补的CLIcode。

继续从 Getting Started

如果您正在使用开始来规划原生插件工作，连接它与使用@capgo/capacitor-patch 使用@capgo/capacitor-patch Capgo插件目录 Capgo插件目录 Capacitor由Capgo Capacitor由Capgo 添加或更新插件添加或更新插件 Ionic企业插件替代品为 Ionic 企业插件替代品的产品工作流程。