Getting Started

Eine Einrichtungsvorschlag mit den Installationsanweisungen und der vollständigen Markdown-Anleitung für diesen Plugin kopieren.

        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

npm install @capgo/capacitor-patch
npx cap sync

Das Paket ist bis zum Auswahl der Patches in Ihrer Capacitor-Konfiguration ein No-Op.

Patch-IDs auswählen

Alle gelieferten Patches auflisten:

npx capgo-capacitor-patch list --all

Fügen Sie dann die Patch-IDs hinzu, 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;

Synchronisieren Sie erneut:

npx cap sync

Paketpatches werden vor sync und update. Native-Projektpatches werden nach sync und update.

Trockenlauf vor der Anwendung

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

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

Verwenden Sie apply um die ausgewählten Patches manuell auszuführen:

npx capgo-capacitor-patch apply --phase package

Konfigurationsoptionen

Einstellung	Typ	Standard	Beschreibung
`recommended`	`boolean`	`false`	Patches Capgo als empfohlen markiert.
`patches`	`string[]`	`[]`	Expizite Patch-IDs anwendet.
`disabled`	`string[]`	`[]`	Ausgewählte Patch-IDs, auch wenn empfohlen, überspringt.
`strict`	`boolean`	`false`	Würft eine Ausgewählte Patch-IDs, wenn diese inkompatibel oder nicht anwendbar ist.

CLI Befehle

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

Nützliche Optionen:

--root <dir> die App-Root-Verzeichnis festlegt.
--phase package|native|all bestimmt, welcher Patch-Phase läuft.
--platform ios|android Plattform-Filterung außerhalb eines Capacitor-Hooks anwendet.
--strict Ausgewählte Patchfehler als Fehler behandelt.

Arbeitsablauf

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

Wenn ein ausgewählter Patch auf @capacitor/cli den installierten CLI-Paket zielt und den nächsten cap Befehl verwendet, der den gepatchten CLI code verwendet.

Weitermachen von Getting Started

Wenn Sie native Plugin-Arbeiten mit Getting Started planen, verbinden Sie es mit Mit @capgo/capacitor-patch für die native Fähigkeit in Mit @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 den Produktworkflow in Ionic Enterprise Plugin Alternativen.