开始使用
复制一个包含安装步骤和本插件的完整Markdown指南的设置提示。
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.如果您更喜欢手动设置,请使用以下命令安装插件,并按照以下平台特定的说明进行操作:
npm install @capgo/capacitor-patchnpx cap sync直到您在Capacitor配置中选择补丁时,包都是无操作的。
选择补丁ID
标题:选择补丁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命令
CLI命令npx capgo-capacitor-patch list --allnpx capgo-capacitor-patch doctornpx 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 命令使用修补的 CLI code。
如果您正在使用 Getting Started 来规划原生插件工作,连接它与 使用 @capgo/capacitor-patch 为原生能力在使用 @capgo/capacitor-patch 中 Capgo 插件目录 为产品工作流程在 Capgo 插件目录 中 Capacitor 插件由 Capgo 为实现细节在 Capacitor 插件由 Capgo 中 添加或更新插件 为实现细节在添加或更新插件中 Ionic 企业插件替代方案 用于 Ionic 企业插件替代方案的产品工作流程。