Merge pull request #1090 from maizzle/refactor-config

src/commands/serve.js

@@ -149,9 +149,12 @@ const serve = async (env = 'local', config = {}) => {
 
   // Watch for changes in config files
   browsersync()
-    .watch('config*.js')
+    .watch('{maizzle.config*,config*}.{js,cjs}')
     .on('change', async file => {
-      const parsedEnv = path.parse(file).name.split('.')[1] || 'local'
+      const fileName = path.parse(file).base
+      const match = fileName.match(/\.?config\.(.+?)\./)
+
+      const parsedEnv = match ? match[1] : env || 'local'
 
       Config
         .getMerged(parsedEnv)
@@ -180,7 +183,13 @@ const serve = async (env = 'local', config = {}) => {
           },
           tunnel: false,
           ui: {port: 3001},
-          logFileChanges: false
+          logFileChanges: false,
+          watchOptions: {
+            awaitWriteFinish: {
+              stabilityThreshold: 150,
+              pollInterval: 25
+            }
+          }
         },
         get(config, 'build.browsersync', {})
       ), () => {})

src/generators/config.js

@@ -1,6 +1,17 @@
 const path = require('path')
 const {merge, requireUncached} = require('../utils/helpers')
 
+const baseConfigFileNames = [
+  './maizzle.config.js',
+  './maizzle.config.cjs',
+  './maizzle.config.local.js',
+  './maizzle.config.local.cjs',
+  './config.js',
+  './config.cjs',
+  './config.local.js',
+  './config.local.cjs'
+]
+
 module.exports = {
   getMerged: async (env = 'local') => {
     if (typeof env !== 'string') {
@@ -10,17 +21,19 @@ module.exports = {
     let baseConfig = {env}
     let envConfig = {env}
 
-    const cwd = env === 'maizzle-ci' ? './test/stubs/config' : process.cwd()
+    const cwd = ['maizzle-ci', 'test'].includes(env) ? './test/stubs/config' : process.cwd()
 
-    for (const module of ['./config', './config.cjs', './config.local', './config.local.cjs']) {
+    for (const module of baseConfigFileNames) {
       try {
         baseConfig = merge(baseConfig, requireUncached(path.resolve(cwd, module)))
       } catch {}
     }
 
-    if (typeof env === 'string' && env !== 'local') {
+    if (env !== 'local') {
       let loaded = false
-      for (const module of [`./config.${env}`, `./config.${env}.cjs`]) {
+      const modulesToTry = [`./maizzle.config.${env}.js`, `./maizzle.config.${env}.cjs`, `./config.${env}.js`, `./config.${env}.cjs`]
+
+      for (const module of modulesToTry) {
         try {
           envConfig = merge(envConfig, requireUncached(path.resolve(cwd, module)))
           loaded = true
@@ -29,7 +42,7 @@ module.exports = {
       }
 
       if (!loaded) {
-        throw new Error(`could not load config.${env}.js`)
+        throw new Error(`Failed to load config file for \`${env}\` environment, do you have one of these files in your project root?\n\n${modulesToTry.join('\n')}`)
       }
     }
 

test/stubs/config/maizzle.config.test.js

@@ -0,0 +1,11 @@
+module.exports = {
+  file: 'maizzle.config.test.js',
+  build: {
+    templates: {
+      source: '../templates',
+      destination: {
+        path: 'build_test'
+      }
+    }
+  }
+}

test/test-config.js

@@ -15,5 +15,10 @@ test('throws if env name is not a string', async t => {
 test('throws if a config could not be loaded for the specified environment', async t => {
   await t.throwsAsync(async () => {
     await Config.getMerged('fake')
-  }, {instanceOf: Error, message: `could not load config.fake.js`})
+  }, {instanceOf: Error, message: `Failed to load config file for \`fake\` environment, do you have one of these files in your project root?\n\n./maizzle.config.fake.js\n./maizzle.config.fake.cjs\n./config.fake.js\n./config.fake.cjs`})
+})
+
+test('supports maizzle.config.js file names', async t => {
+  const config = await Config.getMerged('test')
+  t.is(config.file, 'maizzle.config.test.js')
 })

test/test-todisk.js

@@ -17,7 +17,7 @@ test.afterEach.always(async t => {
 test('throws if config cannot be computed', async t => {
   await t.throwsAsync(async () => {
     await Maizzle.build('missing')
-  }, {instanceOf: Error, message: `could not load config.missing.js`})
+  }, {instanceOf: Error})
 })
 
 test('skips if no templates found', async t => {