HBC BLOG

主题

download-git-repo 使用教程 ​

安装 ​

bash
$ npm install download-git-repo

简写形式 ​

此API的第一个参数repository用两种写法，一个是代码仓库的简写形式：

  • GitHub - github:owner/name or simply owner/name
  • GitLab - gitlab:owner/name
  • Bitbucket - bitbucket:owner/name

INFO

默认是 master 分枝, 但你可以指定分枝和tag ，如 owner/name#my-branch. 你还可以指定自定义来源，如 gitlab:custom.com:owner/name. 自定义来源默认为 https 或 git@ , 你也可以自己之定义协议.

Direct - direct:url方式 ​

这种方式会跳过上面简写的方式，直接传递 url.

  • 如果使用 direct，并且没有 clone配置项, 你必须传入完整的zip文件地址, 包括分枝（如果需要的话）.

  • 如果使用 direct 并带有 clone配置项, 你必须传入完整的 git repo url , 你可以通过 direct:url#my-branch指定分枝.

INFO

一版使用第二种写法

引入

js
const download = require("download-git-repo");

direct url http下载方式 ​

js
download("direct:https://gitee.com/xxxxx.zip", "文件名称", function (err) {
  console.log(err ? "Error" : "Success");
});

使用direct url git clone 方式下载master分枝. ​

js
download(
  "direct:https://gitee.com/xxxxx.git",
  "文件名称",
  { clone: true },
  function (err) {
    console.log(err ? "Error" : "Success");
  }
);

使用direct url git clone 方式下载 my-branch分枝. ​

js
download(
  "direct:https://gitee.com/xxxxx.git#my-branch",
  "文件名称",
  { clone: true },
  function (err) {
    console.log(err ? "Error" : "Success");
  }
);