Langsung ke konten

Panduan Memulai

GitHub

Anda bisa menggunakan AI-Assisted Setup kami untuk menginstal plugin ini. Tambahkan skill Capgo ke tool AI Anda dengan command berikut:

Jendela terminal
npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

Lalu gunakan prompt berikut:

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-patch` plugin in my project.

Jika Anda lebih memilih Manual Setup, instal plugin dengan menjalankan perintah berikut dan ikuti petunjuk khusus platform di bawah ini:

Jendela terminal
npm install @capgo/capacitor-patch
npx cap sync

Paket ini tidak melakukan apa-apa sampai Anda memilih patch di konfigurasi Capacitor Anda.

bun add @capgo/capacitor-patch
npx cap sync
  • Periksa version gates sebelum meng-upgrade Capacitor.
  • Instal di CI sebelum cap sync.
  • Jalankan ulang sync setelah edit native.

Daftarkan semua patch yang dikirim:

Jendela terminal
npx capgo-capacitor-patch list --all

Kemudian tambahkan patch ID yang dibutuhkan aplikasi Anda ke 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;

Jalankan sync lagi:

Jendela terminal
npx cap sync

Patch paket dijalankan sebelum sync dan update. Patch proyek native dijalankan setelah sync dan update.

Gunakan doctor untuk memeriksa apakah patch yang dipilih cocok dengan versi paket yang terinstal:

Jendela terminal
npx capgo-capacitor-patch doctor --phase package --strict

Gunakan apply ketika Anda ingin menjalankan patch yang dipilih secara manual:

Jendela terminal
npx capgo-capacitor-patch apply --phase package
OpsiTipeDefaultDeskripsi
recommendedbooleanfalseMenerapkan patch yang ditandai Capgo sebagai rekomendasi.
patchesstring[][]Menerapkan ID patch eksplisit.
disabledstring[][]Melewatkan ID patch yang dipilih, bahkan jika direkomendasikan.
strictbooleanfalseMelempar error jika patch yang dipilih tidak kompatibel atau tidak dapat diterapkan.
Jendela terminal
npx capgo-capacitor-patch list --all
npx capgo-capacitor-patch doctor
npx capgo-capacitor-patch apply

Opsi yang berguna:

  • --root <dir> mengatur root aplikasi.
  • --phase package|native|all membatasi fase patch yang dijalankan.
  • --platform ios|android menerapkan filter platform di luar hook Capacitor.
  • --strict menganggap kegagalan patch terpilih sebagai error.
  1. Instal @capgo/capacitor-patch.
  2. Jalankan npx capgo-capacitor-patch list --all.
  3. Tambahkan ID patch yang dipilih ke plugins.CapacitorPatch.patches.
  4. Jalankan npx capgo-capacitor-patch doctor --strict.
  5. Jalankan npx cap sync.

Saat patch yang dipilih menargetkan @capacitor/cli, patch akan diterapkan ke paket CLI yang terinstal dan cap perintah menggunakan CLI code yang sudah di-patch.

Jika Anda menggunakan Panduan Memulai untuk merencanakan pekerjaan plugin native, hubungkan dengan Menggunakan @capgo/capacitor-patch untuk kemampuan native di Menggunakan @capgo/capacitor-patch, Direktori Plugin Capgo untuk alur kerja produk di Direktori Plugin Capgo, Plugin Capacitor oleh Capgo untuk detail implementasi pada Capacitor Plugins oleh Capgo Menambahkan atau Memperbarui Plugin untuk detail implementasi di Menambahkan atau Memperbarui Plugin, dan Alternatif Plugin Ionic Enterprise untuk alur kerja produk dalam Alternatif Plugin Ionic Enterprise.