Installation
Copiez une commande de configuration avec les étapes d'installation et la 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
Section intitulée « Installer »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-pluginsUtilisez ensuite 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 à la plateforme ci-dessous :
npm install @capgo/capacitor-patchnpx cap syncLe package est un no-op jusqu'à ce que vous sélectionniez des correctifs dans votre Capacitor config.
Sélectionnez les ID des correctifs
Sélectionnez les identifiants de patchListe de tous les correctifs expédiés :
npx capgo-capacitor-patch list --allThen add the patch IDs your app needs to 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 syncLes patchs de package s'exécutent avant sync et updateLes patchs de projet natif s'exécutent après sync et update.
Étude de cas avant application
Section intitulée « Étude de cas avant application »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 --strictUtilisez apply lorsque vous souhaitez exécuter les correctifs sélectionnés manuellement :
npx capgo-capacitor-patch apply --phase packageOptions de configuration
Section intitulée « Options de configuration »| Option | Type | Par défaut | Description |
|---|---|---|---|
recommended | boolean | false | S'applique aux correctifs Capgo marqués comme recommandés. |
patches | string[] | [] | S'applique aux identifiants de correctifs explicites. |
disabled | string[] | [] | Omet les ID de patch sélectionnés, même recommandés. |
strict | boolean | false | Throws when a selected patch is incompatible or cannot apply. |
CLI commandes
Section intitulée « CLI commandes »npx capgo-capacitor-patch list --allnpx capgo-capacitor-patch doctornpx capgo-capacitor-patch applyOptions utiles :
--root <dir>fixe la racine de l'application.--phase package|native|alllimite les phases de mise à jour.--platform ios|androidapplique le filtrage de plateforme en dehors d'un crochet Capacitor.--strictTraite les échecs de patch sélectionnés comme des erreurs.
Flux de travail
Section intitulée « Flux de travail »- Installer
@capgo/capacitor-patch. - Exécuter
npx capgo-capacitor-patch list --all. - Ajoutez les identifiants de patch sélectionnés à
plugins.CapacitorPatch.patches. - Exécutez
npx capgo-capacitor-patch doctor --strict. - Exécutez
npx cap sync.
Si un patch sélectionné cible @capacitor/clile patch s'applique au package CLI installé et au prochain cap le command utilise le patché CLI code.
Continuez de l'onglet Démarrage
Section intitulée « Continuez de l'onglet Démarrage »Si vous utilisez Getting Started pour planifier le travail de plugin natif, connectez-l’à Utilisez @capgo/capacitor-patch pour la capacité native dans l'utilisation de @capgo/capacitor-patch, Capgo Répertoire du plugin pour le flux de travail du produit dans Capgo Répertoire du plugin, 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.