Dart の依存関係を管理する

目次

• 基本的な概念
• バージョン制約
• ワークフロー: 依存関係の監査
• ワークフロー: 依存関係をアップグレードする
• ワークフロー: バージョン競合を解決する
• 例

基本的な概念

Dart は依存関係に対して厳密な単一バージョン規則を強制します: プロジェクトとそのすべての推移的依存関係は、与えられたパッケージの単一の共有バージョンに解決される必要があります。これはランタイムの型ミスマッチを防ぎますが、「バージョンロック」のリスクをもたらします。

バージョンロックを軽減するため、Dart は pubspec.yaml で固定されたバージョンではなくバージョン制約に依存しています。pubspec.lock ファイルは再現可能なビルドのために正確に解決されたバージョンを保持しています。

dart pub outdated の出力列を理解します:

• Current: 現在 pubspec.lock に記録されているバージョン。
• Upgradable: pubspec.yaml の制約で許可される最新バージョン。dart pub upgrade はこれに解決されます。
• Resolvable: プロジェクト内の他のすべての依存関係を考慮したときに解決できる絶対的な最新バージョン。
• Latest: パッケージの最新の公開バージョン (プレリリースを除く)。

バージョン制約

• キャレット構文を使う: pubspec.yaml の依存関係には常にキャレット構文 (例: ^1.2.3) を使います。これにより、pub は解決中に新しい非互換性のないバージョン (次のメジャーバージョンまで、ただしそれを含まない) を選択できます。
• 開発依存関係を厳しくする: dev_dependencies の下限を現在使用している正確なバージョンに設定します。これは解決の複雑さを減らし、古い互換性のない開発ツールが選択されるのを防ぎます。
• CI でロックファイルを強制する: CI/CD パイプラインで dart pub get --enforce-lockfile を使用して、ローカルでテストされた正確なバージョンが本番環境で使用されることを確認します。

ワークフロー: 依存関係の監査

このワークフローを定期的に実行して、安定性またはパフォーマンスに影響を与える可能性のある古いパッケージを特定します。

タスク進行状況:

• dart pub outdated を実行します。
• Upgradable 列を確認して、pubspec.yaml を変更せずに更新できるパッケージを特定します。
• Resolvable 列を確認して、pubspec.yaml の制約を変更して更新する必要があるパッケージを特定します。
• 撤回または廃止としてマークされたパッケージを特定します。

ワークフロー: 依存関係をアップグレードする

監査結果に基づいて条件付きロジックを使用して依存関係をアップグレードします。

タスク進行状況:

• 「Upgradable」バージョンに更新する場合:
  • dart pub upgrade を実行します。
  • dart pub upgrade --tighten を実行して、pubspec.yaml の下限を新しく解決されたバージョンと一致するように自動的に更新します。
• 「Resolvable」バージョンに更新する場合 (メジャー更新):
  • pubspec.yaml を手動で編集して、バージョン制約を「Resolvable」列と一致するようにバンプします (例: ^0.11.0 から ^0.12.1 に変更)。
  • dart pub upgrade を実行して新しい制約を解決し、pubspec.lock を更新します。
• フィードバックループ:
  • dart analyze を実行 -> エラーを確認 -> API の重大な変更を修正。
  • dart test を実行 -> 失敗を確認 -> リグレッションを修正。

ワークフロー: バージョン競合を解決する

pub がすべての制約を満たす具体的なバージョンのセットを見つけられない場合、または撤回されたパッケージバージョンを扱う場合は、ロックファイルを綿密に操作します。

決してしないでください: pubspec.lock ファイル全体を削除して dart pub get を実行してください。これは依存関係グラフ全体でコントロールされていないアップグレードを引き起こします。

タスク進行状況:

• pubspec.lock を開きます。
• 競合または撤回されたパッケージの特定の YAML ブロックを見つけます。
• ロックファイルからそのパッケージのエントリだけを削除します。
• dart pub get を実行して、そのパッケージの最新の互換性のある非撤回バージョンをフェッチします。
• フィードバックループ:
  • dart pub deps を実行 -> 依存関係グラフが正しく解決されることを確認。
  • 解決が失敗する場合は、ロックを引き起こしている推移的依存関係を特定し、pubspec.yaml でその制約を更新して再試行します。

例

制約を厳しくする

dart pub outdated がパッケージがより高いマイナー/パッチバージョンに解決可能であることを示している場合、--tighten フラグを使用して pubspec.yaml を自動的に更新します。

入力 (pubspec.yaml):

dependencies:
  http: ^0.13.0

コマンド:

dart pub upgrade --tighten http

出力 (pubspec.yaml):

dependencies:
  http: ^0.13.5

綿密なロックファイル削除

package_a が撤回されているか競合でロックされている場合は、pubspec.lock からそのブロックだけを削除します。

前 (pubspec.lock):

packages:
  package_a:
    dependency: "direct main"
    description:
      name: package_a
      url: "https://pub.dev"
    source: hosted
    version: "1.0.0" # 撤回されたバージョン
  package_b:
    dependency: "direct main"
    # ...

アクション: package_a ブロック全体を削除します。package_b はそのままにします。dart pub get を実行します。