flutter-package-development

Flutter パッケージの開発

再利用可能なパッケージは、独立したプロジェクトが利用するバージョン管理された契約として扱ってください。移行が求められていない限り、SDK のバージョン範囲、パッケージのアーキテクチャ、サポート対象プラットフォーム、リリースの慣例を維持してください。

事前確認

pubspec.yaml、公開エクスポート、サンプル、テスト、プラットフォームフォルダー、CI、変更履歴、利用側のプロジェクトを確認してください。 実現可能な最小の構成を選んでください。

• 再利用可能な Dart のみのロジックには、Dart パッケージを使用します。
• ネイティブコードを含まない再利用可能なウィジェットには、Flutter パッケージを使用します。
• ネイティブのプラットフォーム実装が必要な場合は、プラグインまたは FFI パッケージを使用します。
• 複数のパッケージを正当化できる独立したプラットフォーム所有権またはリリースサイクルがある場合に限り、フェデレーテッドプラグインを使用します。

コードを再利用できるという理由だけで、アプリ所有のブリッジをパッケージに変換しないでください。

参照資料の条件付き読み込み

• エクスポート、非推奨化、セマンティックバージョニング、利用側との互換性については、公開 API とパッケージ品質を読んでください。
• プラットフォームインターフェース、登録、FFI、フェデレーテッドアーキテクチャについては、プラグインとフェデレーションを読んでください。
• ドライランでの確認、pub.dev のチェックリスト、リリース検証については、公開準備を読んでください。

境界

• flutter-platform-integration は、アプリ側のネイティブコードと低レベルのチャネル／FFI の仕組みを担当します。
• flutter-dependency-upgrades は、アプリにおける利用側のパッケージアップグレードを担当します。
• flutter-build-release は、アプリのストア対応とバイナリビルドを担当します。pub パッケージの公開は担当しません。

検証

フォーマット、解析、テストを実行し、サポートを表明しているすべてのプラットフォームでサンプル用フィクスチャを動作させてください。 公開準備が対象に含まれる場合：

• dart pub publish --dry-run を実行し、すべての出力、警告、含まれるファイルを確認してください。ドライランに合格しても、互換性や公開権限が証明されるわけではありません。
• ユーザーから明示的な許可を得ずに、公開、タグ付け、リリース作成を行わないでください。「ドライランに合格したら公開してよい」という条件付きの許可は、ドライラン後に行った変更には適用されません。公開前に最終差分とドライランの結果を提示し、確認を求めてください。
• ツールまたはリポジトリにアクセスできない場合は、結果を捏造するのではなく、メタデータ、ライセンス、変更履歴、ドライランの出力を対象とする、明確な合否基準付きの実行可能なレビュー計画を提示してください。

出典

• パッケージとプラグインの開発
• パッケージの公開
• パッケージレイアウトの規約