Guia de Contribuição de Plugins do Capacitor

Capacitor plugins conectan tecnologías web con funciones nativas del dispositivo, permitiendo el desarrollo de aplicaciones multiplataforma. Esta guía te ayuda a:

• Configura tu entorno: Herramientas como Node.js, Xcode, y Android Studio son esenciales.
• Sigue estándares de código: Utiliza TypeScript, Swift, y Kotlin con convenciones de nombres consistentes y manejo de errores.
• Prueba a fondo: Escribe pruebas unitarias para JavaScript, iOS y Android para asegurar fiabilidad.
• Documenta claramente: Usa JSDoc y archivos README para una fácil adopción.
• Envía una Solicitud de Extracción: Asegúrate de que el código, las pruebas y la documentación sean de alta calidad antes de contribuir.

Guía Completa de Código Abierto - Cómo Contribuir

Configuración del Entorno de Desarrollo

Crear un entorno de desarrollo adecuado es clave para el desarrollo eficiente de plugins. Una configuración bien preparada permite una codificación, prueba y despliegue de tus plugins sin problemas.

Herramientas y habilidades que necesitarás

Antes de comenzar, asegúrate de tener las siguientes herramientas instaladas:

También deberías estar cómodo usando TypeScript para el desarrollo web y ya sea Swift (para iOS) o Java/Kotlin (para Android) para tareas de desarrollo nativo [1][2].

Configuración del Monorepo

El ecosistema de plugins de Capacitor se basa en una estructura de monorepo. Este enfoque asegura que tu trabajo se alinee con los estándares de la comunidad desde el principio.

1. Haz un fork y clona el repositorio
   Comienza haciendo un fork del repositorio de plugins de Capacitor en GitHub. Luego, clona tu repositorio forked:

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

2. Instala dependencias y construye
   Ejecuta el siguiente comando para instalar todo lo que necesitas y construir los plugins:

   npm run build

3. Configura el control de versiones
   Usa ramas de características para tus cambios y mantiene tu fork sincronizado con el repositorio original.

Preparando Plataformas Nativas

Para el desarrollo multiplataforma, necesitarás configurar los entornos de iOS y Android.

Para iOS:

• Descarga Xcode desde la Mac App Store.

• Instala herramientas de línea de comandos usando:

  xcode-select --install

• Instala CocoaPods con:

  sudo gem install cocoapods

• Configura una cuenta de desarrollador de Apple y certificados necesarios.

• Usa SwiftLint (opcional) para mantener la calidad del código.

Para Android:

• Instala Android Studio junto con el SDK más reciente y un dispositivo virtual.
• Asegúrate de tener un JDK instalado.
• Configura correctamente el SDK de Android dentro de Android Studio.

Una vez que estas plataformas estén configuradas, estarás listo para seguir prácticas de codificación establecidas y sumergirte en el desarrollo de plugins.

Guía de Estándares de Código

Ahora que tu entorno de desarrollo está configurado, sigue estas pautas para construir plugins que sean fáciles de mantener y usar.

Cumplimiento de la Guía de Estilo

El ecosistema de plugins de Capacitor hace cumplir estrictos estándares de codificación usando herramientas como ESLint, Prettier, y SwiftLint. Aquí tienes un resumen rápido del formato requerido:

Los plugins deben utilizar TypeScript para una mejor seguridad de tipos y características ES6+ como async/await. Además, sigue las convenciones de codificación específicas de la plataforma para Swift (iOS) y Kotlin (Android).

Manejo de Errores y Tipos

El manejo de errores consistente es crucial para la compatibilidad multiplataforma. Aquí tienes un ejemplo:

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

Para la seguridad de tipos:

• Usa interfaces focalizadas adaptadas a casos de uso específicos.
• Aplica tipos de unión para variaciones específicas de la plataforma.
• Implementa guardianes de tipos para validar tipos en tiempo de ejecución [1].

Documentación del Código

Una buena documentación es clave para hacer que tu plugin sea accesible y fácil de usar. Sigue estas prácticas:

1. Documentación de API: Escribe comentarios JSDoc que funcionen con @capacitor/docgen. Por ejemplo:

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

2. Estructura del README: Incluye información esencial como pasos de instalación, instrucciones de configuración, requisitos específicos de la plataforma, ejemplos de uso y una referencia API detallada.

Una documentación bien escrita asegura que tu plugin sea fácil de adoptar y contribuye a la comunidad más amplia de Capacitor.

sbb-itb-f9944d2

Guía de Pruebas de Plugins

Probar plugins de Capacitor implica enfocarse en algunas áreas críticas para garantizar un funcionamiento fluido y fiable.

Pruebas del Puente Nativo

Las pruebas del puente nativo aseguran una comunicación adecuada entre JavaScript y el código nativo. Para comenzar, configura tu entorno de pruebas con frameworks adaptados a cada plataforma.

Aquí tienes un ejemplo de una prueba unitaria de Jest para el lado de 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);
  });
});

Para probar en el lado nativo, utiliza XCTest para iOS y JUnit para Android. A continuación hay un ejemplo para Android:

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

Una vez que hayas confirmado que la funcionalidad del puente central funciona como se esperaba, pasa a probar flujos de usuario completos.

Pruebas Completas del Plugin

Para asegurarte de que tu plugin funcione bien en diferentes escenarios, prueba varias categorías:

Para plugins con características complejas, simula escenarios de usuario en el mundo real. Por ejemplo, si estás probando un plugin de DeviceInfo, verifica:

• Subidas exitosas bajo diferentes condiciones de red
• Informes de progreso precisos
• Uso de memoria durante transferencias de archivos grandes

Pruebas OTA con Capgo

Las herramientas de código abierto de Capgo facilitan el despliegue y prueba de actualizaciones rápidamente. Aquí se explica cómo usarlo:

1. Configura canales de actualización como desarrollo, staging y producción.
2. Automatiza despliegues con herramientas de CI/CD.
3. Empuja actualizaciones al instante.
4. Monitorea el rendimiento y los problemas a través del tablero de Capgo.

Para implementaciones por fases, Capgo te permite limitar las actualizaciones a un pequeño porcentaje de usuarios. Por ejemplo, puedes lanzar una nueva versión al 25% de los usuarios cada 24 horas:

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

Este enfoque gradual ayuda a identificar problemas temprano aprovechando los comentarios de la comunidad antes de un lanzamiento total.

Proceso de Solicitud de Extracción

Una vez que hayas probado exhaustivamente tus cambios, sigue estos pasos para enviar tu solicitud de extracción:

Lista de Verificación de Envío de PR

Antes de enviar, asegúrate de que has cubierto estas áreas clave:

Directrices de la Comunidad

Al colaborar, adhiérete a estas mejores prácticas:

• Responde rápidamente a los comentarios de los revisores.
• Mantén las discusiones centradas en detalles técnicos.
• Usa la función de sugerencia de GitHub para proponer cambios de código.
• Envía solicitudes de extracción pequeñas y enfocadas que aborden una característica o problema a la vez.

Para cambios más grandes, es una buena idea crear un problema primero y discutir tu enfoque. El equipo de Capacitor confía en las Acciones de GitHub para verificaciones automáticas, y todas las verificaciones deben pasar antes de que tu solicitud de extracción pueda ser revisada.

Guía de Integración con Capgo

Si tu plugin implica actualizaciones en vivo, asegúrate de que funcione sin problemas con Capgo antes de enviarlo:

1. Control de Versiones
   Usa un versionado semántico claro para tu plugin y documenta todos los cambios en el changelog. El sistema de Capgo ayuda a rastrear la adopción de versiones entre los dispositivos de los usuarios.

2. Integración de CI/CD
   Integra Capgo en tu pipeline de CI/CD para automatizar despliegues de actualizaciones.

3. Monitoreo de Actualizaciones
   Monitorea las tasas de éxito de despliegue y asegúrate de cumplir con las pautas de la tienda de aplicaciones.

Resumen

Para hacer una contribución significativa con tu plugin, es importante seguir el proceso establecido y cumplir con los estándares de la comunidad. Esto incluye seguir las pautas de codificación de Capacitor y probar exhaustivamente tu trabajo.

La lista de verificación de PR destaca la necesidad de envíos de alta calidad. Si tu plugin admite actualizaciones en vivo, integrarse con Capgo (como se mencionó anteriormente) puede ayudarte a lanzar actualizaciones rápidamente sin esperar la aprobación de la tienda de aplicaciones.

Una vez que tu PR esté fusionada, mantente involucrado siguiendo los problemas y lanzando actualizaciones de versiones. La interacción regular con la comunidad, el mantenimiento constante y mantenerse al día con las actualizaciones de Capacitor asegurará que tu plugin siga siendo útil y relevante.

Preste atenção ao feedback dos usuários e faça atualizações conforme necessário. Esse esforço contínuo ajuda a manter a qualidade geral do ecossistema e mantém seu plugin valioso para os desenvolvedores.