✨ Searching config in ancestor directories (#1422)

* ✨ Searching config in ancestor directories

* ✅ Add tests for searching config

* 📝 Update README.md

---------

Co-authored-by: Carlos Cuesta <carloscuesta@me.com>

Author: yzx9

README.md

@@ -136,6 +136,8 @@ You can configure these options via (in order of precedence):
 
 - A `gitmoji` key in your `package.json` file
 - A `.gitmojirc.json` file.
+- A `gitmoji` key in a package.json file in a parent directory (recursively)
+- A `.gitmojirc.json` file in a parent directory (recursively)
 - Using the global cli configuration.
 
 If no user configuration is found, a set of default values will be used.

src/utils/configurationVault/getConfiguration.js

@@ -1,6 +1,7 @@
 import Conf from 'conf'
 import { cwd } from 'process'
 import { readFileSync } from 'fs'
+import { dirname } from 'path'
 import { pathExistsSync } from 'path-exists'
 
 import { CONFIG, EMOJI_COMMIT_FORMATS } from '@constants/configuration'
@@ -60,15 +61,21 @@ const getConfiguration = (): { get: Function, set: Function } => {
   const loadConfig = (): {
     [$Values<typeof CONFIG>]: string | boolean
   } => {
-    const packageJson = `${cwd()}/package.json`
-    const configurationFile = `${cwd()}/.gitmojirc.json`
+    let currentDir = cwd()
 
-    if (pathExistsSync(packageJson) && getFile(packageJson)?.gitmoji) {
-      return getFile(packageJson)?.gitmoji
-    }
+    while (currentDir !== dirname(currentDir)) {
+      const packageJson = `${currentDir}/package.json`
+      const configurationFile = `${currentDir}/.gitmojirc.json`
+
+      if (pathExistsSync(packageJson) && getFile(packageJson)?.gitmoji) {
+        return getFile(packageJson)?.gitmoji
+      }
+
+      if (pathExistsSync(configurationFile) && getFile(configurationFile)) {
+        return getFile(configurationFile)
+      }
 
-    if (pathExistsSync(configurationFile) && getFile(configurationFile)) {
-      return getFile(configurationFile)
+      currentDir = dirname(currentDir)
     }
 
     return LOCAL_CONFIGURATION.store

test/utils/configurationVault/getConfiguration.spec.js

@@ -129,6 +129,110 @@ describe('getConfiguration', () => {
       })
     })
 
+    describe('when config exists in parent directory', () => {
+      const originalCwd = process.cwd
+
+      beforeEach(() => {
+        jest.resetModules()
+      })
+
+      beforeAll(() => {
+        process.cwd = jest.fn(() => '/home/user/project/subfolder')
+
+        pathExistsSync.mockImplementation((path) => {
+          return path.includes('/home/user/project/.gitmojirc.json')
+        })
+
+        readFileSync.mockImplementation((path) => {
+          if (path.includes('/home/user/project/.gitmojirc.json')) {
+            return JSON.stringify({ from: 'parent' })
+          }
+          return ''
+        })
+      })
+
+      afterAll(() => {
+        process.cwd = originalCwd
+      })
+
+      it('should load config from parent directory', () => {
+        const configuration = getConfiguration()
+        expect(configuration.get('from')).toEqual('parent')
+      })
+    })
+
+    describe('when config exists in grandparent directory', () => {
+      const originalCwd = process.cwd
+
+      beforeEach(() => {
+        jest.resetModules()
+      })
+
+      beforeAll(() => {
+        process.cwd = jest.fn(() => '/home/user/project/subfolder')
+
+        pathExistsSync.mockImplementation((path) => {
+          return path.includes('/home/user/.gitmojirc.json')
+        })
+
+        readFileSync.mockImplementation((path) => {
+          if (path.includes('/home/user/.gitmojirc.json')) {
+            return JSON.stringify({ from: 'grandparent' })
+          }
+          return ''
+        })
+      })
+
+      afterAll(() => {
+        process.cwd = originalCwd
+      })
+
+      it('should load config from grandparent directory', () => {
+        const configuration = getConfiguration()
+        expect(configuration.get('from')).toEqual('grandparent')
+      })
+    })
+
+    describe('when config exists in current and parent directory', () => {
+      const originalCwd = process.cwd
+
+      beforeEach(() => {
+        jest.resetModules()
+      })
+
+      beforeAll(() => {
+        process.cwd = jest.fn(() => '/home/user/project/subfolder')
+
+        pathExistsSync.mockImplementation((path) => {
+          return (
+            path.includes('/home/user/project/subfolder/.gitmojirc.json') ||
+            path.includes('/home/user/project/.gitmojirc.json')
+          )
+        })
+
+        readFileSync.mockImplementation((path) => {
+          if (path.includes('/home/user/project/subfolder/.gitmojirc.json')) {
+            return JSON.stringify({ from: 'current' })
+          }
+
+          if (path.includes('/home/user/project/.gitmojirc.json')) {
+            return JSON.stringify({ from: 'parent' })
+          }
+
+          return ''
+        })
+      })
+
+      afterAll(() => {
+        process.cwd = originalCwd
+      })
+
+      it('should prefer config from current directory over parent', () => {
+        const configuration = getConfiguration()
+        expect(configuration.get('from')).toEqual('current')
+      })
+    })
+
     describe('when package.json and .gitmojirc are not available', () => {
       beforeAll(() => {
         pathExistsSync.mockReturnValue(false)