Prise en main

Copiez un prompt de configuration incluant 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.

Installer

Vous pouvez utiliser notre configuration assistée par IA pour installer le plugin. Ajoutez les skills Capgo à votre outil d'IA avec la commande suivante :

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

Utilisez ensuite le prompt suivant :

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 une installation manuelle, installez le plugin en exécutant les commandes suivantes et suivez les instructions spécifiques à chaque plateforme ci-dessous :

npm install @capgo/capacitor-patch
npx cap sync

Le package est inerte tant que vous n’avez pas sélectionné de patches dans votre configuration Capacitor.

Démarrage rapide

bun add @capgo/capacitor-patch
npx cap sync

Erreurs courantes

Vérifiez les conditions de version avant de mettre à niveau Capacitor.
Installez-l’en CI avant cap sync.
Relancez sync après les modifications natives.

Sélectionner les IDs de patch

Lister tous les patches déployés :

npx capgo-capacitor-patch list --all

Ajoutez ensuite les patch IDs dont votre app a besoin dans 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;

Relancez la commande sync :

npx cap sync

Les patches de package s'exécutent avant sync et update. Les patches du projet natif s'exécutent après sync et update.

Dry-run avant application

Utiliser doctor pour vérifier si les patches sélectionnés correspondent aux versions de vos packages installés :

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

Utiliser apply lorsque vous souhaitez exécuter manuellement les patches sélectionnés :

npx capgo-capacitor-patch apply --phase package

Options de configuration

Option	Type	Par défaut	Description
`recommended`	`boolean`	`false`	Applique les patchs marqués comme recommandés par Capgo.
`patches`	`string[]`	`[]`	Applique des IDs de patch explicites.
`disabled`	`string[]`	`[]`	Ignore les IDs de patch sélectionnés, même s'ils sont recommandés.
`strict`	`boolean`	`false`	Lève une erreur si un patch sélectionné est incompatible ou ne peut pas s'appliquer.

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 patch à exécuter.
--platform ios|android applique le filtrage par plateforme en dehors d’un hook Capacitor.
--strict considère les échecs de patch sélectionnés comme des erreurs.

Workflow

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

Lorsqu'un patch sélectionné cible @capacitor/cli, le patch s'applique au package CLI installé et à la prochaine cap commande utilise le code CLI patché.

Continuer depuis Getting Started

Si vous utilisez Prise en main pour planifier le travail sur les plugins natifs, connectez-l’à Utiliser @capgo/capacitor-patch pour la fonctionnalité native dans Utilisation de @capgo/capacitor-patch, Capgo Répertoire des plugins pour le workflow produit dans Capgo Plugin Directory, Plugins Capacitor par Capgo pour les détails d'implémentation dans Plugins Capacitor par Capgo, Ajouter ou mettre à jour des plugins pour les détails d'implémentation dans Ajout ou mise à jour de plugins, et Alternatives aux plugins Ionic Enterprise pour le workflow produit dans Alternatives aux plugins Ionic Enterprise.