スタートガイド

インストール

AIアシストによるセットアップでプラグインをインストールできます。以下のコマンドを使用して、お使いのAIツールに Capgo のスキルを追加してください：

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-patch
npx cap sync

Capacitor の設定でパッチを選択するまで、このパッケージは何も実行されません。

クイックスタート

bun add @capgo/capacitor-patch
npx cap sync

よくある落とし穴

• Capacitor をアップグレードする前に、バージョンゲートをレビューしてください。
• cap sync の前に CI にインストールしてください。
• ネイティブ編集後は、sync を再実行してください。

パッチ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;

再度 sync を実行します:

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	選択したパッチが互換性がない、または適用できない場合に例外をスローします。

ヒント

明示的な指定を優先 patches 本番環境のアプリでは、適用された修正が code のレビューで確認できるようにするためです。

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 コマンドではパッチ適用済みの CLI code が使用されます。

Getting Startedの続きを進める

使用している場合 スタートガイド ネイティブプラグインの作業を計画するには、次と連携してください： @capgo/capacitor-patch の使用方法 @capgo/capacitor-patch の使用におけるネイティブ機能については、 Capgo プラグインディレクトリ Capgo プラグインディレクトリのプロダクトワークフローについては、 Capgo による Capacitor プラグイン Capgo による Capacitor プラグインの実装詳細については、 プラグインの追加または更新 プラグインの追加または更新における実装詳細については、および Ionic Enterprise プラグインの代替案 Ionic Enterprise プラグインの代替案におけるプロダクトワークフローについては。