Node.js libgit2 asynchronous native bindings
npm install nodegit-atomNodeGit
-------
> Node bindings to the libgit2 project.
| Linux | OS X | Windows | Coverage | Dependencies |
|---|---|---|---|---|
Stable: 0.5.0

NodeGit will work on most systems out-of-the-box without any native
dependencies.
`` bash`
npm install nodegit
Note: NodeGit will only work on io.js Windows with the iojs binary instead of node.
If you encounter problems while installing, you should try the Building from
source instructions.
` javascript
var clone = require("nodegit").Clone.clone;
// Clone a given repository into a specific folder.
clone("https://github.com/nodegit/nodegit", "tmp", null)
// Look up this known commit.
.then(function(repo) {
// Use a known commit sha from this repository.
return repo.getCommit("59b20b8d5c6ff8d09518454d4dd8b7b30f095ab5");
})
// Look up a specific file within that commit.
.then(function(commit) {
return commit.getEntry("README.md");
})
// Get the blob contents from the file.
.then(function(entry) {
// Patch the blob to contain a reference to the entry.
return entry.getBlob().then(function(blob) {
blob.entry = entry;
return blob;
});
})
// Display information about the blob.
.then(function(blob) {
// Show the name, sha, and filesize in bytes.
console.log(blob.entry.name() + blob.entry.sha() + blob.size() + "b");
// Show a spacer.
console.log(Array(72).join("=") + "\n\n");
// Show the entire file.
console.log(String(blob));
})
.catch(function(err) { console.log(err); });
`
` javascript
var open = require("nodegit").Repository.open;
// Open the repository directory.
open("tmp")
// Open the master branch.
.then(function(repo) {
return repo.getMasterCommit();
})
// Display information about commits on master.
.then(function(firstCommitOnMaster) {
// Create a new history event emitter.
var history = firstCommitOnMaster.history();
// Create a counter to only show up to 9 entries.
var count = 0;
// Listen for commit events from the history.
history.on("commit", function(commit) {
// Disregard commits past 9.
if (++count >= 9) {
return;
}
// Show the commit sha.
console.log("commit " + commit.sha());
// Store the author object.
var author = commit.author();
// Display author information.
console.log("Author:\t" + author.name() + " <" + author.email() + ">");
// Show the commit date.
console.log("Date:\t" + commit.date());
// Give some space and show the message.
console.log("\n " + commit.message());
});
// Start emitting events.
history.start();
});
`
For more examples, check the examples/ folder.
You will need to build locally before running the tests. See above.
` bash`
npm test
The bump from 0.1.4 to 0.2.0 was a big one. Many things changed, see here:
https://github.com/nodegit/nodegit/compare/v0.1.4...v0.2.0
This update is wholly and entirely a breaking one, and older versions won't be
maintained. For the purpose of migration, perhaps the biggest point to make
is that async methods can now use promises, rather than just taking callbacks.
Additionally, lots of method and property names have changed.
property, and within look
for a nw.js property (or a node-webkit if the prior isn't found) that holds
a specific version of nw.js. The value of this property is what will get passed
as the --target argument to nw-gyp configure`.Currently, support for nw.js is limited, although we intend to support it better
in the future.