Capacitor Guide de contribution des plugins

Capacitor Les plugins connectent les technologies web aux fonctionnalités de dispositifs natifs, permettant ainsi la mise en œuvre développement d'applications multiplateformes Cette guide vous aide :

• Configurer votre environnement Outils comme Node.js, Xcode, et Android Studio sont essentiels.
• Suivre les normes Code Utilisez TypeScript, Swift, et Kotlin avec des conventions de nommage cohérentes et une gestion des erreurs.
• Testez Thoroughement: Écrivez des tests unitaires pour JavaScript, iOS et Android pour garantir la fiabilité.
• Documentez Clairement: Utilisez JSDoc et des fichiers README pour une adoption facile.
• Soumettre une Demande de Tirage: Assurez-vous d'une qualité élevée de code, des tests et de la documentation avant de contribuer.

Guide Complet sur les Logiciels Libres - Comment Contribuer

Configuration de l'environnement de développement

La mise en place d'un environnement de développement approprié est essentielle pour une création efficace de plugins. Un setup bien préparé permet un codage, une testification et une mise en production fluides de vos plugins.

Outils et compétences dont vous aurez besoin

Avant de commencer, assurez-vous d'avoir les outils suivants installés :

Vous devriez également être à l'aise avec TypeScript pour le développement web et soit Swift (pour iOS) ou Java/Kotlin (pour Android) pour les tâches de développement natif [1][2].

Configurer le Monorepo

Le Capacitor plugins L'écosystème repose sur une structure de monorepo. Cette approche garantit que votre travail est conforme aux normes de la communauté dès le début.

1. Forker et Cloner le Répertoire
   Commencez par forkant le Capacitor plugins sur GitHub. Ensuite, clonez votre forké :

   git clone https://github.com/your-username/capacitor-plugins.git
   cd capacitor-plugins
   npm install

2. Installer les Dépendances et Construire
   Exécutez la commande suivante pour installer tout ce dont vous avez besoin et construire les plugins :

   npm run build

3. Configurer le Contrôle de Version
   Utilisez des branches de fonctionnalités pour vos modifications et maintenez votre fork synchronisé avec le dépôt upstream.

Préparation des Plates-formes Natives

Pour le développement cross-plateforme, vous aurez besoin de configurer les environnements iOS et Android.

Pour iOS :

• Téléchargez Xcode depuis l'App Store Mac.

• Installez les outils de ligne de commande en utilisant :

  xcode-select --install

• Installez CocoaPods avec :

  sudo gem install cocoapods

• Configurez un compte développeur Apple et les certificats nécessaires.

• Utilisez SwiftLint (facultatif) pour maintenir la qualité de code.

Pour Android :

• Installez Android Studio ainsi que la dernière SDK et un appareil virtuel.
• Assurez-vous d'avoir un JDK installé.
• Configurez correctement la SDK Android dans Android Studio.

Une fois ces plateformes configurées, vous serez prêt à suivre les pratiques de codage établies et à plonger dans le développement de plugins.

Guide des normes de Code

Une fois votre environnement de développement configuré, suivez ces lignes directrices pour créer des plugins faciles à maintenir et à utiliser.

Conformité au Guide de style

Le écosystème de plugins Capacitor applique des normes de codage strictes à l'aide d'outils comme ESLint, Prettier, et SwiftLint. Voici un aperçu rapide des formats requis :

Les plugins devraient utiliser TypeScript pour une meilleure sécurité des types et des fonctionnalités ES6+ telles que async/awaitEn outre, suivez les conventions de codage spécifiques à la plateforme pour Swift (iOS) et Kotlin (Android).

Gestion des erreurs et des types

Une gestion cohérente des erreurs est cruciale pour la compatibilité cross-plateforme. Voici un exemple :

async checkPermissions(): Promise<PermissionStatus> {
  try {
    const result = await this.implementation.checkPermissions();
    return result;
  } catch (error) {
    throw new Error(`Permission check failed: ${error.message}`);
  }
}

Pour la sécurité des types :

• Utilisez des interfaces ciblées conçues pour des cas d'utilisation spécifiques.
• Appliquez des types de union pour les variations spécifiques à la plateforme.

Code Documentation

Une bonne documentation est essentielle pour rendre votre plugin accessible et facile à utiliser. Suivez ces pratiques :

1. API Documentation : Écrivez des commentaires JSDoc qui fonctionnent avec @capacitor/docgenPar exemple :

/**
 * @description Get the device's current battery level
 * @returns Promise with the battery level percentage
 */
async getBatteryLevel(): Promise<{ level: number }>;

2. Structure du README: Incluez les informations essentielles comme les étapes d'installation, les instructions de configuration, les exigences spécifiques au plateforme, des exemples d'utilisation et une référence détaillée API.

Une documentation bien écrite assure que votre plugin est facile à adopter et contribue à la communauté Capacitor plus large.

sbb-itb-f9944d2

Guide de test de plugin

Le test de Capacitor des plugins implique de se concentrer sur quelques domaines critiques pour s'assurer d'une fonctionnalité et d'une fiabilité lisses.

Tests de pont natif

Le test de pont natif s'assure d'une communication appropriée entre JavaScript et code natif. Pour commencer, configurez votre environnement de test avec des frameworks conçus pour chaque plateforme.

Voici un exemple de Jest test unitaire pour le côté JavaScript :

// Example of a Jest unit test for the JavaScript bridge
describe('DeviceInfo Plugin', () => {
  test('getBatteryLevel returns valid percentage', async () => {
    const result = await DeviceInfo.getBatteryLevel();
    expect(result.level).toBeGreaterThanOrEqual(0);
    expect(result.level).toBeLessThanOrEqual(100);
  });
});

Pour tester du côté natif, utilisez XCTest pour iOS et JUnit pour Android. Voici un exemple pour Android :

@Test
fun testBatteryLevel() {
    val plugin = DeviceInfo()
    val result = plugin.getBatteryLevel()
    assertTrue(result.level in 0..100)
}

Une fois que vous avez confirmé que la fonctionnalité de pont de base fonctionne comme prévu, passez à la mise en œuvre de tests complets de flux d'utilisateur.

Tests de Plugin Complet

Pour vous assurer que votre plugin fonctionne bien dans différents scénarios, testez différentes catégories :

Pour les plugins avec des fonctionnalités complexes, simulez des scénarios d'utilisateur réels. Par exemple, si vous testez un plugin DeviceInfo, vérifiez :

• Téléchargements réussis dans différentes conditions de réseau
• Rapports de progression précis
• Utilisation de la mémoire pendant les transferts de fichiers importants

Test de mise à jour OTA avec Capgo

Capgo fournit des outils open-source pour faciliter la mise en ligne et le test des mises à jour rapidement. Voici comment l'utiliser :

1. Configurer canaux de mise à jour comme dev, étape de production et de production.
2. Automatiser les déploiements avec des outils CI/CD.
3. Envoyer des mises à jour instantanément.
4. Surveillez les performances et les problèmes via le Capgo tableau de bord.

Pour des déploiements étalés, Capgo vous permet de limiter les mises à jour à une petite fraction d'utilisateurs. Par exemple, vous pouvez déployer une nouvelle version à 25 % d'utilisateurs tous les 24 heures :

// Example configuration for staged rollout
{
  "plugin": "camera-plugin",
  "version": "1.2.0",
  "rollout": {
    "percentage": 25,
    "interval": "24h"
  }
}

Cette approche étalée aide à identifier les problèmes en amont en exploitant les retours de la communauté avant une mise en production complète.

Processus de demande de modification

Une fois que vous avez soigneusement testé vos modifications, suivez ces étapes pour soumettre votre demande de modification :

Liste de vérification de soumission de PR

Avant de soumettre, assurez-vous d'avoir couvert ces domaines clés :

Lignes directrices de la communauté

Lors de la collaboration, suivez ces meilleures pratiques :

• Répondez rapidement aux commentaires des réviseurs.
• Gardez les discussions centrées sur les détails techniques.
• Utilisez la fonctionnalité de proposition de GitHub pour proposer code modifications.
• Soumettez des demandes de modification petites et centrées sur une fonctionnalité ou un problème à la fois.

Pour des modifications plus importantes, il est une bonne idée de créer un problème avant et discuter de votre approche. L'équipe de Capacitor se fonde sur les Actions de GitHub pour les contrôles automatisés, et tous les contrôles doivent passer avant que votre demande de modification puisse être examinée.

Capgo Guide d'intégration

Si votre plugin implique des mises à jour en temps réel, assurez-vous qu'il fonctionne de manière fluide avec Capgo avant de le soumettre :

1. Contrôle de version
   Utilisez une versionnement semantique claire pour votre plugin, et documentez toutes les modifications dans le changelog. Le système de Capgo aide à suivre l'adoption de la version sur les appareils des utilisateurs.

2. Intégration CI/CD
   Intégrez Capgo dans votre pipeline CI/CD pour automatiser les déploiements de mise à jour.

3. Suivi des mises à jour
   Surveillez les taux de réussite des déploiements et assurez-vous de respecter les lignes directrices des magasins d'applications.

Résumé

Pour faire une contribution significative avec votre plugin, il est important de suivre le processus établi et de respecter les normes de la communauté. Cela inclut la conformité aux lignes directrices de codage de Capacitor et le test rigoureux de votre travail.

Le checklist PR met en évidence la nécessité de soumissions de haute qualité. Si votre plugin prend en charge les mises à jour en temps réel, l'intégration avec Capgo (comme mentionné précédemment) peut vous aider à libérer des mises à jour rapidement sans attendre les approbations des magasins d'applications.

Une fois votre PR fusionné, restez impliqué en suivant les problèmes et en libérant des mises à jour de version. Une interaction régulière avec la communauté, une maintenance constante et suivre les mises à jour Capacitor assurera que votre plugin reste utile et pertinent.

Prenez en compte les commentaires des utilisateurs et mettez à jour votre plugin en fonction de leurs besoins. Cette démarche continue contribue à maintenir la qualité globale de l'écosystème et rend votre plugin précieux pour les développeurs.