Comment ajouter des dépendances dans les plugins Capacitor

__CAPGO_KEEP_0__ Capacitor Les plugins peuvent sembler surchargés, mais il est plus facile lorsqu'ils sont décomposés en étapes claires. Voici ce dont vous avez besoin de savoir :

1. Comprenez les outils:

   • JavaScript: Utilisez npm pour gérer les dépendances.
   • iOS: Utilisez CocoaPods ou Swift Package Manager (SPM).
   • Android: Utilisez Gradle pour la gestion des dépendances.

2. Configurer votre environnement de développement:

   • Installez des outils comme Node.js, npm, Xcode, Android Studio, CocoaPods et JDK.

3. Démarrer votre Capacitor projet de plugin:

   • Utilisez npm init @capacitor/plugin pour créer un nouveau plugin.

4. Ajouter des dépendances JavaScript:

   • Utilisez npm install pour les dépendances de production et de développement.
   • Mise à jour package.json pour inclure des dépendances de pair comme @capacitor/core.

5. Gérer les dépendances spécifiques à la plateforme:

   • iOS: Configurez CocoaPods ou SPM avec des bibliothèques comme Alamofire ou SwiftyJSON.
   • Android: Utilisez Gradle pour ajouter des dépendances comme Gson ou AppCompat.

6. Optimisez les performances:

   • Fixez les versions, passez en revue les dépendances et résolvez les conflits pour garantir la stabilité.

7. Utilisez des outils comme Capgo pour les mises à jour en temps réel:

   • Publiez des mises à jour instantanément sans passer par les revues des magasins d'applications.

Comparaison Rapide des Outils:

Pourquoi cela compte: Gérer efficacement les dépendances garantit que votre plugin fonctionne sans heurt sur plusieurs plateformes, économise du temps et évite les erreurs. Enfonçons-nous plus profondément dans les étapes.

Comment créer un Capacitor context

Configuration de votre environnement de développement

Préparez votre configuration avec les outils nécessaires pour gérer efficacement Capacitor plugin les dépendances de manière efficace.

Outils de développement requis

Voici une liste d'outils dont vous aurez besoin :

Création d'un Nouveau Plugin

Utilisez les Capacitor CLI pour démarrer votre projet de plugin. Cela inclut la configuration des plateformes et la nomination de votre plugin en utilisant un format de domaine inversé (par exemple, 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 sous la forme d'un nom de domaine inversé.

Étapes de configuration du projet

1. Mettre à jour package.json

   Modifiez votre package.json pour qu'il inclue les éléments suivants :

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

2. Configuration de la plateforme spécifique

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

     platform :ios, '13.0'
     use_frameworks!

   • Pour Androidvérifiez votre build.gradle contient :

     android {
         compileSdkVersion 33
         defaultConfig {
             minSdkVersion 22
         }
     }

3. Configurer les variables d'environnement suivantes pour vos outils de développement :

   Variable

   But	Valeur d'exemple	ANDROID_HOME
   Emplacement d'Android __CAPGO_KEEP_0__	/Users/username/Library/Android/SDK	/Users/username/Library/Android/sdk
   Configuration de l'environnement	Chemin d'installation de JDK	/Library/Java/JavaVirtualMachines/jdk-11.0.12.jdk/Contents/Home
   XCODE_SELECT	Outils de 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

Gérer efficacement les dépendances JavaScript est essentiel pour maintenir une performance stable du plugin.

npm Installation de package

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

# Add a production dependency
npm install lodash --save

# Add a development dependency
npm install @types/lodash --save-dev

Assurez-vous d'inclure manuellement les dépendances de pair dans votre package.json Testez toutes les dépendances pour confirmer la compatibilité sur les deux plateformes web et natives.

Gestion de package.json

Voici un exemple package.json de configuration :

{
  "name": "my-capacitor-plugin",
  "version": "1.0.0",
  "dependencies": {
    "lodash": "^4.17.21"
  },
  "devDependencies": {
    "@types/lodash": "^4.14.195",
    "@capacitor/core": "^5.0.0"
  },
  "peerDependencies": {
    "@capacitor/core": "^5.0.0"
  }
}

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

Utilisation de bibliothèques JavaScript

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

// Import only the required function
import { isEqual } from 'lodash';

export class MyPlugin {
  async compare(options: { value1: any, value2: any }): Promise<boolean> {
    return isEqual(options.value1, options.value2);
  }
}

Assurez-vous également d'une gestion des erreurs et d'une vérification de type correctes :

import { Plugin } from '@capacitor/core';
import { validate } from 'your-validation-library';

@Plugin({
  name: 'MyPlugin',
  platforms: ['web', 'ios', 'android']
})
export class MyPlugin {
  async validateData(data: unknown): Promise<void> {
    try {
      if (!validate(data)) {
        throw new Error('Invalid data format');
      }
      // Continue processing if valid
    } catch (error) {
      throw new Error(`Validation failed: ${error.message}`);
    }
  }
}

Découvrez ensuite comment gérer les dépendances spécifiques aux plateformes pour iOS.

Dépendances iOS

Cette section explique comment gérer les dépendances natives iOS dans les Capacitor pluginsCocoaPods

Une fois que vous avez configuré vos dépendances JavaScript, le prochain pas consiste à gérer les dépendances natives iOS. Configuration

Commencez par initialiser CocoaPods dans votre répertoire iOS :

cd ios
pod init

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

Pod::Spec.new do |s|
  s.name = 'MyCapacitorPlugin'
  s.version = '1.0.0'
  s.summary = 'Your plugin description'
  s.platform = :ios, '13.0'
  s.dependency 'Capacitor'
  # Include your iOS dependencies here
  s.dependency 'Alamofire', '~> 5.6.4'
end

Configuration de Podfile

Après avoir initialisé CocoaPods, configurez le fichier Podfile pour inclure Capacitor et toute autre bibliothèque tiers supplémentaire :

platform :ios, '13.0'
use_frameworks!

def capacitor_pods
  pod 'Capacitor', :path => '../../node_modules/@capacitor/ios'
  pod 'CapacitorCordova', :path => '../../node_modules/@capacitor/ios'
end

target 'Plugin' do
  capacitor_pods
  # Add third-party dependencies
  pod 'KeychainAccess', '~> 4.2.2'
  pod 'SwiftyJSON', '~> 5.0.1'
end

target 'PluginTests' do
  capacitor_pods
end

Ici sont présentés quelques modèles de configuration de dépendance courants :

Dépendances de package Swift

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

// Package.swift
dependencies: [
    .package(url: "https://github.com/Alamofire/Alamofire.git", .upToNextMajor(from: "5.6.4")),
    .package(url: "https://github.com/SwiftyJSON/SwiftyJSON.git", from: "5.0.1")
]

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

import Capacitor
import Alamofire

@objc(MyPlugin)
public class MyPlugin: CAPPlugin {
    @objc func makeRequest(_ call: CAPPluginCall) {
        AF.request("https://api.example.com/data").response { response in
            // Process the response
            call.resolve([
                "data": response.data
            ])
        }
    }
}

Cette approche vous permet de choisir entre CocoaPods et le gestionnaire de packages Swift en fonction de vos besoins de projet.

Dépendances Android

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

Gradle Dépendances

Ajoutez les configurations suivantes à votre build.gradle fichier :

android {
    defaultConfig {
        minSdkVersion 22
        targetSdkVersion 33
    }
}

dependencies {
    implementation "androidx.appcompat:appcompat:1.6.1"
    implementation "com.google.code.gson:gson:2.10.1"
    implementation "org.jetbrains.kotlin:kotlin-stdlib:1.8.20"
    implementation project(':capacitor-android')
}

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

buildscript {
    ext {
        androidxCoreVersion = '1.10.1'
        kotlinVersion = '1.8.20'
    }
}

Une fois les dépendances configurées, assurez-vous de configurer les répertoires nécessaires.

Configuration du répertoire

Dans votre niveau de projet build.gradle, incluez les répertoires Maven requis :

allprojects {
    repositories {
        google()
        mavenCentral()
        maven { url "https://jitpack.io" }
    }
}

Si vous utilisez des répertoires Maven personnalisés ou privés, ajoutez des informations d'identification comme suit :

maven {
    url "https://maven.example.com/releases"
    credentials {
        username = project.findProperty("mavenUsername") ?: System.getenv("MAVEN_USERNAME")
        password = project.findProperty("mavenPassword") ?: System.getenv("MAVEN_PASSWORD")
    }
}

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

Résoudre les problèmes de compatibilité

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

configurations.all {
    resolutionStrategy {
        force "org.jetbrains.kotlin:kotlin-stdlib:1.8.20"
        force "androidx.core:core-ktx:1.10.1"
    }
}

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 :

dependencies {
    implementation('library:name:1.0.0') {
        exclude group: 'com.conflicting.dependency'
    }
}

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

org.gradle.caching=true
org.gradle.parallel=true
org.gradle.jvmargs=-Xmx2048m

Capgo Intégration

En utilisant Capgo aux côtés de la gestion de dépendances native et JavaScript, la mise à jour de votre plugin est plus rapide et plus facile.

À propos de Capgo

Capgo est une plateforme de mise à jour en direct conçue pour les plugins et les applications Capacitor. [1]Capgo permet aux développeurs de pousser des mises à jour pour les dépendances et les code instantanément - aucune revue de l'App Store n'est requise.

Capgo Update Features

Capgo Mises à jour de fonctionnalités : 

Source : [1]

Capgo fonctionne de manière fluide avec les outils CI/CD comme GitHub Actions, GitLab CI et Jenkins, automatisant les mises à jour de dépendances et garantissant des versions de plugins cohérentes. 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. Installez le Capgo CLI

   Exécutez la commande suivante dans votre terminal :

   npx @capgo/cli init

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

   Utilisez l'interface de dashboard de 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. Ajoutez la logique de mise à jour

   code

   import { Capgo } from '@capgo/capacitor-updater';
   
   // Initialize Capgo
   const capgo = new Capgo({
     appId: 'YOUR_APP_ID',
     channel: 'production'
   });
   
   // Check for updates
   await capgo.checkForUpdate();

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

Capgo fournit également un tableau de bord d'analytique pour des informations en temps réel sur les taux de réussite des mises à jour et l'activité des utilisateurs. Les fonctionnalités comme le retour en arrière en un clic et la traçabilité des erreurs aident à résoudre rapidement les problèmes, ce qui permet de maintenir les mises à jour de vos plugins en cours de manière fluide.

Conclusion

Révision du processus

Gérer les dépendances pour les plugins Capacitor implique d'aligner les composants natifs (iOS et Android) avec leurs équivalents JavaScript pour garantir une intégration fluide. Ce processus comprend des configurations spécifiques aux plateformes et la gestion de packages JavaScript pour atteindre la meilleure performance. Suivre les étapes décrites aidera à maintenir une fonctionnalité stable et efficace des plugins.

Meilleures pratiques

Gérer efficacement les dépendances implique de considérer ces pratiques :

En utilisant des outils d'actualisation en temps réel comme Capgo peut simplifier et améliorer ces pratiques en permettant des mises à jour en temps réel.

Capgo Benefits

Capgo simplifie le processus de gestion des dépendances tout en offrant une performance solide. Il atteint une impressionnante 95% de taux d'actualisation des utilisateurs dans les 24 heures et maintient un temps de réponse global API de 434ms [1]. Avec une encryption de bout en bout, il garantit des mises à jour sécurisées qui répondent aux deux lignes directrices d'Apple et d'Android. Pour les équipes gérant plusieurs versions de plugins, le système de canal de Capgo permet des déploiements ciblés pour des groupes d'utilisateurs spécifiques.

Ici, voici un aperçu rapide des performances de Capgo :

Continuez de là : Comment ajouter des dépendances dans les plugins Capacitor

Si vous utilisez Comment ajouter des dépendances dans les plugins Capacitor pour planifier le travail de plugin natif, connectez-l’avec Répertoire des plugins Capgo pour le flux de travail du produit dans le Répertoire des plugins Capgo Plugins Capacitor par Capgo pour les détails d'implémentation dans les Plugins Capacitor par Capgo Ajouter ou Mettre à Jour les Plugins pour les détails d'implémentation dans Ajouter ou Mettre à Jour les Plugins Alternatives d'extension Ionic Enterprise pour le flux de travail du produit dans les alternatives d'extension Ionic Enterprise, et Capgo Bâtiments natifs pour le flux de travail du produit dans Capgo Bâtiments natifs.