Getting Started

このプラグインのインストール手順と完全なマークダウンガイドを含むセットアッププロンプトをコピーします。

        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.

Install

AI-Assisted セットアップを使用すると、プラグインをインストールできます。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.

Manual セットアップを使用する場合は、以下のコマンドを実行してプラグインをインストールし、以下のプラットフォーム固有の説明を参照してください:

npm install @capgo/capacitor-patch
npx 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;

sync を実行してください:

npx cap sync

パッケージパッチは先に実行されます。 sync そして update. Native プロジェクトパッチは後で実行されます。 sync かつて update.

__CAPGO_KEEP_0__

を使用 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 選択した修正の失敗をエラーとして扱います。

ワークフロー

Install @capgo/capacitor-patch.
Run npx capgo-capacitor-patch list --all.
選択したパッチIDを追加します plugins.CapacitorPatch.patches.
Run npx capgo-capacitor-patch doctor --strict.
Run npx cap sync.

選択したパッチが対象の場合 @capacitor/cli、パッチはインストール済みのCLIパッケージと次の cap コマンドはパッチされたCLIcodeを使用します。

Getting Startedから続けて

Capgoを使用している場合 Getting Started native プラグインの作業を計画するには、を接続する必要があります。 @capgo/capacitor-patchを使用する native capabilityのために@capgo/capacitor-patchを使用する Capgo プラグインディレクトリ Capgo プラグインディレクトリの製品ワークフロー Capacitor プラグイン ( Capgo によって提供 ) Capacitor プラグイン ( Capgo によって提供 ) の実装詳細プラグインの追加または更新プラグインの追加または更新の実装詳細、および Ionic Enterprise プラグインの代替 Ionic Enterprise プラグインの代替の製品ワークフロー。