Getting Started

GitHub

Kopieren Sie einen Setup-Vorschlag mit den Installationsanweisungen und dem vollständigen Markdown-Leitfaden für diesen Plugin.

        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.

Installieren

Sie können unsere AI-gestützte Einrichtung verwenden, um das Plugin zu installieren. Fügen Sie die Capgo Fähigkeiten Ihrem AI-Tool mit der folgenden Befehl hinzu:

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

Dann verwenden Sie folgenden Befehl:

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

Wenn Sie die manuelle Einrichtung bevorzugen, installieren Sie das Plugin, indem Sie die folgenden Befehle ausführen und die darunterstehenden plattform-spezifischen Anweisungen befolgen.

npm install @capgo/capacitor-patch
npx cap sync

Die Paketfunktion ist bis zum Auswahl von Patches in Ihrer Capacitor-Konfiguration ein Nop.

Patch-IDs auswählen

Alle gelieferten Patches auflisten:

npx capgo-capacitor-patch list --all

Wählen Sie dann die Patch-IDs, die Ihre App benötigt. 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;

Synchronisierung erneut durchführen:

npx cap sync

Paket-Patches werden vor der Ausführung ausgeführt. sync und updateNative Projekt-Patches werden nach sync und update.

Vorab-Test vor der Anwendung

Use doctor um zu überprüfen, ob die ausgewählten Patches mit Ihren installierten Paketversionen übereinstimmen:

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

Use apply wenn Sie die ausgewählten Patches manuell ausführen möchten:

npx capgo-capacitor-patch apply --phase package

Einstellungsoptionen

Einstellung	Typ	Einstellung	Standard
`recommended`	`boolean`	`false`	Anwendet Patches Capgo als empfohlen.
`patches`	`string[]`	`[]`	Wirkt Patches __CAPGO_KEEP_0__ als empfohlen.
`disabled`	`string[]`	`[]`	Überspringt ausgewählte Patch-IDs, auch wenn empfohlen.
`strict`	`boolean`	`false`	Werfen wenn ein ausgewählter Patch inkompatibel ist oder nicht angewendet werden kann.

CLI-Befehle

npx capgo-capacitor-patch list --all
npx capgo-capacitor-patch doctor
npx capgo-capacitor-patch apply

Nützliche Optionen:

--root <dir> Nützliche Optionen:
--phase package|native|all Begrenzt die Ausführung der Patcheschritt.
--platform ios|android wirholt Plattformfilterung außerhalb eines Capacitor-Hooks.
--strict Behandelt ausgewählte Patchfehler als Fehler.

Workflow

Installieren @capgo/capacitor-patch.
Laufen npx capgo-capacitor-patch list --all.
Fügen Sie die ausgewählten Patch-IDs zu plugins.CapacitorPatch.patches.
Laufen npx capgo-capacitor-patch doctor --strict.
Laufen npx cap sync.

Wenn ein ausgewählter Patch zielt @capacitor/cliDie Patches werden auf das installierte CLI Paket und das nächste angewendet. cap Befehl verwendet die gepatchte CLI code.

Weiter mit der Einführung

Wenn Sie native Plugin-Arbeiten durchführen Getting Started um native Plugin-Arbeiten zu planen, verbinden Sie es mit Verwenden Sie @capgo/capacitor-Patch für die native Fähigkeit in Verwenden Sie @capgo/capacitor-Patch Capgo Plugin-Verzeichnis für den Produktworkflow in Capgo Plugin-Verzeichnis Capacitor Plugins von Capgo für die Implementierungsdetails in Capacitor Plugins von Capgo Plugins hinzufügen oder aktualisieren für die Implementierungsdetails in Plugins hinzufügen oder aktualisieren und Ionic Enterprise-Plugin-Alternativen für das Produktworkflow in Ionic Enterprise Plugin Alternativen.