Getting Started

Copiez un prompt de configuration avec les étapes d'installation et le guide markdown complet pour ce 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.

Installation

Vous pouvez utiliser notre configuration assistée par l'IA pour installer le plugin. Ajoutez les Capgo compétences à votre outil IA en utilisant la commande suivante :

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

Ensuite, utilisez la prompt suivante :

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

Si vous préférez la configuration manuelle, installez le plugin en exécutant les commandes suivantes et suivez les instructions spécifiques au plateforme ci-dessous :

npm install @capgo/capacitor-patch
npx cap sync

Le package est un no-op jusqu'à ce que vous sélectionniez des correctifs dans votre Capacitor config.

Sélectionnez les ID des correctifs

Lister tous les patchs expédiés :

npx capgo-capacitor-patch list --all

Ajoutez ensuite les identifiants de patch dont votre application a besoin à 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;

Exécutez à nouveau la synchronisation :

npx cap sync

Les patchs de package sont exécutés avant sync et updateles patchs de projet natif sont exécutés après sync et update.

Avant d'appliquer, passez en mode débogage

Utilisez doctor pour vérifier si les correctifs sélectionnés correspondent aux versions de votre package installé :

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

Utilisez apply lorsque vous souhaitez exécuter les correctifs sélectionnés manuellement :

npx capgo-capacitor-patch apply --phase package

Options de configuration

Option	Type	Défaut	Description
`recommended`	`boolean`	`false`	Applique les correctifs Capgo marqués comme recommandés.
`patches`	`string[]`	`[]`	Applique les identifiants de correctifs explicites.
`disabled`	`string[]`	`[]`	Omet les identifiants de correctifs sélectionnés, même lorsqu'ils sont recommandés.
`strict`	`boolean`	`false`	Lève une erreur lorsque le correctif sélectionné est incompatible ou ne peut pas être appliqué.

les commandes CLI

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

Options utiles :

--root <dir> définit la racine de l'application.
--phase package|native|all limite la phase de mise à jour qui s'exécute.
--platform ios|android applique le filtrage de plateforme en dehors d'un Capacitor crochet.
--strict traite les erreurs sélectionnées comme des erreurs.

Workflow

Installer @capgo/capacitor-patch.
Exécuter npx capgo-capacitor-patch list --all.
Ajoutez les identifiants de patch sélectionnés à plugins.CapacitorPatch.patches.
Exécuter npx capgo-capacitor-patch doctor --strict.
Exécuter npx cap sync.

Lorsqu'un patch sélectionné cible @capacitor/cli, le patch s'applique au package CLI installé et au prochain cap command uses the patched CLI code.

Section intitulée “Continuez depuis Getting Started”

Getting Started Si vous utilisez planer les travaux de plugin natif, connectez-le à En utilisant @capgo/capacitor-patch pour la capacité native dans En utilisant @capgo/capacitor-patch, Capgo Répertoire des plugins pour le flux de travail du produit dans Capgo Répertoire des plugins, Capacitor Plugins par Capgo pour le détail d'implémentation dans Capacitor Plugins par Capgo, Ajouter ou Mettre à jour les Plugins pour le détail d'implémentation dans Ajouter ou Mettre à jour les Plugins, et Alternatives de plugins d'entreprise Ionic pour le flux de travail du produit dans Alternatives de plugins d'entreprise Ionic.