use git ignore rules to skip hooks

Author: Nikita Korotkih

README.md

@@ -46,6 +46,8 @@ git commit -m "Add git-hooks"
 
 See also [hooks examples](examples).
 
+It's worth to mention that our library checks for gitignore rules while executing scripts in .githooks/ directories.
+
 ## Related projects
   * Original [git-hooks](https://github.com/icefox/git-hooks) project
   * [pre-commit](https://github.com/observing/pre-commit)

lib/git-hooks.js

@@ -3,6 +3,7 @@ var util = require('util');
 var spawn = require('child_process').spawn;
 var fs = require('fs');
 var fsHelpers = require('./fs-helpers');
+var exec = require('child_process').exec;
 
 var HOOKS_DIRNAME = 'hooks';
 var HOOKS_OLD_DIRNAME = 'hooks.old';
@@ -25,6 +26,19 @@ var HOOKS = [
     'update'
 ];
 
+/**
+ * @param {String[]} hooks List of hook's paths with possible excludes(.gitignore files)
+ * @param {function} callback Filtered hooks will be passed in the callback
+ */
+function excludeIgnoredPaths(hooks, callback) {
+    exec('git check-ignore ' + hooks.join(' '), function (error, output) {
+        // intentionally ignore errors
+        callback(hooks.filter(function (hookName) {
+            return output.indexOf(hookName) === -1;
+        }));
+    });
+}
+
 module.exports = {
     /**
      * Installs git hooks.
@@ -112,8 +126,9 @@ module.exports = {
             var hooks = list.map(function (hookName) {
                 return path.resolve(hooksDirname, hookName);
             });
-
-            runHooks(hooks, [arg], callback);
+            excludeIgnoredPaths(hooks, function (filteredHooks) {
+                runHooks(filteredHooks, [arg], callback);
+            });
         } else {
             callback(0);
         }
@@ -133,14 +148,18 @@ function runHooks(hooks, args, callback) {
         return;
     }
 
-    var hook = spawnHook(hooks.shift(), args);
-    hook.on('close', function (code) {
-        if (code === 0) {
-            runHooks(hooks, args, callback);
-        } else {
-            callback(code);
-        }
-    });
+    try {
+        var hook = spawnHook(hooks.shift(), args);
+        hook.on('close', function (code) {
+            if (code === 0) {
+                runHooks(hooks, args, callback);
+            } else {
+                callback(code);
+            }
+        });
+    } catch (e) {
+        callback(1, e);
+    }
 }
 
 /**

lib/hook-template.js

@@ -8,7 +8,10 @@ try {
      * www
      *     node_modules
      */
-    require('%s/git-hooks').run(__filename, process.argv[2], function (code) {
+    require('%s/git-hooks').run(__filename, process.argv[2], function (code, error) {
+        if (error) {
+            console.error('[GIT-HOOKS ERROR] ' + error.message);
+        }
         process.exit(code);
     });
 } catch (e) {

tests/run.test.js

@@ -8,6 +8,7 @@ var GIT_ROOT = SANDBOX_PATH + '.git/';
 var GIT_HOOKS = GIT_ROOT + 'hooks';
 var PRECOMMIT_HOOK_PATH = GIT_HOOKS + '/pre-commit';
 var PROJECT_PRECOMMIT_HOOK = SANDBOX_PATH + '.githooks/pre-commit/';
+var GIT_IGNORE = SANDBOX_PATH + '.gitignore';
 
 function createHook(path, content) {
     fs.writeFileSync(path, '#!/bin/bash\n' + content);
@@ -42,11 +43,12 @@ describe('git-hook runner', function () {
                 fs.writeFileSync(PROJECT_PRECOMMIT_HOOK + 'hello', '#!/bin/bash\n' + 'echo hello > ' + logFile);
             });
 
-            it('should return an error', function () {
-                var fn = function () {
-                    gitHooks.run(PRECOMMIT_HOOK_PATH);
-                };
-                fn.should.throw(Error);
+            it('should return an error', function (done) {
+                gitHooks.run(PRECOMMIT_HOOK_PATH, null, function (code, error) {
+                    code.should.equal(1);
+                    error.should.be.ok;
+                    done();
+                });
             });
         });
 
@@ -98,5 +100,23 @@ describe('git-hook runner', function () {
                 });
             });
         });
+
+        describe('do not run git-ignored scripts from hooks directory', function () {
+            var ignoreFilename = 'ignore-me';
+            var ignoreContent = ignoreFilename + '\n*.swp';
+
+            beforeEach(function () {
+                fs.writeFileSync(GIT_IGNORE, ignoreContent);
+                fs.writeFileSync(PROJECT_PRECOMMIT_HOOK + ignoreFilename, 'exit -1');
+                fs.writeFileSync(PROJECT_PRECOMMIT_HOOK + 'test.swp', 'exit -1');
+            });
+
+            it('should ignore file with wrong permissions in hooks directory', function (done) {
+                gitHooks.run(PRECOMMIT_HOOK_PATH, null, function (code) {
+                    code.should.equal(0);
+                    done();
+                });
+            });
+        });
     });
 });