Awesome
get-first-commit
Returns a git repository's first commit as a JavaScript object.
Install
Install with npm
$ npm i get-first-commit --save
Usage
var getFirstCommit = require('get-first-commit');
getFirstCommit(function(err, commit) {
if (err) return console.log(err);
console.log(commit);
});
Results in
{ commit: 'b371794fbdbdd68498e8c9f3bf766b095ad2fb30',
author: 'jonschlinkert <jon.schlinkert@sellside.com>',
date: 'Sun Nov 22 07:44:07 2015 -0500',
message: 'first commit' }
API
firstCommit
Asynchronously get the first commit from a git repository.
Params
cwd
{String}: current working directorycallback
{Function}returns
{Object}
Example
firstCommit('foo/.git', function(err, commit) {
if (err) return console.log(err);
// do stuff with commit
});
.sync
Synchronously get the first commit from a git repository.
Params
cwd
{String}: current working directoryreturns
{Object}
Example
var commit = firstCommit.sync('foo/.git');
Related projects
- git-repo-name: Get the repository name from the git remote origin URL. | homepage
- git-user-name: Get a user's name from git config at the project or global scope, depending on… more | homepage
- git-username: Get the username from a git remote origin URL. | homepage
- github-base: Base methods for creating node.js apps that work with the GitHub API. | homepage
Running tests
Install dev dependencies:
$ npm i -d && npm test
Contributing
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Author
Jon Schlinkert
License
Copyright © 2015 Jon Schlinkert Released under the MIT license.
This file was generated by verb-cli on November 22, 2015.