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.
インストール
「インストール」のセクション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;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[] | [] | __CAPGO_KEEP_0__ の明示的なパッチ ID を適用します。 |
disabled | string[] | [] | __CAPGO_KEEP_0__ の選択されたパッチ ID をスキップします。推奨されていても。 |
strict | boolean | false | __CAPGO_KEEP_0__ の選択されたパッチが不一致または適用できない場合に例外を投げます。 |
CLI コマンド
セクション「CLI コマンド」npx capgo-capacitor-patch list --allnpx capgo-capacitor-patch doctornpx capgo-capacitor-patch apply便利なオプション:
--root <dir>__CAPGO_KEEP_0__ を設定すると、アプリのルートが設定されます。--phase package|native|all__CAPGO_KEEP_0__ を設定すると、どのパッチフェーズが実行されるか制限されます。--platform ios|androidCapacitor の外側でプラットフォームフィルタリングが適用されます。--strict選択したパッチの失敗をエラーとして扱います。
ワークフロー
セクション「ワークフロー」- インストール
@capgo/capacitor-patch. - 実行
npx capgo-capacitor-patch list --all. - __CAPGO_KEEP_0__に選択されたパッチIDを追加します。
plugins.CapacitorPatch.patches. - 実行
npx capgo-capacitor-patch doctor --strict. - 実行
npx cap sync.
選択されたパッチが__CAPGO_KEEP_0__パッケージにインストールされている場合、パッチは__CAPGO_KEEP_0__パッケージと次の @capacitor/cliコマンドはパッチされたCLI __CAPGO_KEEP_1__を使用します。 cap command uses the patched CLI code.
Getting Startedから続けて
Capacitorを使用している場合Getting Started Capacitorを使用してネイティブプラグインの作業を計画する場合、Capacitorを接続してください。 Getting Started Capgoの@capgo/capacitor-patchを使用 Capgoの@capgo/capacitor-patchのネイティブ機能 Capgo プラグインディレクトリ Capgo プラグインの製品ワークフロー Capacitor プラグイン ( Capgo による) Capacitor プラグイン ( Capgo による)の実装詳細 プラグインの追加または更新 プラグインの追加または更新の実装詳細 Ionic Enterprise プラグインの代替 Ionic Enterprise プラグインの代替の製品ワークフロー