NodeGit 技术文档

1. 安装指南

1.1 环境要求

NodeGit 大多数系统下无需依赖本地库即可直接使用。

1.2 安装步骤

使用 npm 安装 NodeGit：

npm install nodegit

1.3 问题解决

如果在 Travis-CI 构建时遇到关于 libstdc++ 的错误，可以通过升级到最新的 libstdc++-4.9 版本来解决。以下是在不同操作系统上的升级方法：

• 在 Ubuntu 上：

sudo add-apt-repository ppa:ubuntu-toolchain-r/test
sudo apt-get update
sudo apt-get install libstdc++-4.9-dev

• 在 Travis CI 上：

addons:
  apt:
    sources:
      - ubuntu-toolchain-r-test
    packages:
      - libstdc++-4.9-dev

• 在 CircleCI 上：

dependencies:
  pre:
    - sudo add-apt-repository -y ppa:ubuntu-toolchain-r/test
    - sudo apt-get update
    - sudo apt-get install -y libstdc++-4.9-dev

如果遇到关于 lifecycleScripts 的 preinstall/install 错误，可能缺少 libssl-dev。在 Ubuntu 上安装：

sudo apt-get install libssl-dev

1.4 必要库

确保在 Linux 机器上安装以下库：

• libpcre
• libpcreposix
• libkrb5
• libk5crypto
• libcom_err

在本地构建时，还需要安装 kerberos 和 pcre 的开发包。

1.5 从源代码构建

如果安装过程中遇到问题，可以尝试从源代码构建。请参考 Building from source 指南。

2. 项目使用说明

以下是一些使用 NodeGit 的基本示例。

2.1 克隆仓库并读取文件

var Git = require("nodegit");

Git.Clone("https://github.com/nodegit/nodegit", "./tmp")
  .then(function(repo) {
    return repo.getCommit("59b20b8d5c6ff8d09518454d4dd8b7b30f095ab5");
  })
  .then(function(commit) {
    return commit.getEntry("README.md");
  })
  .then(function(entry) {
    return entry.getBlob().then(function(blob) {
      blob.entry = entry;
      return blob;
    });
  })
  .then(function(blob) {
    console.log(blob.entry.path() + blob.entry.sha() + blob.rawsize() + "b");
    console.log(Array(72).join("=") + "\n\n");
    console.log(String(blob));
  })
  .catch(function(err) { console.log(err); });

2.2 模拟 git log

var Git = require("nodegit");

Git.Repository.open("tmp")
  .then(function(repo) {
    return repo.getMasterCommit();
  })
  .then(function(firstCommitOnMaster) {
    var history = firstCommitOnMaster.history();
    var count = 0;
    history.on("commit", function(commit) {
      if (++count >= 9) {
        return;
      }
      console.log("commit " + commit.sha());
      var author = commit.author();
      console.log("Author:\t" + author.name() + " <" + author.email() + ">");
      console.log("Date:\t" + commit.date());
      console.log("\n    " + commit.message());
    });
    history.start();
  });

更多示例请参考项目中的 examples/ 文件夹。

3. 项目API使用文档

NodeGit 的 API 文档可以在 http://www.nodegit.org/ 找到。

4. 项目安装方式

NodeGit 的安装方式主要使用 npm。确保已安装 Node.js 和 npm，然后执行以下命令：

npm install nodegit