@maizzle/framework 4.4.0-beta.5 → 4.4.0-beta.7

package/README.md

@@ -34,9 +34,9 @@ The Maizzle framework is open-sourced software licensed under the [MIT license](
 
 [npm]: https://www.npmjs.com/package/@maizzle/framework
 [npm-stats]: https://npm-stat.com/charts.html?package=%40maizzle%2Fframework&from=2019-03-27
-[npm-version-shield]: https://img.shields.io/npm/v/@maizzle/framework.svg?style=flat-square
-[npm-stats-shield]: https://img.shields.io/npm/dt/@maizzle/framework.svg?style=flat-square&color=4f46e5
+[npm-version-shield]: https://img.shields.io/npm/v/@maizzle/framework.svg
+[npm-stats-shield]: https://img.shields.io/npm/dt/@maizzle/framework.svg?color=4f46e5
 [github-ci]: https://github.com/maizzle/framework/actions
-[github-ci-shield]: https://img.shields.io/github/workflow/status/maizzle/framework/Node.js%20CI?style=flat-square
+[github-ci-shield]: https://github.com/maizzle/framework/actions/workflows/nodejs.yml/badge.svg
 [license]: ./LICENSE
-[license-shield]: https://img.shields.io/npm/l/@maizzle/framework.svg?style=flat-square&color=0e9f6e
+[license-shield]: https://img.shields.io/npm/l/@maizzle/framework.svg?color=0e9f6e

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@maizzle/framework",
-  "version": "4.4.0-beta.5",
+  "version": "4.4.0-beta.7",
   "description": "Maizzle is a framework that helps you quickly build HTML emails with Tailwind CSS.",
   "license": "MIT",
   "main": "src/index.js",
@@ -42,7 +42,7 @@
   "dependencies": {
     "@maizzle/cli": "^1.5.1",
     "autoprefixer": "^10.4.13",
-    "browser-sync": "^2.26.13",
+    "browser-sync": "^2.27.11",
     "color-shorthand-hex-to-six-digit": "^3.0.2",
     "email-comb": "^5.2.0",
     "front-matter": "^4.0.0",
@@ -53,7 +53,7 @@
     "juice": "^8.0.0",
     "lodash": "^4.17.20",
     "ora": "^5.1.0",
-    "postcss": "^8.4.19",
+    "postcss": "^8.4.21",
     "postcss-import": "^15.0.0",
     "postcss-merge-longhand": "^5.1.7",
     "posthtml": "^0.16.6",
@@ -64,20 +64,20 @@
     "posthtml-extend": "^0.6.0",
     "posthtml-extra-attributes": "^1.0.0",
     "posthtml-fetch": "^2.2.0",
-    "posthtml-markdownit": "^1.3.0",
+    "posthtml-markdownit": "^1.3.1",
     "posthtml-match-helper": "^1.0.3",
     "posthtml-mso": "^1.0.4",
     "posthtml-postcss-merge-longhand": "^1.0.2",
     "posthtml-safe-class-names": "^2.0.0",
     "posthtml-url-parameters": "^1.0.4",
     "pretty": "^2.0.0",
-    "query-string": "^7.1.0",
+    "query-string": "^7.1.3",
     "string-remove-widows": "^2.1.0",
     "string-strip-html": "^8.2.0",
     "tailwindcss": "^3.2.4"
   },
   "devDependencies": {
-    "ava": "^5.1.0",
+    "ava": "^5.1.1",
     "c8": "^7.11.0",
     "np": "*",
     "xo": "0.39.1"

package/src/commands/serve.js

@@ -9,6 +9,10 @@ const renderToString = require('../functions/render')
 const {get, merge, isObject} = require('lodash')
 const {clearConsole} = require('../utils/helpers')
 
+/**
+ * Initialize Browsersync on-demand
+ * https://github.com/maizzle/framework/issues/605
+ */
 const browsersync = () => {
   if (!global.cachedBrowserSync) {
     const bs = require('browser-sync')
@@ -18,16 +22,17 @@ const browsersync = () => {
   return global.cachedBrowserSync
 }
 
+const getConfig = async (env = 'local', config = {}) => merge(
+  config,
+  await Config.getMerged(env)
+)
+
 const serve = async (env = 'local', config = {}) => {
-  config = merge(
-    config,
-    await Config.getMerged(env),
-    {
-      build: {
-        command: 'serve'
-      }
+  config = await getConfig(env, merge(config, {
+    build: {
+      command: 'serve'
     }
-  )
+  }))
 
   const spinner = ora()
 
@@ -43,14 +48,17 @@ const serve = async (env = 'local', config = {}) => {
       'src/**',
       ...new Set(get(config, 'build.browsersync.watch', []))
     ]
+
     if (typeof tailwindConfig === 'string') {
-      globalPaths.push(tailwindConfig);
+      globalPaths.push(tailwindConfig)
     }
 
     // Watch for Template file changes
     browsersync()
       .watch(templatePaths)
       .on('change', async file => {
+        config = await getConfig(env, config)
+
         if (config.events && typeof config.events.beforeCreate === 'function') {
           await config.events.beforeCreate(config)
         }

package/src/generators/config.js

@@ -13,16 +13,23 @@ module.exports = {
 
     const cwd = env === 'maizzle-ci' ? './test/stubs/config' : process.cwd()
 
-    for (const module of ['./config', './config.local']) {
+    for (const module of ['./config', './config.cjs', './config.local', './config.local.cjs']) {
       try {
         baseConfig = merge(baseConfig, requireUncached(path.resolve(cwd, module)))
       } catch {}
     }
 
     if (typeof env === 'string' && env !== 'local') {
-      try {
-        envConfig = merge(envConfig, requireUncached(path.resolve(cwd, `./config.${env}`)))
-      } catch {
+      let loaded = false
+      for (const module of [`./config.${env}`, `./config.${env}.cjs`]) {
+        try {
+          envConfig = merge(envConfig, requireUncached(path.resolve(cwd, module)))
+          loaded = true
+          break
+        } catch {}
+      }
+
+      if (!loaded) {
         throw new Error(`could not load config.${env}.js`)
       }
     }

package/src/generators/output/to-disk.js

@@ -32,6 +32,11 @@ module.exports = async (env, spinner, config) => {
 
   // Parse each template config object
   await asyncForEach(templatesConfig, async templateConfig => {
+    if (!templateConfig) {
+      const configFileName = env === 'local' ? 'config.js' : `config.${env}.js`
+      throw new Error(`No template sources defined in \`build.templates\`, check your ${configFileName} file`)
+    }
+
     const outputDir = get(templateConfig, 'destination.path', `build_${env}`)
 
     await fs.remove(outputDir)
@@ -134,7 +139,7 @@ module.exports = async (env, spinner, config) => {
                 ...config.events
               })
 
-              const destination = config.permalink || file
+              const destination = get(compiled, 'config.permalink', file)
 
               /**
                * Generate plaintext
@@ -145,7 +150,7 @@ module.exports = async (env, spinner, config) => {
 
               // Check if plaintext: true globally, fallback to template's front matter
               const plaintextConfig = get(templateConfig, 'plaintext', get(compiled.config, 'plaintext', false))
-              const plaintextPath = get(plaintextConfig, 'destination.path', config.permalink || file)
+              const plaintextPath = get(plaintextConfig, 'destination.path', destination)
 
               if (Boolean(plaintextConfig) || !isEmpty(plaintextConfig)) {
                 await Plaintext

package/src/transformers/baseUrl.js

@@ -23,7 +23,11 @@ module.exports = async (html, config = {}, direct = false) => {
   if (isObject(url) && !isEmpty(url)) {
     html = rewriteVMLs(html, get(url, 'url', ''))
 
-    return posthtml([baseUrl(url)]).process(html, posthtmlOptions).then(result => result.html)
+    return posthtml([
+      baseUrl(merge({styleTag: true, inlineCss: true}, url))
+    ])
+      .process(html, posthtmlOptions)
+      .then(result => result.html)
   }
 
   return html