@maizzle/framework 4.0.0-alpha.1 → 4.0.0-alpha.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@maizzle/framework",
-  "version": "4.0.0-alpha.1",
+  "version": "4.0.0-alpha.2",
   "description": "Maizzle is a framework that helps you quickly build HTML emails with Tailwind CSS.",
   "license": "MIT",
   "main": "src/index.js",
@@ -56,9 +56,9 @@
     "posthtml-extend": "^0.6.0",
     "posthtml-extra-attributes": "^1.0.0",
     "posthtml-fetch": "^2.0.0",
-    "posthtml-markdownit": "^1.2.2",
+    "posthtml-markdownit": "^1.3.0",
     "posthtml-modules": "^0.8.0",
-    "posthtml-mso": "^1.0.2",
+    "posthtml-mso": "^1.0.4",
     "posthtml-postcss-merge-longhand": "^1.0.2",
     "posthtml-remove-attributes": "^1.0.0",
     "posthtml-safe-class-names": "^1.0.4",
@@ -67,8 +67,7 @@
     "prevent-widows": "^1.0.2",
     "query-string": "^7.1.0",
     "string-strip-html": "^8.2.0",
-    "tailwindcss": "^3.0.0",
-    "tailwindcss-box-shadow": "^1.0.0"
+    "tailwindcss": "^3.0.0"
   },
   "devDependencies": {
     "ava": "^4.0.1",

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

@@ -46,19 +46,24 @@ module.exports = async (env, spinner, config) => {
      *
      *  */
     const templateSource = []
+    const templateTypeErrorMessage = 'Invalid template source: expected string or array of strings, got '
 
     if (typeof templateConfig.source === 'function') {
-      const sources = templateConfig.source()
+      const sources = templateConfig.source(config)
       if (Array.isArray(sources)) {
         templateSource.push(...sources)
-      } else {
+      } else if (typeof sources === 'string') {
         templateSource.push(sources)
+      } else {
+        throw new TypeError(templateTypeErrorMessage + typeof sources)
       }
     } else {
       if (Array.isArray(templateConfig.source)) {
         templateSource.push(...templateConfig.source)
-      } else {
+      } else if (typeof templateConfig.source === 'string') {
         templateSource.push(templateConfig.source)
+      } else {
+        throw new TypeError(templateTypeErrorMessage + typeof templateConfig.source)
       }
     }
 

package/src/generators/tailwindcss.js

@@ -38,22 +38,7 @@ module.exports = {
           './src/**/*.*',
           {raw: html, extension: 'html'}
         ]
-      },
-      corePlugins: {
-        preflight: false,
-        animation: false,
-        backgroundOpacity: false,
-        borderOpacity: false,
-        boxShadow: false,
-        divideOpacity: false,
-        placeholderOpacity: false,
-        ringColor: false,
-        ringWidth: false,
-        ringOpacity: false,
-        ringOffsetColor: false,
-        textOpacity: false
-      },
-      plugins: []
+      }
     }, userConfig())
 
     // Add back the `{raw: html}` option if user provided own config
@@ -75,23 +60,30 @@ module.exports = {
       const templateSources = templateObjects.map(template => {
         const source = get(template, 'source')
 
+        if (typeof source === 'function') {
+          const sources = source(maizzleConfig)
+
+          if (Array.isArray(sources)) {
+            sources.map(s => config.content.files.push(s))
+          } else if (typeof sources === 'string') {
+            config.content.files.push(sources)
+          }
+
+          // Must return a valid `content` entry
+          return {raw: '', extension: 'html'}
+        }
+
         return `${source}/**/*.*`
       })
 
       config.content.files.push(...templateSources)
     }
 
-    // Merge user's Tailwind plugins with our default ones
-    config.plugins = [
-      ...config.plugins,
-      require('tailwindcss-box-shadow')
-    ]
-
     const userFilePath = get(maizzleConfig, 'build.tailwind.css', path.join(process.cwd(), 'src/css/tailwind.css'))
     const userFileExists = await fs.pathExists(userFilePath)
 
     if (userFileExists) {
-      css = await fs.readFile(path.resolve(userFilePath), 'utf8')
+      css = await fs.readFile(path.resolve(userFilePath), 'utf8') + css
     }
 
     return postcss([

package/src/transformers/baseUrl.js

@@ -8,11 +8,11 @@ const rewriteVMLs = (html, url) => {
   const vImageMatch = html.match(/(<v:image.+)(src=['"]([^'"]+)['"])/)
   const vFillMatch = html.match(/(<v:fill.+)(src=['"]([^'"]+)['"])/)
 
-  if (!isUrl(vImageMatch[3])) {
+  if (vImageMatch && !isUrl(vImageMatch[3])) {
     html = html.replace(vImageMatch[0], `${vImageMatch[1]}src="${url}${vImageMatch[3]}"`)
   }
 
-  if (!isUrl(vFillMatch[3])) {
+  if (vFillMatch && !isUrl(vFillMatch[3])) {
     html = html.replace(vFillMatch[0], `${vFillMatch[1]}src="${url}${vFillMatch[3]}"`)
   }
 

package/src/transformers/index.js

@@ -1,57 +1,57 @@
-const inline = require('./inlineCss')
-const minify = require('./minify')
-const markdown = require('./markdown')
-const prettify = require('./prettify')
-const ensureSixHEX = require('./sixHex')
-const applyBaseImageUrl = require('./baseUrl')
-const addURLParams = require('./urlParameters')
-const transformContents = require('./transform')
-const preventWidows = require('./preventWidows')
-const replaceStrings = require('./replaceStrings')
-const safeClassNames = require('./safeClassNames')
-const removeUnusedCSS = require('./removeUnusedCss')
-const removeAttributes = require('./removeAttributes')
-const attributeToStyle = require('./attributeToStyle')
-const removeInlineSizes = require('./removeInlineSizes')
-const applyExtraAttributes = require('./extraAttributes')
-const removeInlineBgColor = require('./removeInlineBackgroundColor')
-
-exports.process = async (html, config) => {
-  html = await safeClassNames(html, config)
-  html = await transformContents(html, config)
-  html = await markdown(html, config)
-  html = await preventWidows(html, config)
-  html = await attributeToStyle(html, config)
-  html = await inline(html, config)
-  html = await removeUnusedCSS(html, config)
-  html = await removeInlineSizes(html, config)
-  html = await removeInlineBgColor(html, config)
-  html = await removeAttributes(html, config)
-  html = await applyExtraAttributes(html, config)
-  html = await applyBaseImageUrl(html, config)
-  html = await addURLParams(html, config)
-  html = await ensureSixHEX(html, config)
-  html = await prettify(html, config)
-  html = await minify(html, config)
-  html = await replaceStrings(html, config)
-
-  return html
-}
-
-exports.inlineCSS = (html, config) => inline(html, config, true)
-exports.minify = (html, config) => minify(html, config, true)
-exports.markdown = (html, config) => markdown(html, config, true)
-exports.prettify = (html, config) => prettify(html, config, true)
-exports.ensureSixHEX = (html, config) => ensureSixHEX(html, config)
-exports.addURLParams = (html, config) => addURLParams(html, config, true)
-exports.transformContents = (html, config) => transformContents(html, config, true)
-exports.preventWidows = (html, config) => preventWidows(html, config, true)
-exports.replaceStrings = (html, config) => replaceStrings(html, config, true)
-exports.safeClassNames = (html, config) => safeClassNames(html, config, true)
-exports.applyBaseImageUrl = (html, config) => applyBaseImageUrl(html, config, true)
-exports.removeUnusedCSS = (html, config) => removeUnusedCSS(html, config, true)
-exports.removeAttributes = (html, config) => removeAttributes(html, config, true)
-exports.removeInlineSizes = (html, config) => removeInlineSizes(html, config, true)
-exports.applyExtraAttributes = (html, config) => applyExtraAttributes(html, config, true)
-exports.removeInlineBgColor = (html, config) => removeInlineBgColor(html, config, true)
-exports.attributeToStyle = (html, config) => attributeToStyle(html, config, true)
+const inline = require('./inlineCss')
+const minify = require('./minify')
+const markdown = require('./markdown')
+const prettify = require('./prettify')
+const ensureSixHEX = require('./sixHex')
+const applyBaseImageUrl = require('./baseUrl')
+const addURLParams = require('./urlParameters')
+const transformContents = require('./transform')
+const preventWidows = require('./preventWidows')
+const replaceStrings = require('./replaceStrings')
+const safeClassNames = require('./safeClassNames')
+const removeUnusedCSS = require('./removeUnusedCss')
+const removeAttributes = require('./removeAttributes')
+const attributeToStyle = require('./attributeToStyle')
+const removeInlineSizes = require('./removeInlineSizes')
+const applyExtraAttributes = require('./extraAttributes')
+const removeInlineBgColor = require('./removeInlineBackgroundColor')
+
+exports.process = async (html, config) => {
+  html = await safeClassNames(html, config)
+  html = await transformContents(html, config)
+  html = await markdown(html, config)
+  html = await preventWidows(html, config)
+  html = await attributeToStyle(html, config)
+  html = await inline(html, config)
+  html = await removeUnusedCSS(html, config)
+  html = await removeInlineSizes(html, config)
+  html = await removeInlineBgColor(html, config)
+  html = await removeAttributes(html, config)
+  html = await applyExtraAttributes(html, config)
+  html = await applyBaseImageUrl(html, config)
+  html = await addURLParams(html, config)
+  html = await ensureSixHEX(html, config)
+  html = await prettify(html, config)
+  html = await minify(html, config)
+  html = await replaceStrings(html, config)
+
+  return html
+}
+
+exports.inlineCSS = (html, config) => inline(html, config, true)
+exports.minify = (html, config) => minify(html, config, true)
+exports.markdown = (html, config) => markdown(html, config, true)
+exports.prettify = (html, config) => prettify(html, config, true)
+exports.ensureSixHEX = (html, config) => ensureSixHEX(html, config)
+exports.addURLParams = (html, config) => addURLParams(html, config, true)
+exports.transformContents = (html, config) => transformContents(html, config, true)
+exports.preventWidows = (html, config) => preventWidows(html, config, true)
+exports.replaceStrings = (html, config) => replaceStrings(html, config, true)
+exports.safeClassNames = (html, config) => safeClassNames(html, config, true)
+exports.applyBaseImageUrl = (html, config) => applyBaseImageUrl(html, config, true)
+exports.removeUnusedCSS = (html, config) => removeUnusedCSS(html, config, true)
+exports.removeAttributes = (html, config) => removeAttributes(html, config, true)
+exports.removeInlineSizes = (html, config) => removeInlineSizes(html, config, true)
+exports.applyExtraAttributes = (html, config) => applyExtraAttributes(html, config, true)
+exports.removeInlineBgColor = (html, config) => removeInlineBgColor(html, config, true)
+exports.attributeToStyle = (html, config) => attributeToStyle(html, config, true)

package/test/test-todisk.js

@@ -446,8 +446,11 @@ test('works with templates.source defined as function (array paths)', async t =>
   const {files} = await Maizzle.build('maizzle-ci', {
     build: {
       fail: 'silent',
+      customSources: ['test/stubs/templates', 'test/stubs/templates'],
       templates: {
-        source: () => ['test/stubs/templates', 'test/stubs/templates'],
+        source: config => {
+          return config.build.customSources
+        },
         destination: {
           path: t.context.folder
         }
@@ -458,3 +461,35 @@ test('works with templates.source defined as function (array paths)', async t =>
   t.true(fs.pathExistsSync(t.context.folder))
   t.is(files.length, 3)
 })
+
+test('throws if templates path is invalid', async t => {
+  await t.throwsAsync(async () => {
+    await Maizzle.build('maizzle-ci', {
+      build: {
+        fail: 'silent',
+        templates: {
+          source: false,
+          destination: {
+            path: t.context.folder
+          }
+        }
+      }
+    })
+  }, {instanceOf: TypeError})
+})
+
+test('throws if templates path is invalid (function)', async t => {
+  await t.throwsAsync(async () => {
+    await Maizzle.build('maizzle-ci', {
+      build: {
+        fail: 'silent',
+        templates: {
+          source: () => {},
+          destination: {
+            path: t.context.folder
+          }
+        }
+      }
+    })
+  }, {instanceOf: TypeError})
+})