如何优化Dart及多语言包本地开发的依赖管理流程？

Dart 专属方案 #

方案1：依赖覆盖 + 本地配置文件（推荐） #

Dart 的 pub 工具支持 dependency_overrides 字段，你可以通过本地未提交的配置文件实现依赖替换，无需修改主 pubspec.yaml：

1. 创建本地覆盖文件：在每个包的根目录新建 pubspec.local.yaml，仅写入需要替换为本地路径的依赖，添加该文件到各包的 .gitignore。
   • ios_transmogrify/pubspec.local.yaml 示例：

     dependency_overrides:
       core_transmogrify:
         path: ../core_transmogrify
     

   • core_transmogrify/pubspec.local.yaml 示例：

     dependency_overrides:
       core_tools:
         path: ../core_tools
     

2. 编写合并脚本：在工作区根目录创建 merge_pubspec.dart，自动合并主配置与本地覆盖配置，生成临时开发配置并执行 pub get：

   import 'dart:io';
   import 'package:yaml/yaml.dart';
   
   void main() {
     final pubspec = File('pubspec.yaml');
     final localPubspec = File('pubspec.local.yaml');
     final devPubspec = File('pubspec.dev.yaml');
   
     if (!localPubspec.existsSync()) {
       pubspec.copySync(devPubspec.path);
       Process.runSync('dart', ['pub', 'get', '--file', 'pubspec.dev.yaml']);
       return;
     }
   
     final baseConfig = loadYaml(pubspec.readAsStringSync()) as Map;
     final localConfig = loadYaml(localPubspec.readAsStringSync()) as Map;
   
     final mergedConfig = Map.from(baseConfig);
     mergedConfig['dependency_overrides'] = {
       ...(baseConfig['dependency_overrides'] ?? {}),
       ...(localConfig['dependency_overrides'] ?? {})
     };
   
     devPubspec.writeAsStringSync(dumpYaml(mergedConfig));
     Process.runSync('dart', ['pub', 'get', '--file', 'pubspec.dev.yaml']);
   }
   

3. 批量执行脚本：在工作区根目录创建 setup_local.sh，遍历所有包执行合并逻辑：

   #!/bin/bash
   PACKAGES=("ios_transmogrify" "android_transmogrify" "core_transmogrify" "core_tools")
   for pkg in "${PACKAGES[@]}"; do
     cd "$pkg" || exit 1
     dart ../merge_pubspec.dart
     cd ..
   done
   

开发时只需运行 ./setup_local.sh 即可完成本地依赖配置，提交代码时无需修改任何文件——pubspec.local.yaml 和 pubspec.dev.yaml 都不会被Git追踪。

方案2：Git 过滤器自动替换 #

通过Git的smudge/clean过滤器，实现拉取代码时自动替换为本地路径依赖，提交时自动还原为远程版本：

1. 配置Git属性：在工作区根目录创建 .gitattributes（提交到仓库）：

   pubspec.yaml filter=pubspec_local
   

2. 编写过滤脚本：在仓库的 scripts 目录创建两个脚本（提交到仓库）：
   • pubspec_smudge.sh（拉取时替换依赖）：

     #!/bin/bash
     sed -e 's/core_transmogrify: ^[0-9.]*$/core_transmogrify:\n    path: ..\/core_transmogrify/' \
         -e 's/core_tools: ^[0-9.]*$/core_tools:\n    path: ..\/core_tools/'
     

   • pubspec_clean.sh（提交时还原依赖）：

     #!/bin/bash
     sed -e 's/core_transmogrify:\n    path: ..\/core_transmogrify$/core_transmogrify: ^1.1.0/' \
         -e 's/core_tools:\n    path: ..\/core_tools$/core_tools: ^1.0.0/'
     

3. 初始化过滤器：克隆仓库后执行一次以下命令，后续无需手动操作：

   git config filter.pubspec_local.smudge ./scripts/pubspec_smudge.sh
   git config filter.pubspec_local.clean ./scripts/pubspec_clean.sh
   

   若要简化初始化流程，可将配置写入仓库的 .gitconfig 模板，配合全局Git配置自动应用。

跨语言通用解决方案 #

1. 语言原生工具 #

• Node.js：使用 npm link 或 yarn link 将本地包链接到项目，无需修改 package.json，开发完成后执行 npm unlink 即可还原。
• Python：使用 pip install -e ../package-path 以可编辑模式安装本地依赖，requirements.txt 保留远程版本，提交时无需修改配置。

2. 通用配置合并工具 #

使用yq（YAML处理）或jq（JSON处理）编写通用脚本，合并主配置与本地覆盖配置：

• YAML（Dart、Python pyproject.toml 可用tq）：

  yq eval-all '. as $item ireduce ({}; . * $item)' pubspec.yaml pubspec.local.yaml > pubspec.dev.yaml
  

• JSON（Node.js package.json）：

  jq -s '.[0] * .[1]' package.json package.local.json > package.dev.json
  

这些脚本可封装为通用命令，适配多语言项目的配置覆盖需求。

内容的提问来源于stack exchange，提问作者TSR