@maizzle/framework 3.7.2 → 4.0.0-alpha.10

package/src/generators/tailwindcss.js

@@ -1,84 +1,116 @@
-const path = require('path')
-const fs = require('fs-extra')
-const postcss = require('postcss')
-const tailwindcss = require('tailwindcss')
-const postcssImport = require('postcss-import')
-const postcssNested = require('tailwindcss/nesting')
-const {requireUncached} = require('../utils/helpers')
-const mergeLonghand = require('postcss-merge-longhand')
-const {get, isObject, isEmpty, merge} = require('lodash')
-
-module.exports = {
-  compile: async (css = '', html = '', tailwindConfig = {}, maizzleConfig = {}) => {
-    tailwindConfig = (isObject(tailwindConfig) && !isEmpty(tailwindConfig)) ? tailwindConfig : get(maizzleConfig, 'build.tailwind.config', 'tailwind.config.js')
-
-    // Compute the Tailwind config to use
-    const userConfig = () => {
-      // If a custom config object was passed, use that
-      if (isObject(tailwindConfig) && !isEmpty(tailwindConfig)) {
-        return tailwindConfig
-      }
-
-      /**
-       * Try loading a fresh tailwind.config.js, with fallback to an empty object.
-       * This will use the default Tailwind config (with rem units etc)
-       */
-      try {
-        return requireUncached(path.resolve(process.cwd(), tailwindConfig))
-      } catch {
-        return {}
-      }
-    }
-
-    // Merge user's Tailwind config on top of a 'base' config
-    const config = merge({
-      important: true,
-      purge: {
-        enabled: maizzleConfig.env !== 'local',
-        content: [
-          'src/**/*.*',
-          {raw: html}
-        ],
-        options: get(maizzleConfig, 'purgeCSS', {})
-      },
-      corePlugins: {
-        animation: false,
-        backgroundOpacity: false,
-        borderOpacity: false,
-        boxShadow: false,
-        divideOpacity: false,
-        placeholderOpacity: false,
-        ringColor: false,
-        ringWidth: false,
-        ringOpacity: false,
-        ringOffsetColor: false,
-        textOpacity: false
-      },
-      plugins: []
-    }, userConfig())
-
-    // Merge user's Tailwind plugins with our default ones
-    config.plugins.push(require('tailwindcss-box-shadow'))
-
-    const userFilePath = get(maizzleConfig, 'build.tailwind.css', path.join(process.cwd(), 'src/css/tailwind.css'))
-
-    css = await fs.pathExists(userFilePath).then(async exists => {
-      if (exists) {
-        const userFileCSS = await fs.readFile(path.resolve(userFilePath), 'utf8')
-        return userFileCSS
-      }
-
-      return css
-    })
-
-    return postcss([
-      postcssImport({path: userFilePath ? path.dirname(userFilePath) : []}),
-      postcssNested(),
-      tailwindcss(config),
-      maizzleConfig.env === 'local' ? () => {} : mergeLonghand(),
-      ...get(maizzleConfig, 'build.postcss.plugins', [])
-    ])
-      .process(css, {from: undefined})
-      .then(result => result.css)
-  }
-}
+const path = require('path')
+const fs = require('fs-extra')
+const postcss = require('postcss')
+const tailwindcss = require('tailwindcss')
+const postcssImport = require('postcss-import')
+const postcssNested = require('tailwindcss/nesting')
+const {requireUncached} = require('../utils/helpers')
+const mergeLonghand = require('postcss-merge-longhand')
+const {get, isObject, isEmpty, merge} = require('lodash')
+
+module.exports = {
+  compile: async (css = '', html = '', tailwindConfig = {}, maizzleConfig = {}, spinner = null) => {
+    tailwindConfig = (isObject(tailwindConfig) && !isEmpty(tailwindConfig)) ? tailwindConfig : get(maizzleConfig, 'build.tailwind.config', 'tailwind.config.js')
+
+    // Compute the Tailwind config to use
+    const userConfig = () => {
+      // If a custom config object was passed, use that
+      if (isObject(tailwindConfig) && !isEmpty(tailwindConfig)) {
+        return tailwindConfig
+      }
+
+      /**
+       * Try loading a fresh tailwind.config.js, with fallback to an empty object.
+       * This will use the default Tailwind config (with rem units etc)
+       */
+      try {
+        return requireUncached(path.resolve(process.cwd(), tailwindConfig))
+      } catch {
+        return {}
+      }
+    }
+
+    // Merge user's Tailwind config on top of a 'base' config
+    const config = merge({
+      important: true,
+      content: {
+        files: [
+          './src/**/*.*',
+          {raw: html, extension: 'html'}
+        ]
+      }
+    }, userConfig())
+
+    // Add back the `{raw: html}` option if user provided own config
+    if (Array.isArray(config.content)) {
+      config.content = {
+        files: [
+          ...config.content,
+          './src/**/*.*',
+          {raw: html, extension: 'html'}
+        ]
+      }
+    }
+
+    // Include all `build.templates.source` paths when scanning for selectors to preserve
+    const buildTemplates = get(maizzleConfig, 'build.templates')
+
+    if (buildTemplates) {
+      const templateObjects = Array.isArray(buildTemplates) ? buildTemplates : [buildTemplates]
+      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'}
+        }
+
+        // Support single-file sources i.e. src/templates/index.html
+        if (typeof source === 'string' && Boolean(path.extname(source))) {
+          config.content.files.push(source)
+
+          return {raw: '', extension: 'html'}
+        }
+
+        return `${source}/**/*.*`
+      })
+
+      config.content.files.push(...templateSources)
+    }
+
+    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
+    } else {
+      css = `@import "tailwindcss/components"; @import "tailwindcss/utilities"; ${css}`
+    }
+
+    return postcss([
+      postcssImport({path: path.dirname(userFilePath)}),
+      postcssNested(),
+      tailwindcss(config),
+      maizzleConfig.env === 'local' ? () => {} : mergeLonghand(),
+      ...get(maizzleConfig, 'build.postcss.plugins', [])
+    ])
+      .process(css, {from: undefined})
+      .then(result => result.css)
+      .catch(error => {
+        console.error(error)
+        if (spinner) {
+          spinner.stop()
+        }
+
+        throw new Error(`Tailwind CSS compilation failed`)
+      })
+  }
+}

package/src/index.js

@@ -1,163 +1,17 @@
-const ora = require('ora')
-const path = require('path')
-const fs = require('fs-extra')
-const {get, merge} = require('lodash')
-const bs = require('browser-sync').create()
-const Config = require('./generators/config')
-const Output = require('./generators/output')
+const serve = require('./commands/serve')
+const toFile = require('./commands/build')
 const transformers = require('./transformers')
-const {clearConsole} = require('./utils/helpers')
-const Plaintext = require('./generators/plaintext')
-const Tailwind = require('./generators/tailwindcss')
-
-const self = module.exports = { // eslint-disable-line
+const toString = require('./functions/render')
+const PostCSS = require('./generators/postcss')
+const toPlaintext = require('./functions/plaintext')
+const TailwindCSS = require('./generators/tailwindcss')
+
+module.exports = {
+  serve,
+  build: toFile,
   ...transformers,
-  render: async (html, options) => Output.toString(html, options),
-  plaintext: async (html, config = {}) => Plaintext.generate(html, false, config),
-  build: async (env = 'local', config = {}) => {
-    const start = new Date()
-    const spinner = ora('Building emails...').start()
-
-    return Output.toDisk(env, spinner, config)
-      .then(({files, parsed}) => {
-        const elapsedSeconds = (Date.now() - start) / 1000
-
-        if (get(config, 'build.command') === 'serve') {
-          clearConsole()
-          spinner.succeed(`Re-built ${parsed.length} templates in ${elapsedSeconds}s`)
-        } else {
-          spinner.succeed(`Built ${parsed.length} templates in ${elapsedSeconds}s`)
-        }
-
-        return {files}
-      })
-      .catch(error => {
-        throw error
-      })
-  },
-  serve: async (env = 'local', config = {}) => {
-    config = merge(
-      config,
-      await Config.getMerged(env),
-      {
-        build: {
-          command: 'serve'
-        }
-      }
-    )
-
-    await self
-      .build(env, config)
-      .then(async () => {
-        let templates = get(config, 'build.templates')
-        templates = Array.isArray(templates) ? templates : [templates]
-
-        const templatePaths = [...new Set(templates.map(config => `${get(config, 'source', 'src')}/**`))]
-        const globalPaths = [
-          'src/**',
-          get(config, 'build.tailwind.config', 'tailwind.config.js'),
-          [...new Set(get(config, 'build.browsersync.watch', []))]
-        ]
-
-        // Pre-compile Tailwind so that updates to tailwind.config.js are reflected
-        const cssString = fs.existsSync(get(config, 'build.tailwind.css')) ? fs.readFileSync(get(config, 'build.tailwind.css'), 'utf8') : '@tailwind components; @tailwind utilities;'
-        const css = await Tailwind.compile(cssString, '', {}, config)
-
-        const spinner = ora()
-
-        // Watch for Template file changes
-        bs.watch(templatePaths)
-          .on('change', async file => {
-            clearConsole()
-
-            const start = new Date()
-
-            spinner.start('Building email...')
-
-            file = file.replace(/\\/g, '/')
-
-            const destination = get(config, 'build.currentTemplates.destination.path', 'build_local')
-            const extension = get(config, 'build.currentTemplates.destination.extension', 'html')
-            const fileSource = get(config, 'build.currentTemplates.source')
-            const parts = path.parse(path.join(destination, file.replace(fileSource, '')))
-            const finalDestination = path.join(parts.dir, `${parts.name}.${extension}`)
-
-            if (config.events && typeof config.events.beforeCreate === 'function') {
-              await config.events.beforeCreate(config)
-            }
-
-            /**
-             * Tailwind CSS compiler
-             *
-             * Use the Just-In-Time engine if the user enabled it
-             * Fall back to the classic Always-On-Time engine
-             */
-            let mode = 'aot'
-
-            try {
-              const tailwindConfig = require(path.resolve(process.cwd(), get(config, 'build.currentTemplates.tailwind.config', 'tailwind.config.js')))
-              mode = get(tailwindConfig, 'mode')
-            } catch {}
-
-            const renderOptions = {
-              maizzle: config,
-              ...config.events
-            }
-
-            // AOT: fall back to pre-compiled CSS
-            if (mode !== 'jit') {
-              renderOptions.tailwind = {
-                compiled: css
-              }
-            }
-
-            self
-              .render(await fs.readFile(file, 'utf8'), renderOptions)
-              .then(({html, config}) => fs.outputFile(config.permalink || finalDestination, html))
-              .then(() => {
-                bs.reload()
-                spinner.succeed(`Compiled in ${(Date.now() - start) / 1000}s [${file}]`)
-              })
-              .catch(() => spinner.warn(`Received empty HTML, please save your file again [${file}]`))
-          })
-
-        // Watch for changes in all other files
-        bs.watch(globalPaths, {ignored: templatePaths})
-          .on('change', () => self.build(env, config).then(() => bs.reload()))
-          .on('unlink', () => self.build(env, config).then(() => bs.reload()))
-
-        // Watch for changes in config files
-        bs.watch('config*.js')
-          .on('change', async file => {
-            const parsedEnv = path.parse(file).name.split('.')[1] || 'local'
-
-            Config
-              .getMerged(parsedEnv)
-              .then(config => self.build(parsedEnv, config).then(() => bs.reload()))
-          })
-
-        // Browsersync options
-        const baseDir = templates.map(t => t.destination.path)
-
-        const bsOptions = {
-          notify: false,
-          open: false,
-          port: 3000,
-          server: {
-            baseDir,
-            directory: true
-          },
-          tunnel: false,
-          ui: {port: 3001},
-          logFileChanges: false,
-          ...get(config, 'build.browsersync', {})
-        }
-
-        // Initialize Browsersync
-        bs.init(bsOptions, () => {})
-      })
-      .catch(error => {
-        throw error
-      })
-  }
+  render: toString,
+  postcss: PostCSS,
+  plaintext: toPlaintext,
+  tailwindcss: TailwindCSS
 }

package/src/transformers/baseUrl.js

@@ -0,0 +1,69 @@
+const posthtml = require('posthtml')
+const isUrl = require('is-url-superb')
+const baseUrl = require('posthtml-base-url')
+const {get, isObject, isEmpty} = require('lodash')
+
+/**
+ * VML backgrounds must be handled with regex because
+ * they're inside HTML comments.
+ */
+const rewriteVMLs = (html, url) => {
+  // Handle <v:image>
+  const vImageMatches = html.match(/<v:image[^>]+src="?([^"\s]+)"/g)
+
+  if (vImageMatches) {
+    vImageMatches.forEach(match => {
+      const vImage = match.match(/<v:image[^>]+src="?([^"\s]+)"/)
+      const vImageSrc = vImage[1]
+
+      if (!isUrl(vImageSrc)) {
+        const vImageSrcUrl = url + vImageSrc
+        const vImageReplace = vImage[0].replace(vImageSrc, vImageSrcUrl)
+        html = html.replace(vImage[0], vImageReplace)
+      }
+    })
+  }
+
+  // Handle <v:fill>
+  const vFillMatches = html.match(/<v:fill[^>]+src="?([^"\s]+)"/g)
+
+  if (vFillMatches) {
+    vFillMatches.forEach(match => {
+      const vFill = match.match(/<v:fill[^>]+src="?([^"\s]+)"/)
+      const vFillSrc = vFill[1]
+
+      if (!isUrl(vFillSrc)) {
+        const vFillSrcUrl = url + vFillSrc
+        const vFillReplace = vFill[0].replace(vFillSrc, vFillSrcUrl)
+        html = html.replace(vFill[0], vFillReplace)
+      }
+    })
+  }
+
+  return html
+}
+
+module.exports = async (html, config = {}, direct = false) => {
+  const url = direct ? config : get(config, 'baseURL')
+  const posthtmlOptions = get(config, 'build.posthtml.options', {})
+
+  // Handle `baseUrl` as a string
+  if (typeof url === 'string' && url.length > 0) {
+    html = rewriteVMLs(html, url)
+
+    return posthtml([
+      baseUrl({url, allTags: true, styleTag: true, inlineCss: true})
+    ])
+      .process(html, posthtmlOptions)
+      .then(result => result.html)
+  }
+
+  // Handle `baseUrl` as an object
+  if (isObject(url) && !isEmpty(url)) {
+    html = rewriteVMLs(html, url.url)
+
+    return posthtml([baseUrl(url)]).process(html, posthtmlOptions).then(result => result.html)
+  }
+
+  return html
+}

package/src/transformers/filters/defaultFilters.js

@@ -0,0 +1,126 @@
+const escapeMap = {
+  '&': '&',
+  '<': '&lt;',
+  '>': '&gt;',
+  '"': '&#34;',
+  '\'': '&#39;'
+}
+
+const unescapeMap = {
+  '&amp;': '&',
+  '&lt;': '<',
+  '&gt;': '>',
+  '&#34;': '"',
+  '&#39;': '\''
+}
+
+const unescape = string => string.replace(/&(amp|lt|gt|#34|#39);/g, m => unescapeMap[m])
+
+const append = (content, attribute) => content + attribute
+const capitalize = content => content.charAt(0).toUpperCase() + content.slice(1)
+const ceil = content => Math.ceil(Number.parseFloat(content))
+const divide = (content, attribute) => Number.parseFloat(content) / Number.parseFloat(attribute)
+const escape = content => content.replace(/["&'<>]/g, m => escapeMap[m])
+const escapeOnce = content => escape(unescape(content))
+const floor = content => Math.floor(Number.parseFloat(content))
+const lowercase = content => content.toLowerCase()
+const lstrip = content => content.replace(/^\s+/, '')
+const minus = (content, attribute) => Number.parseFloat(content) - Number.parseFloat(attribute)
+const modulo = (content, attribute) => Number.parseFloat(content) % Number.parseFloat(attribute)
+const multiply = (content, attribute) => Number.parseFloat(content) * Number.parseFloat(attribute)
+const newlineToBr = content => content.replace(/\n/g, '<br>')
+const plus = (content, attribute) => Number.parseFloat(content) + Number.parseFloat(attribute)
+const prepend = (content, attribute) => attribute + content
+
+const remove = (content, attribute) => {
+  const regex = new RegExp(attribute, 'g')
+  return content.replace(regex, '')
+}
+
+const removeFirst = (content, attribute) => content.replace(attribute, '')
+const replace = (content, attribute) => {
+  const [search, replace] = attribute.split('|')
+  const regex = new RegExp(search, 'g')
+  return content.replace(regex, replace)
+}
+
+const replaceFirst = (content, attribute) => {
+  const [search, replace] = attribute.split('|')
+  return content.replace(search, replace)
+}
+
+const round = content => Math.round(Number.parseFloat(content))
+const rstrip = content => content.replace(/\s+$/, '')
+const uppercase = content => content.toUpperCase()
+const size = content => content.length
+const slice = (content, attribute) => {
+  try {
+    const [start, end] = attribute.split(',')
+    return content.slice(start, end)
+  } catch {
+    return content.slice(attribute)
+  }
+}
+
+const stripNewlines = content => content.replace(/\n/g, '')
+const trim = content => content.trim()
+const truncate = (content, attribute) => {
+  try {
+    const [length, omission] = attribute.split(',')
+    return content.length > Number.parseInt(length, 10) ?
+      content.slice(0, length) + (omission || '...') :
+      content
+  } catch {
+    const length = Number.parseInt(attribute, 10)
+    return content.length > length ? content.slice(0, length) + '...' : content
+  }
+}
+
+const truncateWords = (content, attribute) => {
+  try {
+    const [length, omission] = attribute.split(',')
+    return content.split(' ').slice(0, Number.parseInt(length, 10)).join(' ') + (omission || '...')
+  } catch {
+    const length = Number.parseInt(attribute, 10)
+    return content.split(' ').slice(0, length).join(' ') + '...'
+  }
+}
+
+// eslint-disable-next-line
+const urlDecode = content => content.split('+').map(decodeURIComponent).join(' ')
+// eslint-disable-next-line
+const urlEncode = content => content.split(' ').map(encodeURIComponent).join('+')
+
+exports.append = append
+exports.capitalize = capitalize
+exports.ceil = ceil
+exports['divide-by'] = divide
+exports.divide = divide
+exports.escape = escape
+exports['escape-once'] = escapeOnce
+exports.floor = floor
+exports.lowercase = lowercase
+exports.lstrip = lstrip
+exports.minus = minus
+exports.modulo = modulo
+exports.multiply = multiply
+exports['newline-to-br'] = newlineToBr
+exports.plus = plus
+exports.prepend = prepend
+exports.remove = remove
+exports['remove-first'] = removeFirst
+exports.replace = replace
+exports['replace-first'] = replaceFirst
+exports.round = round
+exports.rstrip = rstrip
+exports.uppercase = uppercase
+exports.size = size
+exports.slice = slice
+exports.strip = trim
+exports['strip-newlines'] = stripNewlines
+exports.times = multiply
+exports.trim = trim
+exports.truncate = truncate
+exports['truncate-words'] = truncateWords
+exports['url-decode'] = urlDecode
+exports['url-encode'] = urlEncode

package/src/transformers/filters/index.js

@@ -0,0 +1,55 @@
+const posthtml = require('posthtml')
+const {get, omit, has, merge} = require('lodash')
+const defaultFilters = require('./defaultFilters')
+const PostCSS = require('../../generators/postcss')
+const posthtmlContent = require('posthtml-content')
+const Tailwind = require('../../generators/tailwindcss')
+const safeClassNames = require('posthtml-safe-class-names')
+
+module.exports = async (html, config = {}, direct = false) => {
+  const filters = direct ?
+    merge(defaultFilters, config) :
+    merge(defaultFilters, get(config, 'filters', {}))
+
+  const posthtmlOptions = get(config, 'build.posthtml.options', {})
+
+  /**
+   * Compile CSS in <style {post|tailwind}css> tags
+   */
+  const maizzleConfig = omit(config, ['build.tailwind.css', 'css'])
+  const tailwindConfig = get(config, 'build.tailwind.config', 'tailwind.config.js')
+
+  filters.postcss = css => PostCSS.process(css, maizzleConfig)
+  filters.tailwindcss = css => Tailwind.compile(css, html, tailwindConfig, maizzleConfig)
+
+  return posthtml([
+    styleDataEmbed(),
+    posthtmlContent(filters),
+    safeClassNames()
+  ])
+    .process(html, posthtmlOptions)
+    .then(result => result.html)
+}
+
+/**
+ * Prevent CSS inlining
+ *
+ * Add a `data-embed` attribute to <style> tags that we want to preserve.
+ * Can be used for HTML email client targeting hacks.
+ */
+const styleDataEmbed = () => tree => {
+  const process = node => {
+    if (
+      node.tag === 'style'
+      && node.attrs
+      && (has(node.attrs, 'preserve') || has(node.attrs, 'embed'))) {
+      node.attrs = {...node.attrs, 'data-embed': true}
+      node.attrs.preserve = false
+      node.attrs.embed = false
+    }
+
+    return node
+  }
+
+  return tree.walk(process)
+}