Getting Started

GitHub

Kopieren Sie einen Einrichtungsvorschlag mit den Installationsanweisungen und der vollständigen Markdown-Guideline 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 den Capgo-Fähigkeiten Ihre AI-Werkzeug hinzufügen, indem Sie die folgende Befehl ausführen:

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

Verwenden Sie dann die folgende Anfrage:

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 folgen Sie den unten angegebenen Plattform-spezifischen Anweisungen:

npm install @capgo/capacitor-patch
npx cap sync

Das Paket ist bis zu dem Zeitpunkt, an dem Sie Patches in Ihrer Capacitor-Konfiguration auswählen, eine No-Op.

Wählen Sie Patch-IDs

Alle verschickten 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;

Synchronisierung erneut durchführen:

npx cap sync

Paket-Patches werden vorher ausgeführt sync und update. Native project Patches werden nach dem Anwenden ausgeführt sync und update.

Dry-run vor dem Anwenden

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 wenn Sie die ausgewählten Patches manuell ausführen möchten:

npx capgo-capacitor-patch apply --phase package

Konfigurationsoptionen

Option	Typ	Standard	Beschreibung
`recommended`	`boolean`	`false`	Wendet Patches mit Capgo-Marken als empfohlen zu.
`patches`	`string[]`	`[]`	Wendet explizite Patch-IDs an.
`disabled`	`string[]`	`[]`	Überspringt ausgewählte Patch-IDs, auch wenn diese empfohlen werden.
`strict`	`boolean`	`false`	Würfelt, wenn eine ausgewählte Patches inkompatibel ist oder nicht angewendet werden kann.

Abschnitt mit dem Titel “CLI-Befehle”

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

setzt den Anwendungsroot.

--root <dir> beschränkt, welcher Patch-Phase ausgeführt wird.
--phase package|native|all wirkt Plattformfilterung außerhalb eines __CAPGO_KEEP_0__-Hooks.
--platform ios|android applies platform filtering outside a Capacitor hook.
--strict Workflow

Arbeitsablauf

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

Wenn ein ausgewählter Patch das @capacitor/cliinstallierte CLI Paket und das nächste cap Befehl verwendet das gepatchte CLI code.

Weiter von Getting Started

Wenn Sie Cloudflare verwenden Zum Starten um native Plugin-Arbeit zu planen, verbinden Sie es mit Mit @capgo/capacitor-patch verwenden 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.