メインコンテンツへスキップ

Capacitor プラグインコントリビューションガイド

セットアップ、コーディング規約、テスト、ドキュメント作成まで、Capacitor プラグインへ効果的に貢献するための包括的なガイドです。

Capacitor プラグイン貢献ガイド Capgo ブログ イラスト

Capacitor プラグインはWeb技術とネイティブデバイス機能を接続し、 クロスプラットフォームアプリ開発を。このガイドでは、以下を支援します:

  • 環境のセットアップ以下のようなツールを活用することで、 Node.js, iOSプロファイリングや デバッグ は必須です。
  • Code の標準に従う: 使用する TypeScript, Swiftや Kotlin 一貫した命名規則とエラー処理を徹底します。
  • 徹底的にテストするJavaScript、iOS、Android に対してユニットテストを作成し、信頼性を確保します。
  • ドキュメントを明確にJSDoc と README ファイルを使用して、導入を容易にします。
  • プルリクエストを送信貢献前に、高品質な code、テスト、ドキュメントを確保してください。

オープンソース完全ガイド - 貢献する方法

開発環境のセットアップ

適切な開発環境を整えることは、効率的なプラグイン開発の鍵です。しっかり準備されたセットアップにより、プラグインのコーディング、テスト、デプロイがスムーズに行えます。

必要なツールとスキル

開始前に、以下のツールがインストールされていることを確認してください。

カテゴリ 要件
コアツール Node.js (LTS)、npm 6以上、Git
IDE/エディタ Visual Studio Code またはお好みのエディタ
iOS開発 Xcode、 SwiftLint, CocoaPods
Android開発 Android Studio、Android SDK、JDK

Web開発用のTypeScript、およびネイティブ開発用のSwift(iOS)またはJava/Kotlin(Android)に慣れていることも必要です [1][2].

モノレポのセットアップ

この Capacitor プラグイン エコシステムはモノレポ構造に基づいています。このアプローチにより、コミュニティの標準に準拠した作業を最初から行えます。

  1. リポジトリのフォークとクローン
    まず、GitHub 上の Capacitor プラグインリポジトリをフォークしてください。次に、フォークしたリポジトリをクローンします:

    git clone https://github.com/your-username/capacitor-plugins.git
    cd capacitor-plugins
    npm install
  2. 依存関係のインストールとビルド
    以下のコマンドを実行して、必要なものをすべてインストールし、プラグインをビルドします:

    npm run build
  3. バージョン管理の設定
    変更にはフィーチャーブランチを使用し、フォークをアップストリームリポジトリと同期させてください。

ネイティブプラットフォームの準備

クロスプラットフォーム開発には、iOSとAndroidの両方の環境設定が必要です。

iOSの場合:

  • Mac App StoreからXcodeをダウンロードしてください。

  • コマンドラインツールは次のコマンドでインストールします:

    xcode-select --install
  • CocoaPodsは次のコマンドでインストールします:

    sudo gem install cocoapods
  • Apple Developerアカウントと必要な証明書をセットアップしてください。

  • codeの品質を維持するために、SwiftLint(任意)を使用してください。

Androidの場合:

  • Android Studio、最新のSDK、仮想デバイスをインストールしてください。
  • JDKがインストールされていることを確認してください。
  • Android Studio内でAndroidのSDKを適切に設定してください。

これらのプラットフォームをセットアップすれば、確立されたコーディングプラクティスに従ってプラグイン開発に取り組む準備が整います。

Code 標準ガイド

開発環境が整ったら、メンテナンスしやすく使いやすいプラグインを構築するため、以下のガイドラインに従ってください。

スタイルガイドへの準拠

この Capacitor プラグインエコシステム 次のようなツールを使って厳格なコーディング規約を適用しています: ESLint, Prettier、および SwiftLint。必須フォーマットの概要は次のとおりです:

コンポーネント フォーマット
変数 deviceInfo (camelCase)
クラス BatteryManager (PascalCase)
メソッド getLanguageCode() (camelCase)
定数 MAX_RETRY_COUNT (SNAKE_CASE)

プラグインでは、型安全性と次のような ES6+ 機能のために TypeScript を使用してください: async/awaitさらに、Swift (iOS) と Kotlin (Android) のプラットフォーム固有のコーディング規約に従ってください。

エラーと型の管理

クロスプラットフォームでの互換性を保つには、一貫したエラーハンドリングが不可欠です。以下に例を示します。

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

型安全性を確保するために:

  • 特定のユースケースに特化したインターフェースを使用してください。
  • プラットフォーム固有の差異にはユニオン型を適用してください。

Code ドキュメント

優れたドキュメントは、プラグインを利用しやすく、使いやすくする鍵です。次のプラクティスに従ってください:

  1. API ドキュメント: 次と連携するJSDocコメントを書いてください @capacitor/docgen。例:
/**
 * @description Get the device's current battery level
 * @returns Promise with the battery level percentage
 */
async getBatteryLevel(): Promise<{ level: number }>;
  1. READMEの構成: インストール手順、設定方法、プラットフォームごとの要件、使用例、および詳細な API リファレンスなどの必須情報を含めてください。

質の高いドキュメントは、プラグインの導入を容易にし、より広範な Capacitor コミュニティへの貢献につながります。

sbb-itb-f9944d2

プラグインテストガイド

Capacitor プラグインのテストでは、スムーズな動作と信頼性を確保するために、いくつかの重要な領域に焦点を当てる必要があります。

Native Bridge のテスト

ネイティブブリッジのテストにより、JavaScript とネイティブ code 間の適切な通信を確認します。開始にあたり、各プラットフォームに合わせたフレームワークでテスト環境を設定してください。

以下は、 Jest による 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);
  });
});

ネイティブ側のテストには、iOS では XCTest、Android では JUnit を使用します。以下は Android の例です:

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

コアとなるブリッジ機能が期待通りに動作することを確認したら、完全なユーザーワークフローのテストに進んでください。

プラグインのテスト完了

プラグインがさまざまなシナリオで良好に動作することを確認するため、以下のカテゴリをテストしてください:

テストカテゴリ 重点領域
統合テスト クロスプラットフォーム機能
パフォーマンステスト リソース使用量とレスポンスタイム
セキュリティテスト データ処理と権限チェック

複雑な機能を持つプラグインの場合は、実際のユーザーシナリオをシミュレートしてください。例えば、DeviceInfoプラグインをテストする場合は、以下を確認します:

  • 異なるネットワーク条件下でのアップロード成功
  • 正確な進捗レポート
  • 大容量ファイル転送中のメモリ使用量

OTA テスト Capgo

Capgo Live Update ダッシュボードインターフェース

Capgo のオープンソースツールを使えば、アップデートのデプロイとテストを素早く行えます。使い方は以下の通りです:

  1. セットアップ アップデートチャネル dev、staging、production など。
  2. CI/CD ツールでデプロイを自動化。
  3. 更新を即座にプッシュ。
  4. パフォーマンスと問題を以下で監視 Capgo ダッシュボード.

段階的ロールアウトでは、Capgo を使用してユーザーの一定割合にのみ更新を配信できます。例えば、24時間ごとにユーザーの25%に新しいバージョンをリリースできます:

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

この段階的アプローチにより、完全リリース前にコミュニティのフィードバックを活用して問題を早期に発見できます。

プルリクエストのプロセス

変更を十分にテストした後、以下の手順に従ってプルリクエストを送信してください:

PR 送信時のチェックリスト

送信前に、これらの主要な項目を確認してください:

カテゴリ 確認事項
Code の品質 - Swift/Kotlin の実装が Web の API と整合していることを確認してください。
テスト - 新機能にはユニットテストを追加してください。
- CI/CD パイプラインのチェックが成功することを確認してください。
ドキュメント - 必要に応じてREADME、インラインドキュメント、CHANGELOGを更新してください。

コミュニティガイドライン

コラボレーションの際は、以下のベストプラクティスに従ってください:

  • レビュアーからのフィードバックには迅速に対応してください。
  • 議論は技術的な詳細に集中させてください。
  • code への変更を提案するには、GitHub の提案機能を使用してください。
  • 一度に一つの機能や問題に対処する、小さく焦点を絞ったプルリクエストを送信してください。

大規模な変更を行う場合は、まず issue を作成してアプローチを相談することをお勧めします。Capacitor チームは自動チェックに GitHub Actions を利用しており、プルリクエストのレビュー前にすべてのチェックにパスする必要があります。

Capgo 連携ガイド

プラグインにライブアップデートが関わる場合は、提出前に Capgo とシームレスに動作することを確認してください:

  1. バージョン管理
    プラグインには分かりやすいセマンティックバージョニングを使い、すべての変更を CHANGELOG に記録してください。Capgo のシステムは、ユーザーデバイス間でのバージョン普及状況の追跡に役立ちます。

  2. CI/CD 連携
    CI/CD パイプラインに Capgo を統合し、アップデートのデプロイを自動化します。

  3. アップデートのモニタリング
    デプロイの成功率を監視し、App Store のガイドラインへの準拠を確認します。

まとめ

プラグインで意味のある貢献をするには、確立されたプロセスに従い、コミュニティの基準を満たすことが重要です。これには、Capacitor のコーディングガイドラインを遵守し、作業を徹底的にテストすることが含まれます。

PR チェックリストは、高品質な提出の必要性を強調しています。プラグインがライブアップデートをサポートしている場合、Capgo と統合(前述の通り)することで、アプリストアの承認を待たずに迅速にアップデートをリリースできます。

PR がマージされたら、イシューの追跡やバージョン更新のリリースを通じて関わり続けましょう。コミュニティとの定期的な交流、一貫したメンテナンス、そして Capacitor の更新に追従すること により、プラグインが有用かつ関連性を保ち続けます。

ユーザーのフィードバックに注意を払い、必要に応じて更新を行いましょう。この継続的な取り組みは、エコシステムの全体的な品質を維持し、開発者にとってプラグインの価値を高めるのに役立ちます。

Capacitor プラグイン貢献ガイドの続きを読む

使用している場合 Capacitor プラグインコントリビューションガイド ネイティブプラグインの作業を計画するには、次と連携してください: Capgo プラグインディレクトリ Capgo プラグインディレクトリのプロダクトワークフローについては、 Capgo による Capacitor プラグイン Capgo による Capacitor プラグインの実装詳細については、 プラグインの追加または更新 プラグインの追加または更新に関する実装詳細については、 Ionic Enterprise プラグインの代替案 Ionic Enterprise Plugin Alternatives のプロダクトワークフロー、および Capgo Native Build Capgo Native Builds のプロダクトワークフローについては、

Capacitor アプリ向けの Live Updates

Web レイヤーのバグが本番で発生したら、App Store の審査を何日も待たずに Capgo で修正を配信しましょう。ネイティブの変更は通常の審査フローに残したまま、ユーザーはバックグラウンドでアップデートを受け取れます。

最新のブログ記事

Capgoは、真にプロフェッショナルなモバイルアプリを作るために必要な最高のインサイトを提供します。