Erste Schritte

Kopiere einen Setup-Prompt mit den Installationsschritten und dem vollständigen Markdown-Guide für dieses 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

Du kannst unser KI-gestütztes Setup nutzen, um das Plugin zu installieren. Füge die Capgo Skills mit dem folgenden Befehl deinem KI-Tool hinzu:

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

Nutze dann diesen Prompt:

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

Wenn du ein manuelles Setup bevorzugst, installiere das Plugin mit den folgenden Befehlen und befolge die plattformspezifischen Anweisungen unten:

npm install @capgo/capacitor-patch
npx cap sync

Das Paket ist wirkungslos, bis du Patches in deiner Capacitor Config auswählst.

Quickstart

bun add @capgo/capacitor-patch
npx cap sync

Häufige Stolperfallen

Prüfe die Version Gates, bevor du Capacitor aktualisierst.
In der CI vor cap sync installieren.
Nach nativen Änderungen Sync erneut ausführen.

Patch-IDs auswählen

Alle veröffentlichten Patches auflisten:

npx capgo-capacitor-patch list --all

Füge dann die benötigten Patch-IDs hinzu: 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;

Führe sync erneut aus:

npx cap sync

Package-Patches werden vorher ausgeführt sync und update. Native-Projekt-Patches werden danach ausgeführt sync und update.

Dry-Run vor dem Anwenden

Nutzt doctor um zu prüfen, ob die ausgewählten Patches zu deinen installierten Paketversionen passen:

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

Nutzt apply wenn du die ausgewählten Patches manuell ausführen möchtest:

npx capgo-capacitor-patch apply --phase package

Konfigurationsoptionen

Option	Typ	Standard	Beschreibung
`recommended`	`boolean`	`false`	Wendet Patches an, die Capgo als empfohlen markiert.
`patches`	`string[]`	`[]`	Wendet explizite Patch-IDs an.
`disabled`	`string[]`	`[]`	Überspringt ausgewählte Patch-IDs, auch wenn sie empfohlen werden.
`strict`	`boolean`	`false`	Wirft einen Fehler, wenn ein 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> legt den App-Root fest.
--phase package|native|all begrenzt die auszuführende Patch-Phase.
--platform ios|android wendet Plattform-Filterung außerhalb eines Capacitor Hooks an.
--strict behandelt ausgewählte Patch-Fehler als Fehler.

Workflow

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

Wenn ein ausgewählter Patch auf @capacitor/cli, wird der Patch auf das installierte CLI Paket und das nächste cap verwendet den gepatchten CLI code.

Weiter geht's nach Getting Started

Wenn du es nutzt Erste Schritte Um die Arbeit an nativen Plugins zu planen, verbinde sie mit Verwendung von @capgo/capacitor-patch für die native Funktion in „Using @capgo/capacitor-patch“, Capgo Plugin-Verzeichnis für den Produkt-Workflow im Capgo Plugin-Verzeichnis, Capacitor Plugins von Capgo für das Implementierungsdetail in Capacitor Plugins von Capgo, Plugins hinzufügen oder aktualisieren für das Implementierungsdetail beim Hinzufügen oder Aktualisieren von Plugins, und Ionic Enterprise Plugin-Alternativen für den Produkt-Workflow bei den Ionic Enterprise Plugin-Alternativen.