Add commonGitDir and worktreeGitDir to returned object; add typings

Author: ecraig12345

README.md

@@ -22,6 +22,12 @@ info.committerDate        // commit date for the current sha
 info.author               // author for the current sha
 info.authorDate           // authored date for the current sha
 info.commitMessage        // commit message for the current sha
+info.root                 // root directory for the Git repo or submodule
+                          //   (if in a worktree, this is the directory containing the original copy)
+info.commonGitDir         // directory containing Git metadata for this repo or submodule
+                          //   (if in a worktree, this is the primary Git directory for the repo)
+info.worktreeGitDir       // if in a worktree, the directory containing Git metadata specific to
+                          //   this worktree; otherwise, this is the same as `commonGitDir`.
 ```
 
 When called without any arguments, `git-repo-info` will automatically lookup upwards

index.d.ts

@@ -0,0 +1,43 @@
+declare function gitRepoInfo(): gitRepoInfo.GitRepoInfo;
+
+declare namespace gitRepoInfo {
+  export interface GitRepoInfo {
+    /** The current branch */
+    branch: string;
+    /** SHA of the current commit */
+    sha: string;
+    /** The first 10 chars of the current SHA */
+    abbreviatedSha: string;
+    /** The tag for the current SHA (or `null` if no tag exists) */
+    tag: string | null;
+    /** Tag for the closest tagged ancestor (or `null` if no ancestor is tagged) */
+    lastTag: string | null;
+    /** The committer of the current SHA */
+    committer: string;
+    /** The commit date of the current SHA */
+    committerDate: string;
+    /** The author for the current SHA */
+    author: string;
+    /** The authored date for the current SHA */
+    authorDate: string;
+    /** The commit message for the current SHA */
+    commitMessage: string;
+    /**
+     * The root directory for the Git repo or submodule.
+     * If in a worktree, this is the directory containing the original copy, not the worktree.
+     */
+    root: string;
+    /**
+    * The directory containing Git metadata for this repo or submodule.
+    * If in a worktree, this is the primary Git directory for the repo, not the worktree-specific one.
+    */
+    commonGitDir: string;
+    /**
+     * If in a worktree, the directory containing Git metadata specific to this worktree.
+     * Otherwise, this is the same as `commonGitDir`.
+     */
+    worktreeGitDir: string;
+  }
+}
+
+export = gitRepoInfo;

index.js

@@ -12,12 +12,14 @@ function changeGitDir(newDirName) {
 
 function findRepoHandleLinkedWorktree(gitPath) {
   var stat = fs.statSync(gitPath);
+  var root = path.dirname(path.resolve(gitPath));
   if (stat.isDirectory()) {
     return {
       // for the base (non-linked) dir, there is no distinction between where we
       // find the HEAD file and where we find the rest of .git
       worktreeGitDir: gitPath,
       commonGitDir: gitPath,
+      root: root,
     };
   } else {
     // We have a file that tells us where to find the worktree git dir.  Once we
@@ -30,21 +32,22 @@ function findRepoHandleLinkedWorktree(gitPath) {
     var worktreeGitDir = path.resolve(absolutePath,worktreeGitDirUnresolved);
     var commonDirPath = path.join(worktreeGitDir, 'commondir');
     if (fs.existsSync(commonDirPath)) {
-      // this directory contains a `commondir` file; we're within a linked
-      // worktree
+      // this directory contains a `commondir` file; we're in a linked worktree
 
       var commonDirRelative = fs.readFileSync(commonDirPath).toString().replace(/\r?\n$/, '');
       var commonDir = path.resolve(path.join(worktreeGitDir, commonDirRelative));
 
       return {
         worktreeGitDir: worktreeGitDir,
         commonGitDir: commonDir,
+        root: path.dirname(commonDir),
       };
     } else {
       // there is no `commondir` file; we're in a submodule
       return {
         worktreeGitDir: worktreeGitDir,
         commonGitDir: worktreeGitDir,
+        root: root,
       };
     }
   }
@@ -94,7 +97,7 @@ function getPackedRefsFile(gitPath) {
 }
 
 function getLinesForRefPath(packedRefsFile, type, refPath) {
-  return packedRefsFile.split('\n').reduce(function(acc, line, idx, arr) {
+  return packedRefsFile.split(/\r?\n/).reduce(function(acc, line, idx, arr) {
     var targetLine = line.indexOf('^') > -1 ? arr[idx-1] : line;
     return doesLineMatchRefPath(type, line, refPath) ? acc.concat(targetLine) : acc;
   }, []);
@@ -132,7 +135,7 @@ function commitForTag(gitPath, tag) {
   // 'tag 172\u0000object c1ee41c325d54f410b133e0018c7a6b1316f6cda\ntype commit\ntag awesome-tag\ntagger Robert Jackson
   // <[email protected]> 1429100021 -0400\n\nI am making an annotated tag.\n'
   if (objectContents.slice(0,3) === 'tag') {
-    var sections = objectContents.split(/\0|\n/);
+    var sections = objectContents.split(/\0|\r?\n/);
     var sha = sections[1].slice(7);
 
     return sha;
@@ -214,16 +217,20 @@ module.exports = function(gitPath) {
     authorDate: null,
     commitMessage: null,
     root: null,
+    commonGitDir: null,
+    worktreeGitDir: null,
     lastTag: null,
     commitsSinceLastTag: 0,
   };
 
   if (!gitPathInfo) { return result; }
 
   try {
-    result.root = path.resolve(gitPathInfo.commonGitDir, '..');
+    result.root = gitPathInfo.root;
+    result.commonGitDir = gitPathInfo.commonGitDir;
+    result.worktreeGitDir = gitPathInfo.worktreeGitDir;
 
-    var headFilePath   = path.join(gitPathInfo.worktreeGitDir, 'HEAD');
+    var headFilePath = path.join(gitPathInfo.worktreeGitDir, 'HEAD');
 
     if (fs.existsSync(headFilePath)) {
       var headFile = fs.readFileSync(headFilePath, {encoding: 'utf8'});
@@ -290,7 +297,7 @@ function getCommitData(gitPath, sha) {
   if (zlib.inflateSync && fs.existsSync(objectPath)) {
     var objectContents = zlib.inflateSync(fs.readFileSync(objectPath)).toString();
 
-    return objectContents.split(/\0|\n/)
+    return objectContents.split(/\0|\r?\n/)
       .filter(function(item) {
         return !!item;
       })
@@ -315,7 +322,7 @@ function getCommitData(gitPath, sha) {
             }
             break;
           case 'parent':
-            data.parents = section.split('\n').map(p => p.split(' ')[1]);
+            data.parents = section.split(/\r?\n/).map(p => p.split(' ')[1]);
             break;
           default:
             //should just be the commit message left

package.json

@@ -3,8 +3,10 @@
   "version": "2.0.0",
   "description": "Retrieve current sha and branch name from a git repo.",
   "main": "index.js",
+  "types": "index.d.ts",
   "files": [
-    "index.js"
+    "index.js",
+    "index.d.ts"
   ],
   "scripts": {
     "test": "mocha tests",
@@ -25,8 +27,8 @@
   },
   "homepage": "https://github.com/rwjblue/git-repo-info",
   "devDependencies": {
-    "mocha": "^1.21.4",
-    "mocha-jshint": "^1.1.0"
+    "mocha": "^4.1.0",
+    "mocha-jshint": "^2.3.1"
   },
   "engines": {
     "node": ">= 4.0"