feat: add cacheDefaults

Author: jakobrosenberg

configent.js

@@ -1,10 +1,12 @@
 const { existsSync, readdirSync } = require('fs')
 const { resolve } = require('path')
 let instances = {}
+let detectedFromDefaults = {}
 
 const _defaults = {
     name: '',
     cacheConfig: true,
+    cacheDetectedDefaults: true,
     useDotEnv: true,
     useEnv: true,
     usePackageConfig: true,
@@ -21,6 +23,7 @@ const _defaults = {
  * @param {object} [configentOptions] configent options
  * @param {string=} [configentOptions.name = ''] name to use for configs. If left empty, name from package.json is used
  * @param {boolean=} [configentOptions.cacheConfig = true] calling configent twice with same parameters will return the same instance
+ * @param {boolean=} [configentOptions.cacheDetectedDefaults = true] calling configent twice from the same module will return the same defaults
  * @param {boolean=} [configentOptions.useDotEnv = true] include config from .env files
  * @param {boolean=} [configentOptions.useEnv = true] include config from process.env
  * @param {boolean=} [configentOptions.usePackageConfig = true] include config from package.json
@@ -36,6 +39,7 @@ function configent(defaults, input = {}, configentOptions) {
     const {
         name,
         cacheConfig,
+        cacheDetectedDefaults,
         useDotEnv,
         sanitizeEnvValue,
         useConfig,
@@ -92,24 +96,30 @@ function configent(defaults, input = {}, configentOptions) {
     }
 
     function getDetectDefaults() {
-        const pkgjson = { dependencies: {}, devDependencies: {} };
-        if (existsSync('package.json')) {
-            Object.assign(pkgjson, require(resolve(process.cwd(), 'package.json')));
-        }
-
-        Object.assign(pkgjson.dependencies, pkgjson.devDependencies)
-
-        const unsortedConfigTemplates = readdirSync(resolve(module['parent'].path, detectDefaultsConfigPath))
+        const hash = JSON.stringify({ name, path: module['parent'].path })
+        
+        // we only want to detect the defaults for any given module once
+        if(!detectedFromDefaults[hash] || !cacheDetectedDefaults){
+            const pkgjson = { dependencies: {}, devDependencies: {} };
+            if (existsSync('package.json')) {
+                Object.assign(pkgjson, require(resolve(process.cwd(), 'package.json')));
+            }
+            
+            Object.assign(pkgjson.dependencies, pkgjson.devDependencies)
+            
+            const unsortedConfigTemplates = readdirSync(resolve(module['parent'].path, detectDefaultsConfigPath))
             .map(file => ({
                 file,
                 ...require(resolve(module['parent'].path, detectDefaultsConfigPath, file))
             }))
-        const configTemplates = sortBySupersedings(unsortedConfigTemplates)
-        const configTemplate = configTemplates.find(configTemplate => configTemplate.condition({ pkgjson }))
-        if (configTemplate) {
-            console.log(`${name} found config for ${configTemplate.name}`)
-            return configTemplate.config()
+            const configTemplates = sortBySupersedings(unsortedConfigTemplates)
+            const configTemplate = configTemplates.find(configTemplate => configTemplate.condition({ pkgjson }))
+            if (configTemplate) {
+                console.log(`${name} found config for ${configTemplate.name}`)
+                detectedFromDefaults[hash] = configTemplate.config()
+            }
         }
+        return detectedFromDefaults[hash]
     }
 }
 

test/context-configs/context.spec.js

@@ -5,7 +5,8 @@ process.chdir(__dirname) //change cwd to __dirname
 const defaults = { fromContext: false }
 const configentOptions = {
     useDetectDefaults: true,
-    cacheConfig: false
+    cacheConfig: false,
+    cacheDetectedDefaults: false
 }
 
 test('if no context is found, defaults are unchanged', async t => {
@@ -14,25 +15,25 @@ test('if no context is found, defaults are unchanged', async t => {
 })
 
 test('if context is found, it sets defaults', async t => {
-    process.env.USE_BASIC = true
+    process.env.USE_BASIC = "1"
     const result = configent(defaults, {}, configentOptions)
     t.deepEqual(result, { fromContext: 'basic' })
 })
 
 test('if multiple contexts are found, superseder wins', async t => {
-    process.env.USE_SUPERSEDER = true
+    process.env.USE_SUPERSEDER = "1"
     const result = configent(defaults, {}, configentOptions)
     t.deepEqual(result, { fromContext: 'superseder' })
 })
 
 test('can read package.json from cwd', async t => {
-    process.env.USE_PKGJSON = true
+    process.env.USE_PKGJSON = "1"
     const result = configent(defaults, {}, configentOptions)
     t.deepEqual(result, { fromContext: 'usepkgjson' })
 })
 
 test('circular tests create error', async t => {
-    process.env.USE_CIRCULAR = true
+    process.env.USE_CIRCULAR = "1"
     const result = configent(defaults, {}, configentOptions)
     t.deepEqual(result, { fromContext: 'usepkgjson' })
 })