mvg (modules via git and more)

方便起见，以下将项目开发时需要引入的外部代码、公共模块简称“包”。这类包通常是工具、辅助性质，而不是需要上线的完整服务。

极其简单的基于git等shell工具的包管理器，不限语言和项目。

基本思想

• 将项目适当拆分，将需要从外部引入的部分视作包，在配置文件中定义包的名称、来源以及同步方式、类型等
  • 例如，可以定义包的git repo，将branch或tag视作包版本，则通过git将包的代码同步到项目本地
  • 例如，可以自定义命令，做任何想要的代码同步的事情，尽管不限于同步代码
• 将包作为项目代码的一部分，在你需要更新它的时候更新
  • 这样省去了“安装依赖包”这件事的麻烦，因为本质上是项目本地文件操作，在本地解决依赖问题，便于部署
  • 自动将模块化的包做一层包装，避免它的代码在项目中被修改

使用方法

在ini配置文件中定义依赖，执行sh脚本，即可将依赖同步至项目本地。

具体操作：

1. 将mvg.sh和mvg.ini拷贝至项目根目录下

2. 将mvg.sh脚本开头的BASE_PATH变量配置成自己想要的目录（默认为./），用于放置所有依赖包

3. 在mvg.ini中定义依赖

   1. 每个section相当于包名。如果是git方式，则会在BASE_PATH目录下将对应的仓库clone到以该名字命名的子目录

   2. 为每个包定义repo（即git url；如果是git方式则必填）、checkout（即git checkout命令的参数，为branch或tag；选填）、subpath（在BASE_PATH下的子路径，以/结尾；选填）、path（在项目根路径下的子路径，不受BASE_PATH限制，以/结尾；选填）、wrap（包装形式；例如py则会将包放进名称带有包名hash的子文件夹中，再在与该子文件夹同级的__init__.py文件中import *，js也类似；选填）

      [a]
      repo=git@some.server.com:foo/a.git
      
      [b]
      repo=git@some.server.com:foo/b.git
      checkout=master
      
      [c]
      repo=git@some.server.com:foo/c.git
      checkout=v1.0.0
      
      [d]
      repo=git@some.server.com:foo/d.git
      subpath=mod_d/
      
      [e]
      repo=git@some.server.com:foo/e.git
      path=util/
      
      [f]
      repo=git@some.server.com:foo/f.git
      wrap=py

   3. 除了git方式外，还可以：

      1. 定义file，则通过curl将指定url的文件下载到指定路径
      2. 定义cmd，自定义下载过程

      此外，可以自定义下载内容前后的过程：

      1. 定义cmd_before，在下载包内容前执行
      2. 定义cmd_after，在下载包内容后执行

      [g]
      cmd_before=echo 'before'
      cmd=cd .. && git clone git@some.server.com:foo/g.git
      cmd_after=echo 'after'
      
      [h]
      cmd=scp user@x.x.x.x:/path/to/mod.py ./
      
      [i]
      cmd=scp -r user@x.x.x.x:/path/to/mod ./
      wrap=py
      
      [j]
      cmd=scp -r user@x.x.x.x:/path/to/mod ../
      
      [k]
      file=http://some.domain.com/path/to/k.json
      path=./static/
      
      [l]
      cmd=git archive --remote ssh://some.server.com:foo/proj HEAD path/to/l.py | tar xvz --strip-components 2

4. 执行mvg.sh，即可将配置定义的包一次同步到项目内；可以加参数，即指定（1个或多个）包名，脚本便只检查和更新指定的包

   $ ./mvg.sh # sync all
   $ ./mvg.sh a b # just sync `a` and `b`

注意事项

• 脚本内部执行git操作之后，会自动删除包的仓库中的.git目录
• 包的代码只从外部更新，而不在项目开发过程中改动，除非确定以后不再从外部更新这个包，或者愿意每次更新都合并改动
• 因为包的代码是项目代码的一部分，所以包的代码不用被git ignore，在依赖没有变动的情况下也不需要有一般包管理器的install操作

特别地，对于python模块，如果包含requirements.txt文件，建议在项目的requirements.txt中使用-r a/requirements.txt的方式将模块的依赖引进项目的依赖。

相关工作

其实主流的包管理器如npm、pip都支持vcs。例如pip对vcs的支持，但还不是最方便灵活。