sitegui/this-commit
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
Get the current commit name
3 commits 1 branch 0 tags 32 KiB
Find a file
Exact
Guilherme Souza 46bce14f3c Removed unused files
2015-01-25 18:55:47 -02:00
test Removed unused files 2015-01-25 18:55:47 -02:00
.gitignore Initial comit 2015-01-25 18:08:15 -02:00
.jshintrc Initial comit 2015-01-25 18:08:15 -02:00
.npmignore First implementation and tests 2015-01-25 18:52:47 -02:00
index.js First implementation and tests 2015-01-25 18:52:47 -02:00
LICENSE Initial comit 2015-01-25 18:08:15 -02:00
package.json First implementation and tests 2015-01-25 18:52:47 -02:00
README.md First implementation and tests 2015-01-25 18:52:47 -02:00

README.md

This Commit

Get the current commit name

Install

npm install this-commit --save

Usage

var commit = require('this-commit')()
// commit is a string like '5cdb9922ab793900847a3c3801831f1f242be11b'
// or '' if could not found

var commit = require('this-commit').asBuffer()
// commit is a Buffer instance (or null)

Both forms accept as an optional argument the '.git' folder. By default, it will be found by walking up from the current working dir.

Features

  • Read from .git folder on disk, do not execute git
  • Work from sub-dirs, will look for .git on parent directories
  • Support for detached head
  • Support for packed refs