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.

Install

Vous pouvez utiliser notre configuration assistée par l'IA pour installer le plugin. Ajoutez les Capgo compétences à votre outil IA à l'aide de 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 configuration.

Sélectionnez les identifiants de patch

Lister tous les patchs expédiés :

npx capgo-capacitor-patch list --all

Ensuite, ajoutez les identifiants de patch dont votre application a besoin de 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écuter à nouveau la synchronisation :

npx cap sync

Les patchs de package s'exécutent avant sync et update. Projet natif patchs s'exécutent après sync et update.

Avant d'appliquer, mode essai :

Utilisez doctor pour vérifier si les patchs 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 patchs sélectionnés manuellement :

npx capgo-capacitor-patch apply --phase package

Options de configuration

Option	Type	Valeur par défaut	Description
`recommended`	`boolean`	`false`	Applique les correctifs Capgo 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`	Jette une erreur lorsque le correctif sélectionné est incompatible ou ne peut pas être appliqué.

CLI commandes

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

Options utiles :

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

Flux de travail

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

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

Continuer depuis Getting Started

Si vous utilisez Démarrage pour planifier le travail de plugin natif, le connecter avec En utilisant @capgo/capacitor-patch pour la capacité native dans En utilisant @capgo/capacitor-patch, Répertoire de Plugin Capgo pour le flux de travail du produit dans Répertoire de Plugin Capgo, Plugins Capacitor par Capgo pour le détail d'implémentation dans Plugins Capacitor par Capgo, Ajout ou Mise à Jour de Plugins pour le détail d'implémentation dans Ajout ou Mise à Jour de Plugins, et Alternatives de Plugins d'Entreprise Ionic pour le flux de travail du produit dans Alternatives de Plugins d'Entreprise Ionic.