Getting Started
Copiez un prompt de configuration avec les étapes d'installation et la guide markdown complète pour ce plugin.
Set up this Capacitor plugin in the project.
Use the package manager already used by the project.
Install these packages:
- `@capacitor-plus/core`
- `@capacitor-plus/cli`
- `@capacitor-plus/android` if the project targets Android
- `@capacitor-plus/ios` if the project targets iOS
Complete the required Capacitor initialization, platform, sync, native setup, and configuration work.
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-plus/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 de Nouveau Projet
Section intitulée “Installation de Nouveau Projet”Vous pouvez utiliser notre configuration assistée par l'IA pour installer Capacitor+. Ajoutez les compétences Capgo à votre outil IA à l'aide de la commande suivante :
npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-pluginsUtilisez ensuite la commande suivante :
Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capacitor-plus/core`, `@capacitor-plus/cli`, `@capacitor-plus/android`, and `@capacitor-plus/ios` packages in my project.Si vous préférez la configuration manuelle, installez les packages en exécutant les commandes suivantes et suivez les instructions spécifiques à la plateforme ci-dessous :
-
Installer les packages de base
Fenêtre de terminal npm install @capacitor-plus/core @capacitor-plus/cli -
Ajouter les packages de plateforme
Fenêtre de terminal npm install @capacitor-plus/android # for Androidnpm install @capacitor-plus/ios # for iOS -
Initialiser Capacitor
Fenêtre de terminal npx cap initFenêtre de terminal pnpm cap initFenêtre de terminal yarn cap initFenêtre de terminal bunx cap init -
Ajouter des plateformes
Fenêtre de terminal npx cap add androidFenêtre de terminal pnpm cap add androidFenêtre de terminal yarn cap add androidFenêtre de terminal bunx cap add androidFenêtre de terminal npx cap add iosFenêtre de terminal pnpm cap add iosFenêtre de terminal yarn cap add iosFenêtre de terminal bunx cap add ios
Migrer depuis le Capacitor officiel
Section intitulée “Migrer depuis l’official Capacitor”Si vous avez un projet Capacitor existant, la migration vers Capacitor+ est simple :
-
Supprimer les packages officiels
Fenêtre de terminal npm uninstall @capacitor/core @capacitor/cli @capacitor/android @capacitor/ios -
Installer les packages Capacitor+
Fenêtre de terminal npm install @capacitor-plus/core @capacitor-plus/clinpm install @capacitor-plus/android # if using Androidnpm install @capacitor-plus/ios # if using iOS -
Synchroniser votre projet
Fenêtre de terminal npx cap syncFenêtre de terminal pnpm cap syncFenêtre de terminal yarn cap syncFenêtre de terminal bunx cap sync
Utilisation
Section intitulée « Utilisation »Depuis que Capacitor+ est compatible avec API-, votre code existant fonctionne sans modifications :
import { Capacitor } from '@capacitor/core';import { registerPlugin } from '@capacitor/core';
// Check platformconst platform = Capacitor.getPlatform();console.log('Running on:', platform);
// Check if nativeif (Capacitor.isNativePlatform()) { console.log('Running on native platform');}
// Register a custom pluginconst MyPlugin = registerPlugin('MyPlugin');Avec les plugins officiels Capacitor
Section intitulée « Avec les plugins officiels Capacitor »Tous les plugins officiels Capacitor fonctionnent sans heurt :
import { Camera, CameraResultType } from '@capacitor/camera';import { Geolocation } from '@capacitor/geolocation';import { Storage } from '@capacitor/preferences';
// Cameraconst photo = await Camera.getPhoto({ quality: 90, resultType: CameraResultType.Uri});
// Geolocationconst position = await Geolocation.getCurrentPosition();
// Storageawait Storage.set({ key: 'name', value: 'John' });Avec les plugins Capgo
Section intitulée « Avec les plugins Capgo »Les plugins Capgo fonctionnent parfaitement avec Capacitor+ :
import { CapacitorUpdater } from '@capgo/capacitor-updater';import { ScreenOrientation } from '@capgo/capacitor-screen-orientation';import { CapacitorFlash } from '@capgo/capacitor-flash';
// Live updatesawait CapacitorUpdater.notifyAppReady();
// Screen orientationawait ScreenOrientation.lock({ orientation: 'portrait' });
// Flashlightawait CapacitorFlash.toggle();How the Sync Works
Section intitulée « Comment fonctionne la synchronisation »┌─────────────────────┐ ┌──────────────────┐ ┌──────────────────┐ ┌─────────────────┐│ ionic-team/ │ │ CI/CD │ │ Claude Code │ │ npm publish ││ capacitor │────▶│ Pipeline │────▶│ Security Review │────▶│ @capacitor-plus││ (upstream) │ │ (daily sync) │ │ (AI analysis) │ │ packages │└─────────────────────┘ └──────────────────┘ └──────────────────┘ └─────────────────┘- Synchronisation quotidienne: GitHub Actions récupèrent les dernières modifications depuis
ionic-team/capacitor - Création de PR: Les modifications sont proposées sous forme de demandes de tirage vers le
plusbranchement - Validation CI: Tout le jeu de tests est exécuté (lint, tests unitaires, build iOS, build Android)
- Révision de sécurité: L'analyse par intelligence artificielle vérifie les vulnérabilités et les changements de rupture
- Mise à jour automatique: Seulement si le CI passe ET la revue de sécurité approuve
- Publier automatiquement: Nouvelle version publiée sous npm dans
@capacitor-plus/*
Détails de la Revue de Sécurité
Section intitulée « Détails de la Revue de Sécurité »Chaque synchronisation en amont est analysée pour :
| Vérifier | Ce qu'il repère |
|---|---|
| Sécurité | Injection de commande, XSS, parcours de chemins, secrets fixés |
| Changements de rupture | APIs supprimés/renommés, changements de signatures, modifications de la configuration |
| Stabilité | Stabilité |
| Références à null, exceptions non gérées, conditions de course, fuites de mémoire | Sécurité des données |
| Code Integrity | Obfuscated code, suspicious network calls, backdoors |
Si des problèmes sont détectés, le PR est signalé pour examen manuel et NE sera PAS fusionné automatiquement. Cela vous assure toujours des mises à jour stables et sécurisées.
Soumettre votre PRVous avez un PR bloqué dans le dépôt officiel Capacitor ? Obtenez-l’intégré dans Capacitor+ :
-
Ouvrez une question dans le dépôt Capacitor+ en faisant référence à votre PR upstream
-
Ou soumettez directement comme un PR dans la
plusbranch -
Équipe de révision, exécution de CI et intégration si elle passe
Cela permet à vous et aux autres de bénéficier de votre travail immédiatement sans attendre le cycle de mise à jour upstream.
Est-ce que c'est prêt pour la production ?
Section intitulée « Est-ce que c'est prêt pour la production ? »Oui. Capacitor+ est utilisé dans les applications de production. Chaque mise à jour passe le même ensemble de tests que le Capacitor officiel, plus une analyse de sécurité supplémentaire.
Mes plugins officiels fonctionneront-ils toujours ?
Section intitulée « Mes plugins officiels fonctionneront-ils toujours ? »Oui. Tous les @capacitor/* plugins fonctionnent avec Capacitor+ sans modification.
Quoi faire si une mise à jour upstream introduit une modification de rupture ?
Section intitulée « Quoi faire si une mise à jour upstream introduit une modification de rupture ? »La revue de sécurité par l'IA signale les modifications de rupture pour examen manuel. Vous verrez les changements documentés avant qu'ils soient fusionnés.
Comment signaler des problèmes ?
Section intitulée « Comment signaler des problèmes ? »Signalez des problèmes sur le Capacitor+ GitHub repoPour les problèmes qui affectent également le Capacitor officiel, nous coordonnerons l'implémentation upstream.
Peut-on contribuer ?
Sous-titre : « Peut-on contribuer ? »Absolument ! Les PR sont les bienvenus. Vous pouvez soumettre des correctifs directement ou demander que des PR spécifiques upstream soient fusionnés.
Continuez de la section « Getting Started »
Sous-titre : « Continuez de la section « Getting Started » »Si vous utilisez Getting Started pour planifier le travail de plugin natif, connectez-l’avec Utilisation de Capacitor+ (@capacitor-plus) Packages pour la capacité native dans l'utilisation de Capacitor+ (@capacitor-plus) Packages, 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 Entreprise Ionic pour le flux de travail du produit dans Alternatives de Plugins Entreprise Ionic.