Comment ajouter des dépendances aux plugins Capacitor

Configuration de votre environnement de développement

Préparez votre configuration avec les outils nécessaires pour gérer efficacement les dépendances des plugins Capacitor.

Outils de développement requis

Voici la liste des outils dont vous aurez besoin :

Démarrer un nouveau plugin

Utilisez le CLI Capacitor pour lancer votre projet de plugin. Cela inclut la configuration des plateformes et le nommage de votre plugin en format reverse-domain (ex: com.mycompany.plugin) :

1. Exécutez la commande suivante : npm init @capacitor/plugin
2. Choisissez vos plateformes cibles (iOS/Android).
3. Attribuez un nom à votre plugin au format reverse-domain.

Étapes de configuration du projet

1. Mettre à jour package.json

   Modifiez votre package.json pour inclure ce qui suit :

2. Configuration spécifique aux plateformes

   • Pour iOS, assurez-vous que votre Podfile inclut :

   • Pour Android, vérifiez que votre build.gradle contient :

3. Configurer les variables d’environnement

   Configurez les variables d’environnement suivantes pour vos outils de développement :

   Variable	Objectif	Exemple de valeur
   ANDROID_HOME	Emplacement du SDK Android	/Users/username/Library/Android/sdk
   JAVA_HOME	Chemin d’installation JDK	/Library/Java/JavaVirtualMachines/jdk-11.0.12.jdk/Contents/Home
   XCODE_SELECT	Outils en ligne de commande Xcode	/Applications/Xcode.app/Contents/Developer

Une fois votre projet configuré, vous êtes prêt à passer à la gestion des dépendances JavaScript.

Dépendances JavaScript

La gestion efficace des dépendances JavaScript est essentielle pour maintenir des performances stables du plugin.

Installation des paquets npm

Pour installer les dépendances, utilisez les commandes suivantes :

Assurez-vous d’inclure manuellement les dépendances peer dans votre fichier package.json. Testez toutes les dépendances pour confirmer la compatibilité sur les plateformes web et natives.

Gestion de package.json

Voici un exemple de configuration package.json :

Pour maintenir la cohérence, verrouillez les versions des dépendances de manière appropriée :

Utilisation des bibliothèques JavaScript

Lors de l’importation de bibliothèques, concentrez-vous sur la réduction de la taille du bundle :

De plus, assurez-vous une gestion appropriée des erreurs et une vérification des types :

Passons maintenant à la gestion des dépendances spécifiques à iOS.

Dépendances iOS

Cette section explique comment gérer les dépendances natives iOS dans les plugins Capacitor. Une fois vos dépendances JavaScript configurées, l’étape suivante consiste à gérer les dépendances natives iOS.

Configuration de CocoaPods

Commencez par initialiser CocoaPods dans votre répertoire iOS :

Ensuite, mettez à jour votre fichier Plugin.podspec avec les configurations suivantes :

Configuration du Podfile

Après avoir initialisé CocoaPods, configurez le Podfile pour inclure Capacitor et toutes les bibliothèques tierces supplémentaires :

Voici quelques modèles courants de configuration des dépendances :

Dépendances Swift Package

Si vous préférez ne pas utiliser CocoaPods, Swift Package Manager (SPM) est une bonne alternative. Ajoutez les dépendances SPM directement dans Xcode avec la configuration suivante dans votre fichier Package.swift :

Pour utiliser les dépendances SPM dans votre code plugin, importez-les et intégrez-les selon les besoins. Par exemple :

Cette approche vous permet de choisir entre CocoaPods et Swift Package Manager en fonction des exigences de votre projet.

Dépendances Android

Configurez les dépendances Android pour assurer une intégration native fluide. Voici comment gérer les dépendances pour votre plugin Capacitor.

Dépendances Gradle

Ajoutez les configurations suivantes à votre fichier build.gradle :

Définissez des versions supplémentaires dans le bloc buildscript :

Une fois les dépendances configurées, assurez-vous de configurer les dépôts nécessaires.

Configuration des dépôts

Dans votre build.gradle au niveau du projet, incluez les dépôts Maven requis :

Si vous utilisez des dépôts Maven personnalisés ou privés, ajoutez les identifiants comme ceci :

Une fois les dépôts configurés, traitez les conflits de dépendances qui peuvent survenir.

Résolution des problèmes de compatibilité

Pour gérer les conflits de dépendances, appliquez des résolutions de version dans votre build.gradle :

Voici des stratégies pour résoudre les problèmes de dépendances courants :

Par exemple, vous pouvez exclure les modules en conflit comme ceci :

Enfin, optimisez votre processus de build en activant la mise en cache et l’exécution parallèle dans gradle.properties :

Intégration Capgo

L’utilisation de Capgo aux côtés de la gestion des dépendances natives et JavaScript rend la mise à jour de votre plugin plus rapide et plus facile.

À propos de Capgo

Capgo est une plateforme de mise à jour en direct conçue pour les plugins et applications Capacitor. Avec plus de 23,5 millions de mises à jour livrées sur 750 applications en production [1], Capgo permet aux développeurs de pousser instantanément des mises à jour pour les dépendances et le code - sans examen des app stores requis. Les mises à jour sont sécurisées avec un chiffrement de bout en bout et respectent les normes de conformité Apple et Android.

Fonctionnalités de mise à jour Capgo

Capgo simplifie la gestion des dépendances des plugins avec ces fonctionnalités :

Source : [1]

Capgo fonctionne parfaitement avec les outils CI/CD comme GitHub Actions, GitLab CI et Jenkins, automatisant les mises à jour des dépendances et assurant des versions cohérentes des plugins. Ces outils facilitent l’intégration de Capgo dans votre flux de travail.

Configuration de Capgo

Suivez ces étapes pour intégrer Capgo dans votre projet :

1. Installer la CLI Capgo

   Exécutez la commande suivante dans votre terminal :

   {
     "capacitor": {
       "ios": {
         "src": "ios"
       },
       "android": {
         "src": "android"
       }
     },
     "peerDependencies": {
       "@capacitor/core": "^5.0.0"
     }
   }

2. Configurer les préférences de mise à jour

   Utilisez le tableau de bord Capgo pour configurer les canaux de déploiement et les préférences. Les configurations hébergées dans le cloud et auto-hébergées sont prises en charge.

3. Ajouter la logique de mise à jour

   Ajoutez ce code à votre fichier principal de plugin pour activer les mises à jour :

       platform :ios, '13.0'
       use_frameworks!
       ```

“Nous pratiquons le développement agile et @Capgo est essentiel pour livrer en continu à nos utilisateurs !” - Rodrigo Mantica

Capgo fournit également un tableau de bord analytique pour des informations en temps réel sur les taux de réussite des mises à jour et l’activité des utilisateurs. Des fonctionnalités comme le retour en arrière en un clic et le suivi des erreurs aident à résoudre rapidement les problèmes, maintenant vos mises à jour de plugins fluides.

Conclusion

Revue du processus

La gestion des dépendances pour les plugins Capacitor implique d’aligner les composants natifs (iOS et Android) avec leurs équivalents JavaScript pour assurer une intégration fluide. Ce processus comprend des configurations spécifiques aux plateformes et la gestion des packages JavaScript pour obtenir les meilleures performances. Suivre les étapes décrites aidera à maintenir une fonctionnalité stable et efficace des plugins.

Meilleures pratiques

Pour gérer efficacement les dépendances, considérez ces pratiques :

L’utilisation d’outils de mise à jour en direct comme Capgo peut simplifier et améliorer davantage ces pratiques en permettant des mises à jour en temps réel.

Avantages de Capgo

Capgo simplifie le processus de gestion des dépendances tout en offrant de solides performances. Il atteint un impressionnant taux de mise à jour de 95% des utilisateurs en 24 heures et maintient un temps de réponse API global de 434ms [1]. Avec le chiffrement de bout en bout, il assure des mises à jour sécurisées conformes aux directives Apple et Android. Pour les équipes gérant plusieurs versions de plugins, le système de canaux de Capgo permet des déploiements ciblés pour des groupes d’utilisateurs spécifiques.

Voici un aperçu rapide des performances de Capgo :