Flutter插件合并pubspec.lock文件功能插件pubspec_lock_merge_driver的使用

Flutter插件合并pubspec.lock文件功能插件pubspec_lock_merge_driver的使用

插件简介

pubspec_lock_merge_driver 是一个用于 Git 的自定义合并驱动程序，专门用于处理 pubspec.lock 文件的自动合并。它可以帮助开发者在多人协作时避免因 pubspec.lock 文件冲突而导致的手动修复。

安装

首先，通过以下命令安装并激活插件：

dart pub global activate pubspec_lock_merge_driver

然后运行安装脚本以配置 Git 使用该合并驱动：

# 全局安装（适用于所有项目的 pubspec.lock 文件）
pubspec_lock_merge_driver install

# 本地安装（仅适用于当前项目的 pubspec.lock 文件）
pubspec_lock_merge_driver install --local

安装完成后，当 Git 检测到 pubspec.lock 文件中的冲突时，会根据以下合并策略自动解决冲突。

合并策略

假设有两个 pubspec.lock 文件 A 和 B，合并规则如下：

1. 新增包：

   • 如果某个包只存在于 A 或 B 中，则该包会被包含在合并后的 pubspec.lock 文件中。

2. 共存包：

   • 对于同时存在于 A 和 B 中的包：
     • 如果两者描述类型相同（例如都为路径依赖、Git 依赖或托管依赖）。
     • 如果两者的描述值完全一致。
     • 则选择版本较新的包；否则，合并失败。

示例

假设我们有两个分支 main 和 feature，它们的 pubspec.lock 文件分别如下：

main/pubspec.lock

{
  "packages": [
    {
      "name": "package_a",
      "version": "1.0.0",
      "description": {
        "type": "hosted",
        "url": "https://pub.dev",
        "version": "1.0.0"
      }
    },
    {
      "name": "package_b",
      "version": "2.0.0",
      "description": {
        "type": "hosted",
        "url": "https://pub.dev",
        "version": "2.0.0"
      }
    }
  ]
}

feature/pubspec.lock

{
  "packages": [
    {
      "name": "package_a",
      "version": "1.1.0",
      "description": {
        "type": "hosted",
        "url": "https://pub.dev",
        "version": "1.1.0"
      }
    },
    {
      "name": "package_c",
      "version": "1.0.0",
      "description": {
        "type": "hosted",
        "url": "https://pub.dev",
        "version": "1.0.0"
      }
    }
  ]
}

执行合并后，结果如下：

{
  "packages": [
    {
      "name": "package_a",
      "version": "1.1.0", // 选择版本较新的包
      "description": {
        "type": "hosted",
        "url": "https://pub.dev",
        "version": "1.1.0"
      }
    },
    {
      "name": "package_b",
      "version": "2.0.0",
      "description": {
        "type": "hosted",
        "url": "https://pub.dev",
        "version": "2.0.0"
      }
    },
    {
      "name": "package_c",
      "version": "1.0.0",
      "description": {
        "type": "hosted",
        "url": "https://pub.dev",
        "version": "1.0.0"
      }
    }
  ]
}

已知限制

1. SDK 版本不一致：

   • 如果 A 和 B 的 SDK 版本不同，则无法自动合并，需要手动解决。

2. 描述类型不同：

   • 如果依赖的描述类型不同（如路径依赖与托管依赖），则合并失败。

3. 描述值不同但类型相同：

   • 如果描述类型相同但描述值不同，则无法自动合并，需要手动解决。

使用较低版本的 Dart

如果项目需要使用低于 2.17.5 的 Dart 版本，可以通过编译可执行文件来绕过此限制：

# 克隆仓库到合适的位置
cd <some/good/location>
git clone git@github.com:matthewnitschke/pubspec_lock_merge_driver.git

# 切换到最新版本的 Dart
asdf install dart 2.17.5
asdf shell dart 2.17.5

# 编译 Dart 脚本
dart compile pubspec_lock_merge_driver/bin/main.dart

# 使用编译后的可执行文件安装合并驱动
pubspec_lock_merge_driver install --driverCommand "<some/good/location>/pubspec_lock_merge_driver/bin/main.exe"

现在，合并驱动可以在任何 Dart 版本下工作，并且运行的是编译后的可执行文件。

卸载

要卸载合并驱动，可以使用以下命令：

pubspec_lock_merge_driver uninstall

# 或者仅卸载本地安装
pubspec_lock_merge_driver uninstall --local