feat(baumeister): Enable to define baumeister config in package.json

You are now able to choose to store your settings either in a file called `baumeister.json` (respectively `.baumeister.json`) or in a `baumeister` key in your `package.json` file.
micromata · Feb 20, 2019 · bb7656d · bb7656d
1 parent d455382
commit bb7656d
Show file tree

Hide file tree

Showing 7 changed files with 51 additions and 32 deletions.
diff --git a/app/templates/_package.json b/app/templates/_package.json
@@ -98,6 +98,7 @@
     "cli-error-notifier": "^2.1.0",
     "common-tags": "^1.7.2",
     "copy-webpack-plugin": "^4.5.1",
+    "cosmiconfig": "^5.0.7",
     "cross-env": "^5.1.4",
     "css-loader": "^2.1.0",
     "cssnano": "^4.1.8",

diff --git a/app/templates/build/config.js b/app/templates/build/config.js
@@ -1,14 +1,25 @@
-const configFile = require('../baumeister.json');
+import path from 'path';
+import cosmiconfig from 'cosmiconfig';
+import logSymbols from 'log-symbols';
+import chalk from 'chalk';
 
-/**
- * Boolean flag to set when using handlebars instead of plain HTML files in `src`.
- */
-export const { useHandlebars } = configFile;
+const explorer = cosmiconfig('baumeister', {
+  searchPlaces: ['package.json', '.baumeister.json', 'baumeister.json']
+});
 
-/**
- * Flag for generating banners on on top of dist files (CSS & JS).
- */
-export const { generateBanners } = configFile;
+export const userSettings = explorer.searchSync(path.resolve(__dirname, '../'));
+
+if (userSettings === null) {
+  console.log(
+    logSymbols.error,
+    `${chalk.red.bold('error')} – No Baumeister config found`,
+    '\n\n',
+    chalk.yellow(
+      'Please see the <https://github.com/micromata/Baumeister> for info regarding the configuration file.'
+    )
+  );
+  process.exit(1);
+}
 
 export const mainDirectories = {
   dev: '../server/',

diff --git a/app/templates/build/handlebars.js b/app/templates/build/handlebars.js
@@ -12,7 +12,11 @@ import globby from 'globby';
 import perfy from 'perfy';
 import { stripIndents } from 'common-tags';
 
-import { settings, useHandlebars } from './config';
+import { settings, userSettings } from './config';
+
+const {
+  config: { useHandlebars }
+} = userSettings;
 
 perfy.start('build', false);
 

diff --git a/app/templates/build/webpack/config.entry.js b/app/templates/build/webpack/config.entry.js
@@ -1,18 +1,18 @@
 import path from 'path';
 import globby from 'globby';
-import { settings } from '../config';
+import { settings, userSettings } from '../config';
 
-const configFile = require('../../baumeister.json');
+const { config: userConfig } = userSettings;
 
 export const entry = {
   app: `${path.join(__dirname, '../../', settings.sources.app)}index.js`,
   ...getVendorCSS()
 };
 
 function getVendorCSS() {
-  // Return flattened array of resolved globs from baumeister.json
+  // Return flattened array of resolved globs from Baumeister user config.
   const vendorCSS = [].concat(
-    ...configFile.vendor.bundleCSS.map(glob =>
+    ...userConfig.vendor.bundleCSS.map(glob =>
       globby.sync(`./node_modules/${glob}`)
     )
   );

diff --git a/app/templates/build/webpack/config.module.rules.js b/app/templates/build/webpack/config.module.rules.js
@@ -1,10 +1,10 @@
 import path from 'path';
 import MiniCssExtractPlugin from 'mini-css-extract-plugin';
 
-import { settings } from '../config';
+import { settings, userSettings } from '../config';
 import { isDevMode } from './helpers';
 
-const configFile = require('../../baumeister.json');
+const { config: userConfig } = userSettings;
 
 export const rules = [
   {
@@ -31,7 +31,7 @@ export const rules = [
           sourceMap: isDevMode(),
           config: {
             ctx: {
-              usePurifyCSS: configFile.purifyCSS.usePurifyCSS,
+              usePurifyCSS: userConfig.purifyCSS.usePurifyCSS,
               cssnano: {
                 discardComments: {
                   removeAll: true

diff --git a/app/templates/build/webpack/config.output.js b/app/templates/build/webpack/config.output.js
@@ -1,17 +1,17 @@
 import path from 'path';
-import { mainDirectories } from '../config';
+import { mainDirectories, userSettings } from '../config';
 import { isDevMode } from './helpers';
 
-const configFile = require('../../baumeister.json');
+const { config: userConfig } = userSettings;
 
 export const output = {
   path: isDevMode()
     ? path.join(__dirname, '../', mainDirectories.dev)
     : path.join(__dirname, '../', mainDirectories.prod),
-  filename: configFile.cacheBusting
+  filename: userConfig.cacheBusting
     ? 'app/[name].[chunkhash].bundle.js'
     : 'app/[name].bundle.js',
-  chunkFilename: configFile.cacheBusting
+  chunkFilename: userConfig.cacheBusting
     ? 'app/[name].[chunkhash].bundle.js'
     : 'app/[name].bundle.js',
   publicPath: '/'

diff --git a/app/templates/build/webpack/config.plugins.js b/app/templates/build/webpack/config.plugins.js
@@ -8,17 +8,18 @@ import PurifyCSSPlugin from 'purifycss-webpack';
 import ImageminPlugin from 'imagemin-webpack-plugin';
 import MiniCssExtractPlugin from 'mini-css-extract-plugin';
 
-import { generateBanners, settings, useHandlebars } from '../config';
+import { settings, userSettings } from '../config';
 import { isDevMode, isProdMode } from './helpers';
 
 const pkg = require('../../package.json');
-const configFile = require('../../baumeister.json');
+
+const { config: userConfig } = userSettings;
 
 const manifest = new WebpackAssetsManifest({
   output: path.resolve('.webpack-assets.json')
 });
 
-const copyVendorFiles = configFile.vendor.includeStaticFiles.map(glob => {
+const copyVendorFiles = userConfig.vendor.includeStaticFiles.map(glob => {
   return {
     from: glob,
     context: 'node_modules',
@@ -31,7 +32,7 @@ const purifyCSSOptions = {
   purifyOptions: {
     minify: true,
     cleanCssOptions: { level: { 1: { specialComments: 0 } } },
-    whitelist: configFile.purifyCSS.whitelist
+    whitelist: userConfig.purifyCSS.whitelist
   }
 };
 
@@ -42,15 +43,17 @@ const generalPlugins = [
   manifest,
   new MiniCssExtractPlugin({
     filename:
-      configFile.cacheBusting && isProdMode()
+      userConfig.cacheBusting && isProdMode()
         ? 'assets/css/[name].[chunkhash].bundle.css'
         : 'assets/css/[name].bundle.css'
   }),
-  new webpack.ProvidePlugin({ ...configFile.webpack.ProvidePlugin }),
+  new webpack.ProvidePlugin({ ...userConfig.webpack.ProvidePlugin }),
   new CopyWebpackPlugin([
     {
       from: '**/*.html',
-      context: useHandlebars ? settings.destinations.handlebars : './src',
+      context: userConfig.useHandlebars
+        ? settings.destinations.handlebars
+        : './src',
       transform(content) {
         return content
           .toString()
@@ -75,8 +78,8 @@ const generalPlugins = [
   ]),
   new webpack.DefinePlugin(
     isDevMode()
-      ? { ...configFile.webpack.DefinePlugin.development }
-      : { ...configFile.webpack.DefinePlugin.production }
+      ? { ...userConfig.webpack.DefinePlugin.development }
+      : { ...userConfig.webpack.DefinePlugin.production }
   )
 ];
 
@@ -91,10 +94,10 @@ const devPlugins = [];
 const prodPlugins = [
   new webpack.HashedModuleIdsPlugin(),
   new ImageminPlugin({ test: /\.(jpe?g|png|gif|svg)$/i }),
-  configFile.purifyCSS.usePurifyCSS
+  userConfig.purifyCSS.usePurifyCSS
     ? new PurifyCSSPlugin(purifyCSSOptions)
     : false,
-  generateBanners
+  userConfig.generateBanners
     ? new webpack.BannerPlugin({
         banner: stripIndents`${pkg.title} - v${pkg.version}
 		${pkg.author.email}