Capacitor プラグインはウェブ技術とネイティブデバイス機能を接続することで、 クロスプラットフォームアプリ開発。 このガイドはあなたに助けます:
- 環境をセットアップする: 以下のようなツールが必要です。 ノード・ジェイ・エス, Xcode, Android Studio ]
- Codeの標準に従ってください: TypeScriptを, Swiftを, Kotlinを 、一貫した命名規則とエラー処理とともに
- 徹底的にテストしてください:
- JavaScript、iOS、Android用のユニットテストを書いて、信頼性を確保してください明確にドキュメントしてください
- :: code の品質が高いことを確認し、テストとドキュメントを完了する前にコントリビュートしてください。
オープンソースの完全ガイド - コントリビュートする方法
開発環境の設定
開発環境の設定はプラグイン開発の効率的な鍵です。適切に準備された設定により、スムーズなコーディング、テスト、デプロイが可能になります。
必要なツールとスキル
開始する前に、以下のツールがインストールされていることを確認してください。
| カテゴリ | 要件 |
|---|---|
| 基本ツール | Node.js (LTS)、npm 6+、Git |
| IDE/エディター | Visual Studio Code またはあなたの好きなエディター |
| iOS開発 | Xcode、 SwiftLint, CocoaPods |
| Android開発 | Android Studio、Android SDK、JDK |
Web開発ではTypeScriptに慣れており、iOSではSwift、AndroidではJavaまたはKotlinに慣れていることが必要です [1][2].
モノレポの設定
モノレポ Capacitor プラグイン エコシステムは、モノレポ構造に依存しています。このアプローチにより、コミュニティの標準に沿った作業がすぐに始まります。
-
リポジトリをフォークしてクローンする
まず、Capacitor プラグインのリポジトリを GitHub でフォークしてください。次に、フォークしたリポジトリをクローンしてください:git clone https://github.com/your-username/capacitor-plugins.git cd capacitor-plugins npm install -
依存関係をインストールしてビルド
必要なすべてのものをインストールしてプラグインをビルドするには、以下のコマンドを実行してください。npm run build -
バージョン管理を設定する
変更のために機能ブランチを使用し、上流リポジトリとフォークを同期してください。
ネイティブプラットフォームの準備
クロスプラットフォーム開発の場合、iOSとAndroidの両方の環境を設定する必要があります。
iOSの場合:
-
Mac App StoreからXcodeをダウンロードしてください。
-
以下のコマンドを使用して、コマンドラインツールをインストールしてください:
xcode-select --install -
Capgo
sudo gem install cocoapods -
Capacitor
-
SwiftLint (任意) を使用して質の高い code を維持する。
Cloudflare
- Android Studioを最新のSDKと仮想デバイスとともにインストールしてください。
- code
- Configure the Android SDK properly within Android Studio.
SDK
Code Standards Guide
npm
bun
The Capacitor プラグインエコシステム __CAPGO_KEEP_0__ プラグインエコシステムは厳格なコーディング規約をツールとして使用して適用します。 ESLint, PrettierSwiftLint
| Component | コンポーネント |
|---|---|
| フォーマット | deviceInfo 変数 |
| クラス | BatteryManager メソッド |
| パスカルケース | getLanguageCode() (camelCase) |
| 定数 | MAX_RETRY_COUNT (SNAKE_CASE) |
プラグインは、Swift (iOS) と Kotlin (Android) のプラットフォーム固有のコーディング規約に従うことで、より安全な型と ES6+ の機能を利用することをお勧めします。 async/awaitエラーと型の管理
クロスプラットフォーム互換性のために、統一されたエラーハンドリングは非常に重要です。ここでは例を示します。
型の安全性のために:
async checkPermissions(): Promise<PermissionStatus> {
try {
const result = await this.implementation.checkPermissions();
return result;
} catch (error) {
throw new Error(`Permission check failed: ${error.message}`);
}
}特定の用途に合わせたフォーカスされたインターフェイスを使用します。
- プラットフォーム固有のバリエーションに対してユニオン型を適用します。
- __CAPGO_KEEP_0__ ドキュメント
Code ドキュメント
__CAPGO_KEEP_0__
- API ドキュメント: JavaScript ドキュメントコメントを書く
@capacitor/docgen: 例えば
/**
* @description Get the device's current battery level
* @returns Promise with the battery level percentage
*/
async getBatteryLevel(): Promise<{ level: number }>;- HTML テキスト フラグメント (親キー: jsdoc_documentation)。ページ/エリア: Capgo マーケティング ウェブサイト。役割: 長いマーケティングまたは法的段落。見つける場所: contributing.astro ページ。Capgo の製品/ブランド名と開発者用語を完全に保持する。プラグインの開発者は、インストール手順、設定方法、プラットフォームごとの要件、使用例、詳細なAPIリファレンスを含む必要があります。
: インストール手順、構成指示、プラットフォーム固有の要件、使用例、および詳細な Capacitor リファレンスを含める
sbb-itb-f9944d2
sbb-itb-f9944d2
Testing Capacitor plugins involves focusing on a few critical areas to ensure smooth functionality and reliability.
__CAPGO_KEEP_0__ プラグインのテストには、smooth な機能性と信頼性を確保するために、重要な幾つかの領域に焦点を当てる
Native bridge testing ensures proper communication between JavaScript and native code. To get started, set up your testing environment with frameworks tailored to each platform.
ネイティブ ブリッジ テストは、JavaScript とネイティブ __CAPGO_KEEP_0__ の間の適切な通信を確認する。始めるには、各プラットフォームに特化したフレームワークを使用したテスト環境を設定する 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)
}コアブリッジ機能が予想どおりに動作することを確認したら、ユーザーフローの完全なテストに進みます。
プラグインテストを完了する
さまざまなシナリオでプラグインがうまく動作することを確認するには、以下のカテゴリをテストしてください:
| テストカテゴリ | 主な焦点領域 |
|---|---|
| 統合テスト | クロスプラットフォーム機能 |
| パフォーマンステスト | リソース使用量とレスポンス時間 |
| セキュリティテスト | データハンドリングとパーミッションチェック |
複雑な機能を持つプラグインの場合、実世界のユーザーシナリオをシミュレートします。例えば、デバイス情報プラグインをテストしている場合、次のことを確認します:
- 異なるネットワーク条件下での成功したアップロード
- 正確な進捗報告
- 大規模ファイル転送時のメモリ使用量
OTAテスト Capgo
Capgoのオープンソースツールは、迅速なアップデートのデプロイとテストを容易にします。ここでは、それを使用する方法を紹介します:
- セットアップ アップデートチャンネル dev、staging、productionと同様のもの。
- CI/CDツールを使用してデプロイを自動化する。
- 即時更新を実行する。
- __CAPGO_KEEP_0__ ダッシュボードを通じてパフォーマンスと問題を監視する。 フェーズドロールアウトの場合、Capgo は、更新を小規模のユーザーに制限することを許可します。たとえば、毎日24時間ごとに、25%のユーザーに新しいバージョンをロールアウトできます。.
For phased rollouts, Capgo allows you to limit updates to a small percentage of users. For instance, you can roll out a new version to 25% of users every 24 hours:
// Example configuration for staged rollout
{
"plugin": "camera-plugin",
"version": "1.2.0",
"rollout": {
"percentage": 25,
"interval": "24h"
}
}Pull Request プロセス
変更を徹底的にテストした後、次の手順に従ってプルリクエストを提出します。
PR 提出チェックリスト
提出前に、次の重要な領域をカバーすることを確認します。
カテゴリ
| カテゴリ | チェックすること |
|---|---|
| Codeの品質 | - Swift/Kotlin実装がウェブAPIと一致することを確認する。 |
| テスト | - 新機能に対するユニットテストを追加する。 - CI/CDパイプラインのチェックが正常に完了することを確認する。 |
| ドキュメント | - README、インラインドキュメント、CHANGELOGを必要に応じて更新する。 |
コミュニティガイドライン
協力する際には、これらのベストプラクティスに従う。
- 迅速にレビューフィードバックに応じる。
- 技術的な詳細に焦点を当てる。
- GitHubの提案機能を使用して、codeの変更を提案してください。
- 1 つの機能または問題ごとに、小さく集中したプルリクエストを提出してください。
大きな変更の場合、まず問題を作成し、取り組み方を議論してください。Capacitorチームは、GitHubアクションを使用して自動チェックを実行し、すべてのチェックが通過するまでプルリクエストをレビューできません。
Capgo統合ガイド
ライブアップデートを含むプラグインの場合、Capgoと互換性のあるように動作することを確認してください。
-
バージョン管理
Capacitor プラグインのバージョニングは明確で、すべての変更は changelog に記載する。Capgoのシステムは、ユーザー デバイス間でバージョンの採用を追跡する。 -
プラグインのバージョニングを明確にし、すべての変更を changelog に記載してください。__CAPGO_KEEP_0__のシステムは、ユーザー デバイス間でバージョン採用を追跡します。
CI/CDパイプラインにCapgoを統合して、自動更新のデプロイを実行します。 -
ページ/エリア: Capgo Builder / ネイティブ クラウド ビルド プロダクト ページ。役割: ショート UI ラベルまたはナビゲーション アイテム。メッセージ キー `native_build_feature_ci_cd` (ネイティブ ビルド フィーチャー CI/CD)。
__CAPGO_KEEP_0__をCI/CDパイプラインに統合して、自動アップデートのデプロイを実行してください。
アップデート監視
Capacitor プラグインの意義ある貢献を実現するには、既存のプロセスに従い、コミュニティの基準を満たすことが重要です。これには、Capacitor のコーディングガイドラインに従い、徹底的なテストを行うことが含まれます。
PR チェックリストでは、高品質な提出物の必要性を強調しています。ライブアップデートをサポートするプラグインの場合、Capgo (前述) と統合することで、迅速なアップデートのリリースが可能になり、アプリストアの承認を待つ必要がなくなります。
PR がマージされた後、問題を追跡し、バージョンアップデートをリリースすることで、コミュニティとの継続的な関与、安定したメンテナンス、__CAPGO_KEEP_0__ のアップデートに合わせた対応 keeping up with Capacitor updates プラグインは常に最新の状態になり、有用で関連性のあるものになります。
Capacitor プラグインの貢献ガイドから続けてください。
Keep going from Capacitor Plugin Contribution Guide
__CAPGO_KEEP_0__ Capacitor __CAPGO_KEEP_0__ Capgo Capgo Capacitor プラグインは Capgo によって提供されます。 Capacitorプラグインの実装詳細については、CapacitorプラグインによってCapgoで管理されます。 プラグインの追加または更新 プラグインの追加または更新の実装詳細について イオニック エンタープライズ プラグインの代替 イオニック エンタープライズ プラグインの代替の製品ワークフロー Capgo ネイティブ ビルド Capgo ネイティブ ビルドの製品ワークフロー
