Initial commit

Author: watson

.gitignore

@@ -0,0 +1,25 @@
+# Logs
+logs
+*.log
+
+# Runtime data
+pids
+*.pid
+*.seed
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Compiled binary addons (http://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directory
+# Deployed apps should consider commenting this line out:
+# see https://npmjs.org/doc/faq.html#Should-I-check-my-node_modules-folder-into-git
+node_modules

.travis.yml

@@ -0,0 +1,8 @@
+language: node_js
+node_js:
+- '0.12'
+- '0.10'
+- '0.8'
+- 'iojs'
+before_install:
+- npm install -g npm@~1.4.6

README.md

@@ -0,0 +1,59 @@
+# git-state
+
+Get the current state of any git repository.
+
+[![Build status](https://travis-ci.org/watson/git-state.svg?branch=master)](https://travis-ci.org/watson/git-state)
+[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](https://github.com/feross/standard)
+
+## Installation
+
+```
+npm install git-state
+```
+
+## Usage
+
+```js
+var gitState = require('git-state')
+
+var path = '/path/to/git/repo'
+
+if (gitState.isGit(path)) {
+  gitState.check(path, function (err, result) {
+    if (err) throw err
+    console.log(result) // => { branch: 'master',
+                        //      ahead: 0,
+                        //      dirty: 9,
+                        //      untracked: 1,
+                        //      issues: true }
+  })
+}
+```
+
+## API
+
+#### `isGit(path)`
+
+Returns either `true` or `false` if the given path contains a git
+repository.
+
+#### `check(path, callback)`
+
+Will check the state of the git repository at the given `path` and call
+the `callback`. The `callback` will be called with two arguments: An
+optional error object and a result object.
+
+The result object contains the following properties:
+
+- `branch` - The currently checked out branch
+- `ahead` - The amount of commits the current branch is ahead of the
+  remote (may be `NaN` if there for instance is no remote)
+- `dirty` - The number of dirty files
+- `untracked` - The number of untracked files
+- `issues` - A generic boolean which is `true` if the repository is in a
+  non-clean state (e.g. it's dirty, contains untracked files, is head of
+  its remote or is currently not on master)
+
+## License
+
+MIT

index.js

@@ -0,0 +1,65 @@
+'use strict'
+
+var os = require('os')
+var fs = require('fs')
+var path = require('path')
+var exec = require('child_process').exec
+var afterAll = require('after-all-results')
+
+exports.isGit = function (dir) {
+  return fs.existsSync(path.join(dir, '.git'))
+}
+
+exports.check = function (repo, cb) {
+  var next = afterAll(function (err, results) {
+    if (err) return cb(err)
+
+    var branch = results[0]
+    var ahead = results[1]
+    var status = results[2]
+    var issues = Boolean(branch !== 'master' ||
+                         ahead || Number.isNaN(ahead) ||
+                         status.dirty || status.untracked)
+
+    cb(null, {
+      branch: branch,
+      ahead: ahead,
+      dirty: status.dirty,
+      untracked: status.untracked,
+      issues: issues
+    })
+  })
+
+  branch(repo, next())
+  ahead(repo, next())
+  status(repo, next())
+}
+
+var status = function (repo, cb) {
+  exec('git status -s', { cwd: repo }, function (err, stdout, stderr) {
+    if (err) return cb(err)
+    var status = { dirty: 0, untracked: 0 }
+    stdout.trim().split(os.EOL).forEach(function (file) {
+      if (file.substr(0, 2) === '??') status.untracked++
+      else status.dirty++
+    })
+    cb(null, status)
+  })
+}
+
+var branch = function (repo, cb) {
+  exec('cat .git/HEAD', { cwd: repo }, function (err, stdout, stderr) {
+    if (err) return cb(err)
+    stdout = stdout.trim()
+    var branch = stdout.indexOf('ref:') === 0 ? stdout.substr(16) : stdout
+    cb(null, branch)
+  })
+}
+
+var ahead = function (repo, cb) {
+  exec('git rev-list HEAD --not --remotes', { cwd: repo }, function (err, stdout, stderr) {
+    if (err) return cb(null, NaN) // depending on the state of the git repo, the command might return non-0 exit code
+    stdout = stdout.trim()
+    cb(null, !stdout ? 0 : parseInt(stdout.split(os.EOL).length, 10))
+  })
+}

package.json

@@ -0,0 +1,42 @@
+{
+  "name": "git-state",
+  "version": "0.0.0",
+  "description": "Get the current state of any git repository",
+  "main": "index.js",
+  "scripts": {
+    "test": "standard && tape test.js"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/watson/git-state.git"
+  },
+  "dependencies": {
+    "after-all-results": "^2.0.0"
+  },
+  "devDependencies": {
+    "standard": "^4.3.1",
+    "tape": "^4.0.0"
+  },
+  "keywords": [
+    "git",
+    "status",
+    "state",
+    "issues",
+    "branch",
+    "repo",
+    "repository",
+    "ahead",
+    "dirty",
+    "untracked"
+  ],
+  "author": "Thomas Watson Steen <[email protected]> (https://twitter.com/wa7son)",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/watson/git-state/issues"
+  },
+  "homepage": "https://github.com/watson/git-state",
+  "coordinates": [
+    18.4785126,
+    -69.954776
+  ]
+}

test.js

@@ -0,0 +1,25 @@
+'use strict'
+
+var test = require('tape')
+var git = require('./')
+
+test('#isGit()', function (t) {
+  var dir = process.cwd()
+  var result = git.isGit(dir)
+  t.equal(result, true)
+  t.end()
+})
+
+test('#check()', function (t) {
+  var dir = process.cwd()
+  git.check(dir, function (err, result) {
+    t.error(err)
+    t.deepEqual(Object.keys(result), ['branch', 'ahead', 'dirty', 'untracked', 'issues'])
+    t.equal(typeof result.branch, 'string')
+    t.equal(typeof result.ahead, 'number')
+    t.equal(typeof result.dirty, 'number')
+    t.equal(typeof result.untracked, 'number')
+    t.equal(typeof result.issues, 'boolean')
+    t.end()
+  })
+})