feat: silent success if nothing has changed (#138)

Author: younggglcy

.changeset/easy-sites-stick.md

@@ -0,0 +1,5 @@
+---
+"simple-git-hooks": minor
+---
+
+feat: silent success if nothing has changed

cli.js

@@ -11,5 +11,11 @@ if(skipInstall()) {
 }
 
 setHooksFromConfig(process.cwd(), process.argv)
-    .then(() => console.log('[INFO] Successfully set all git hooks'))
+    .then(({ isHookChanged }) => {
+        if (!isHookChanged) {
+            // all configured hooks are set but with same contents, silent success
+            return
+        }
+        console.log('[INFO] Successfully set all git hooks')
+    })
     .catch(e => console.log('[ERROR], Was not able to set git hooks. Error: ' + e))

simple-git-hooks.js

@@ -180,13 +180,22 @@ async function setHooksFromConfig(projectRootPath=process.cwd(), argv=process.ar
 
     const preserveUnused = Array.isArray(config.preserveUnused) ? config.preserveUnused : config.preserveUnused ? VALID_GIT_HOOKS: []
 
+    let isHookChanged = false
+
     for (let hook of VALID_GIT_HOOKS) {
         if (Object.prototype.hasOwnProperty.call(config, hook)) {
-            _setHook(hook, config[hook], projectRootPath)
+            const isHookUpdated = _setHook(hook, config[hook], projectRootPath).hookChanged
+            isHookChanged = isHookChanged || isHookUpdated
         } else if (!preserveUnused.includes(hook)) {
-            _removeHook(hook, projectRootPath)
+            const isHookDeleted = _removeHook(hook, projectRootPath)
+            isHookChanged = isHookChanged || isHookDeleted
         }
     }
+
+
+    return {
+        isHookChanged,
+    }
 }
 
 /**
@@ -230,7 +239,10 @@ function _setHook(hook, command, projectRoot=process.cwd()) {
 
     if (!gitRoot) {
         console.info('[INFO] No `.git` root folder found, skipping')
-        return
+        return {
+            hookChanged: false,
+            success: false
+        }
     }
 
     const hookCommand = PREPEND_SCRIPT + command
@@ -242,10 +254,23 @@ function _setHook(hook, command, projectRoot=process.cwd()) {
         fs.mkdirSync(normalizedHookDirectory, { recursive: true })
     }
 
+    if (fs.existsSync(hookPath)) {
+        const existingHook = fs.readFileSync(hookPath, { encoding: 'utf-8' })
+        if (existingHook === hookCommand) {
+            return {
+                hookChanged: false,
+                success: true
+            }
+        }
+    }
     fs.writeFileSync(hookPath, hookCommand)
     fs.chmodSync(hookPath, 0o0755)
 
     console.info(`[INFO] Successfully set the ${hook} with command: ${command}`)
+    return {
+        hookChanged: true,
+        success: true
+    }
 }
 
 /**
@@ -272,6 +297,7 @@ async function removeHooks(projectRoot = process.cwd()) {
  * Removes the pre-commit hook
  * @param {string} hook
  * @param {string} projectRoot
+ * @returns {boolean} whether the hook was removed
  * @private
  */
 function _removeHook(hook, projectRoot=process.cwd()) {
@@ -280,7 +306,9 @@ function _removeHook(hook, projectRoot=process.cwd()) {
 
     if (fs.existsSync(hookPath)) {
         fs.unlinkSync(hookPath)
+        return true
     }
+    return false
 }
 
 /** Reads package.json file, returns package.json content and path

simple-git-hooks.test.js

@@ -653,6 +653,19 @@ describe("Simple Git Hooks tests", () => {
           expect(installedHooks).toEqual({ "pre-commit": TEST_SCRIPT });
         });
       });
+
+      describe('should silently succeed if all hooks are already installed', () => {
+        it('silent success by default', async () => {
+          createGitHooksFolder(PROJECT_WITH_CONF_IN_SEPARATE_JSON);
+
+          const output1 = execSync(`node ${require.resolve("./cli")}`, { cwd: PROJECT_WITH_CONF_IN_SEPARATE_JSON, encoding: 'utf8' });
+          expect(output1).toMatch(/\[INFO\] Successfully set all git hooks/);
+          expect(output1).toMatch(/\[INFO\] Successfully set the pre-commit with command: exit 1/);
+
+          const output2 = execSync(`node ${require.resolve("./cli")}`, { cwd: PROJECT_WITH_CONF_IN_SEPARATE_JSON, encoding: 'utf8' }).trim();
+          expect(output2).toBe('');
+        })
+      });
     });
 
     describe("ENV vars features tests", () => {