Created by Tim Branyen @tbranyen
Currently under active development, nodegit2 provides asynchronous native bindings to the libgit2 C API.
To run nodegit2 you need Node.js and to run unit tests you will need to have git installed and accessible from your PATH to fetch any vendor/ addons.
This will install and configure everything you need to use nodegit2.
[tim@thinkpad Projects]$ sudo npm install nodegit2
Install nodegit2 by cloning source from GitHub and running the configure, make, and make install commands:
*Note: nodegit2 assumes your library path exists at ~/.node_libraries.*
[tim@thinkpad Projects]$ git clone git://github.com/tbranyen/nodegit2.git
[tim@thinkpad Projects]$ cd nodegit2
[tim@thinkpad nodegit2]$ ./configure
[tim@thinkpad nodegit2]$ make
[tim@thinkpad nodegit2]$ make install
nodegit2 has been compiled and tested to work with the setup required to build and run Node.js itself.
Instructions on compiling Node.js on a Windows platform can be found here:
[https://github.com/ry/node/wiki/Building-node.js-on-Cygwin-(Windows)](https://github.com/ry/node/wiki/Building-node.js-on-Cygwin-(Windows\))
__ Reading a repository and commit data: __
var git = require( 'nodegit2' );
// Read the current repository
git.repo( '.git', function( err, path, repo ) {
// If success will return 0, if an error message throw it as an error string.
if( err ) { throw err; }
// Read a commit with a SHA1
this.commit( '5f2aa9407f7b3aeb531c621c3358953841ccfc98', function( err, commit ) {
// If success err will be 0, else throw an error message.
if( err ) { throw err; }
console.log( 'Message', commit.message );
console.log( 'Author name', commit.author.name );
console.log( 'Author email', commit.author.email );
// Memory cleanup is *not* required, but would be nice if you remembered :)
repo.free();
});
});
__ Accomplishing the same thing as above: __
var git = require( 'nodegit2' ).git2;
// Create instance of Repo constructor
var repo = new git.Repo();
// Read the current repository
repo.open( '.git', function( err, path ) {
// If success will return 0, if an error message throw it as an error string.
if( err ) { throw err };
// Create object id and set hash
var oid = new git.Oid();
oid.mkstr( '5f2aa9407f7b3aeb531c621c3358953841ccfc98' );
// Create commit object
var commit = new git.Commit();
// Lookup commit
commit.lookup( repo, oid, function( err, commit ) {
// If success err will be 0, else throw an error message.
if( err ) { throw err; }
console.log( 'Message', commit.message );
console.log( 'Author name', commit.author.name );
console.log( 'Author email', commit.author.email );
// Memory cleanup is *not* required, but would be nice if you remembered :)
repo.free();
});
});
__ nodegit2 library code is written adhering to a modified JSHint. Run these tests with make lint. __
__ To run unit tests ensure the submodules nodeunit and rimraf are located in the vendor/ subdirectory. __
If they are not, cd into the nodegit2 dir and run the following git commands to automatically fetch them:
[tim@thinkpad Projects]$ cd nodegit2
[tim@thinkpad nodegit2]$ git submodule init vendor/
[tim@thinkpad nodegit2]$ git submodule update vendor/
Then simply run make unittest in the project root.
__ Can keep track of current method coverage at: http://bit.ly/tb_methods __
* Some useful methods implemented
* Some unit tests
* Some documented source code
* Useable build/code quality check tools
* Node.js application that can be configured/built/installed via source and NPM
* An API that can be easily extended with convenience methods in JS
* An API that offers a familiar clean syntax that will make adoption and use much more likely
* Open for public testing
* Be able to open and read a repo and fetch all its commits and lookup specific commits and their associated metadata + reading blob rawcontent.
* More methods implemented
* More unit tests
* GitHub landing page
* More API development
* Custom odb backend
* API coverage in GitHub Wiki
If you find this project of interest, please document all issues and fork if you feel you can provide a patch. Testing is of huge importance; by simply running the unit tests on your system and reporting issues you can contribute!