Capacitor Guida alla Contribuzione del Plugin

Capacitor I plugin connettono tecnologie web con funzionalità di dispositivo nativo, consentendo lo sviluppo di applicazioni cross-platform. Questa guida ti aiuta:

• Configura il tuo ambiente: Strumenti come Node.js, Xcode, e Android Studio sono essenziali.
• Segui Code Standards: Utilizza TypeScript, Swift, e Kotlin con convenzioni di denominazione coerenti e gestione degli errori.
• Testa accuratamente: Scrivi test unitari per JavaScript, iOS e Android per garantire la affidabilità.
• Documenta chiaramente: Utilizza JSDoc e file README per una facile adozione.
• Invia una Richiesta di Modifica: Assicurati di avere una code di alta qualità, di testare e documentare prima di contribuire.

Guida Completa ai Progetti Open Source - Come Contribuire

Configurazione dell'ambiente di sviluppo

La configurazione dell'ambiente di sviluppo è fondamentale per lo sviluppo efficiente dei plugin. Un setup ben preparato consente una codifica, un testing e una distribuzione dei plugin fluidi.

Strumenti e Competenze che Avrai Bisogno

Prima di iniziare, assicurati di avere gli strumenti seguenti installati:

Dovresti anche essere confortevole con TypeScript per lo sviluppo web e, per compiti di sviluppo nativo, Swift (per iOS) o Java/Kotlin (per Android) [1][2].

Impostazione del Monorepo

Il Capacitor plugin l'ecosistema si basa su una struttura di repository monolitico. Questo approccio garantisce che il tuo lavoro si allinei con gli standard della community fin dall'inizio.

1. Fork e Clona il Repository
   Inizia forkando il repository dei Capacitor plugin su GitHub. Poi, clona il tuo repository forkito:

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

2. Installa Dipendenze e Costruisci
   Esegui il seguente comando per installare tutto ciò di cui hai bisogno e costruire i plugin:

   npm run build

3. Configura il Controllo delle Versioni
   Usa rami di feature per le tue modifiche e mantieni sincronizzato il tuo fork con il repository upstream.

Preparazione delle Piattaforme Native

Per lo sviluppo cross-platform, avrai bisogno di configurare sia l'ambiente iOS che Android.

Per iOS:

• Scarica Xcode dal Mac App Store.

• Installa gli strumenti di linea di comando utilizzando:

  xcode-select --install

• Installa CocoaPods con:

  sudo gem install cocoapods

• Crea un account di sviluppatore Apple e le certificazioni necessarie.

• Utilizza SwiftLint (facoltativo) per mantenere la qualità di code.

Per Android:

• Installa Android Studio insieme alla versione più recente di SDK e una dispositivo virtuale.
• Assicurati di avere installato un JDK.
• Configura correttamente l'SDK Android all'interno di Android Studio.

Una volta configurati questi piattaforme, sarai pronto a seguire le pratiche di codifica stabilite e a immergerti nello sviluppo di plugin.

Code Standards Guide

Ora che il tuo ambiente di sviluppo è configurato, segui queste linee guida per creare plugin facili da mantenere e utilizzare.

Compliance alla Guida dello Stile

Il Capacitor ecosistema dei plugin adotta rigorosi standard di codifica utilizzando strumenti come ESLint, Prettier, e SwiftLint. Ecco un breve riassunto delle formattazioni richieste:

I plugin dovrebbero utilizzare TypeScript per una maggiore sicurezza dei tipi e per le caratteristiche di ES6+ come async/await Inoltre, segui le convenzioni di codifica specifiche per Swift (iOS) e Kotlin (Android).

Gestione degli Errori e dei Tipi

La gestione degli errori coerente è cruciale per la compatibilità cross-platform. Ecco un esempio:

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

Per la sicurezza dei tipi:

• Utilizza interfacce focalizzate su casi d'uso specifici.
• Applica tipi di unione per le variazioni specifiche delle piattaforme.

Code Documentazione

Una buona documentazione è fondamentale per rendere il tuo plugin accessibile e facile da utilizzare. Segui queste pratiche:

1. API Documentazione: Scrivi commenti JSDoc che funzionano con @capacitor/docgen. Ad esempio:

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

2. Struttura del README: Includi informazioni essenziali come i passaggi di installazione, le istruzioni di configurazione, le richieste specifiche della piattaforma, gli esempi di utilizzo e una dettagliata API documentazione.

Una documentazione ben scritta assicura che il tuo plugin sia facile da adottare e contribuisce alla comunità Capacitor più ampia.

sbb-itb-f9944d2

Guida per la verifica dei plugin

La verifica dei plugin Capacitor consiste nell'essere concentrati su poche aree critiche per garantire una funzionalità liscia e una affidabilità.

Test delle Bridge Native

I test delle bridge native assicurano una comunicazione corretta tra JavaScript e code. Per iniziare, configura il tuo ambiente di testing con framework adattati a ogni piattaforma.

Ecco un esempio di un Jest test di unità per il lato 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);
  });
});

Per il testing sul lato nativo, utilizzare XCTest per iOS e JUnit per Android. Ecco un esempio per Android:

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

Una volta confermata la funzionalità della passerella di base funziona come previsto, procedere con il testing di flussi di lavoro completi.

Test dei Plugin Completi

Per assicurarsi che il tuo plugin funzioni bene in diversi scenari, testare varie categorie:

Per i plugin con funzionalità complesse, simulare scenari realistici di utilizzo da parte degli utenti. Ad esempio, se si sta testando un plugin DeviceInfo, verificare:

• Caricamenti riusciti in diverse condizioni di rete
• Rapporto di avanzamento preciso
• Utilizzo della memoria durante i trasferimenti di file di grandi dimensioni

Test di OTA con Capgo

Capgo’s strumenti open-source rendono facile l’implementazione e il test degli aggiornamenti velocemente. Ecco come utilizzarli:

1. Configurazione canali di aggiornamento come dev, staging e produzione.
2. Automate i deployment con gli strumenti CI/CD.
3. Aggiorna in modo istantaneo.
4. Monitora le prestazioni e gli issue tramite il Capgo dashboard.

Per i rilasci fasi, Capgo consente di limitare gli aggiornamenti a una piccola percentuale di utenti. Ad esempio, puoi rilasciare una nuova versione a 25% degli utenti ogni 24 ore:

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

Questa approccio fasi aiuta a identificare gli issue in anticipo sfruttando i feedback della community prima di un rilascio completo.

Processo di Richiesta di Modifica

Una volta che hai testato a fondo le tue modifiche, segui questi passaggi per inviare la tua richiesta di modifica:

Elenco di Controllo per la Sottomissione

Prima di sottoporre, assicurati di aver coperto queste aree chiave:

Linee Guida della Comunità

Quando collabori, segui queste linee guida:

• Rispondi rapidamente alle feedback dei revisori.
• Mantieni le discussioni focalizzate sui dettagli tecnici.
• Utilizza la funzione di proposta di GitHub per proporre code modifiche.
• Invia richieste di pull piccole e focalizzate che si occupino di un singolo feature o problema alla volta.

Per modifiche più grandi, è una buona idea creare un problema prima e discutere la tua approccio. Il team di Capacitor dipende dalle GitHub Actions per controlli automatizzati, e tutti i controlli devono passare prima che la tua richiesta di pull possa essere valutata.

Guida di integrazione di Capgo

Se il tuo plugin prevede aggiornamenti in tempo reale, assicurati che funzioni senza problemi con Capgo prima di inviarlo:

1. Controllo delle versioni
   Utilizza una versioning semantico chiaro per il tuo plugin, e documenta tutte le modifiche nel changelog. Il sistema di Capgo aiuta a tracciare l'adozione delle versioni su dispositivi degli utenti.

2. Integrazione CI/CD
   Integra Capgo nel tuo pipeline CI/CD per automatizzare gli aggiornamenti dei deployment.

3. Monitoraggio degli aggiornamenti
   Monitora i tassi di successo dei deployment e assicurati di rispettare le linee guida degli store di app.

Riepilogo

Per contribuire in modo significativo con il tuo plugin, è importante seguire il processo stabilito e rispettare gli standard della community. Ciò include l'osservanza delle linee guida di codifica di Capacitor e la verifica approfondita del tuo lavoro.

La checklist PR sottolinea la necessità di invii di alta qualità. Se il tuo plugin supporta aggiornamenti in tempo reale, l'integrazione con Capgo (come menzionato in precedenza) può aiutarti a rilasciare aggiornamenti velocemente senza dover attendere l'approvazione delle app store.

Dopo che il tuo PR è stato integrato, rimani coinvolto seguendo gli issue e rilasciando aggiornamenti di versione. L'interazione regolare con la community, la manutenzione costante e l'aggiornamento alle novità di Capacitor assicureranno che il tuo plugin rimanga utile e rilevante.

Prenditi cura delle recensioni degli utenti e aggiorna il tuo plugin in base alle esigenze. Questo sforzo continuo aiuta a mantenere la qualità generale dell'ecosistema e mantiene il tuo plugin utile per i developer.

Continua a seguire il Capacitor Plugin Contribution Guide

Se stai utilizzando il Capacitor Plugin Contribution Guide per pianificare il lavoro sui plugin nativi, connettilo con il Capgo Plugin Directory per il flusso di lavoro del prodotto nella cartella di plugin Capgo i plugin Capacitor di Capgo per i dettagli di implementazione in Capacitor Plugins by Capgo, Aggiunta o Aggiornamento dei Plugin per i dettagli di implementazione in Aggiunta o Aggiornamento dei Plugin, Alternative per Plugin Enterprise di Ionic per il flusso di lavoro del prodotto in Alternative per Plugin Enterprise di Ionic, e Capgo Costruzioni native per il flusso di lavoro del prodotto in Capgo Costruzioni native.