跳过内容

开始使用

GitHub

您可以使用我们的 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配置中选择补丁时,包都是无操作的。

列出所有已发货的补丁:

终端窗口
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

包修复程序在此之前运行 syncupdate. 本机项目修复程序在此之后运行 syncupdate.

使用 doctor 来检查所选修复程序是否与安装的包版本匹配:

终端窗口
npx capgo-capacitor-patch doctor --phase package --strict

使用 apply 当您想手动运行所选修复程序时:

终端窗口
npx capgo-capacitor-patch apply --phase package
选项类型默认值描述
recommendedbooleanfalse将标记为推荐的补丁应用到Capgo。
patchesstring[][]应用显式的补丁ID。
disabledstring[][]跳过选中补丁ID,即使它们被推荐。
strictbooleanfalse当选中补丁不兼容或无法应用时,抛出异常。

CLI命令

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 对选中的补丁故障进行错误处理。

工作流

工作流
  1. 安装 @capgo/capacitor-patch.
  2. 运行 npx capgo-capacitor-patch list --all.
  3. 将选中的补丁ID添加到 plugins.CapacitorPatch.patches.
  4. 运行 npx capgo-capacitor-patch doctor --strict.
  5. 运行 npx cap sync.

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

如果您正在使用 Getting Started 来规划原生插件工作,连接它与 使用@capgo/capacitor-patch 为原生能力在使用@capgo/capacitor-patch中 Capgo插件目录 为产品工作流程在Capgo插件目录中 Capacitor由Capgo的插件 为实现细节在Capacitor由Capgo的插件中 添加或更新插件 为实现细节在添加或更新插件中 Ionic 企业版插件替代方案 为 Ionic 企业版插件替代方案中的产品工作流程。