@maizzle/framework 3.7.3 → 4.0.0-alpha.3

package/src/generators/plaintext.js

@@ -1,52 +1,49 @@
-const path = require('path')
-const {get} = require('lodash')
-const {stripHtml} = require('string-strip-html')
-
-module.exports.generate = async (html, destination, config) => {
-  const options = get(config, 'build.currentTemplates.plaintext', get(config, 'plaintext', {}))
-  const configDestinationPath = get(options, 'destination.path')
-  const extension = get(options, 'destination.extension', 'txt')
-  const plaintext = stripHtml(html, {
-    dumpLinkHrefsNearby: {
-      enabled: true
-    },
-    ...options
-  }).result
-
-  // If we set plaintext.destination.path in config/fm
-  if (configDestinationPath) {
-    // Naive path checking, this does not support dot folders
-    const isFilePath = Boolean(path.parse(configDestinationPath).ext)
-
-    /**
-     * Using a file path will generate a single plaintext file,
-     * no matter how many templates there are.
-     *
-     * It will be based on the last-processed template.
-     */
-    if (isFilePath) {
-      destination = configDestinationPath
-
-      return {plaintext, destination}
-    }
-
-    /**
-     * Using a directory-like path for plaintext.destination.path
-     */
-    destination = path.join(configDestinationPath, path.basename(config.filepath, path.extname(config.filepath)) + '.' + extension)
-
-    return {plaintext, destination}
-  }
-
-  /**
-   * Use template's `permalink` Front Matter key,
-   * fall back to the original `destination`.
-   */
-  destination = get(config, 'permalink', destination)
-
-  if (typeof destination === 'string') {
-    destination = path.join(path.dirname(destination), path.basename(destination, path.extname(destination)) + '.' + extension)
-  }
-
-  return {plaintext, destination}
-}
+const path = require('path')
+const {get} = require('lodash')
+const {stripHtml} = require('string-strip-html')
+
+module.exports.generate = async (html, destination, config) => {
+  const configDestinationPath = get(config, 'destination.path')
+  const extension = get(config, 'destination.extension', 'txt')
+
+  const plaintext = stripHtml(html, {
+    dumpLinkHrefsNearby: {
+      enabled: true
+    },
+    ...get(config, 'options', {})
+  }).result
+
+  // If we set plaintext.destination.path in config/fm
+  if (configDestinationPath) {
+    /**
+     * Using a file path will generate a single plaintext file,
+     * no matter how many templates there are.
+     *
+     * It will be based on the last-processed template.
+     */
+    if (path.extname(configDestinationPath)) {
+      destination = configDestinationPath
+
+      return {plaintext, destination}
+    }
+
+    /**
+     * Using a directory-like path for plaintext.destination.path
+     */
+    destination = path.join(configDestinationPath, path.basename(config.filepath, path.extname(config.filepath)) + '.' + extension)
+
+    return {plaintext, destination}
+  }
+
+  /**
+   * Use template's `permalink` Front Matter key,
+   * fall back to the original `destination`.
+   */
+  destination = get(config, 'permalink', destination)
+
+  if (typeof destination === 'string') {
+    destination = path.join(path.dirname(destination), path.basename(destination, path.extname(destination)) + '.' + extension)
+  }
+
+  return {plaintext, destination}
+}

package/src/generators/posthtml.js

@@ -1,60 +1,61 @@
-const fm = require('front-matter')
-const posthtml = require('posthtml')
-const {get, merge} = require('lodash')
-const fetch = require('posthtml-fetch')
-const layouts = require('posthtml-extend')
-const modules = require('posthtml-modules')
-const expressions = require('posthtml-expressions')
-
-module.exports = async (html, config) => {
-  const layoutsOptions = get(config, 'build.layouts', {})
-
-  const fetchOptions = get(config, 'build.posthtml.fetch', {})
-  const fetchPlugin = fetch({...fetchOptions})
-
-  const modulesOptions = get(config, 'build.components', {})
-  // Fake `from` option so we can reference modules relatively
-  const modulesRoot = modulesOptions.root || './'
-  const modulesFrom = modulesOptions.from || `${modulesRoot}/fake`
-
-  const posthtmlOptions = get(config, 'build.posthtml.options', {})
-  const posthtmlPlugins = get(config, 'build.posthtml.plugins', [])
-
-  const expressionsOptions = merge({strictMode: false}, get(config, 'build.posthtml.expressions', {}))
-
-  const locals = merge(
-    get(expressionsOptions, 'locals', {}),
-    get(config, 'locals', {}),
-    {page: config}
-  )
-
-  return posthtml([
-    fetchPlugin,
-    layouts(
-      merge(
-        {
-          strict: false,
-          plugins: [
-            expressions({...expressionsOptions, locals})
-          ]
-        },
-        layoutsOptions
-      )
-    ),
-    modules({
-      parser: posthtmlOptions,
-      from: modulesFrom,
-      root: modulesRoot,
-      tag: 'component',
-      attribute: 'src',
-      plugins: [
-        fetchPlugin
-      ],
-      locals,
-      ...modulesOptions
-    }),
-    ...posthtmlPlugins
-  ])
-    .process(html, {...posthtmlOptions})
-    .then(result => fm(result.html).body)
-}
+const fm = require('front-matter')
+const posthtml = require('posthtml')
+const {get, merge} = require('lodash')
+const fetch = require('posthtml-fetch')
+const layouts = require('posthtml-extend')
+const modules = require('posthtml-modules')
+const expressions = require('posthtml-expressions')
+
+module.exports = async (html, config) => {
+  const layoutsOptions = get(config, 'build.layouts', {})
+
+  const fetchOptions = get(config, 'build.posthtml.fetch', {})
+  const fetchPlugin = fetch({...fetchOptions})
+
+  const modulesOptions = get(config, 'build.components', {})
+  // Fake `from` option so we can reference modules relatively
+  const modulesRoot = modulesOptions.root || './'
+  const modulesFrom = modulesOptions.from || `${modulesRoot}/fake`
+
+  const posthtmlOptions = get(config, 'build.posthtml.options', {})
+  const posthtmlPlugins = get(config, 'build.posthtml.plugins', [])
+
+  const expressionsOptions = merge({strictMode: false}, get(config, 'build.posthtml.expressions', {}))
+
+  const locals = merge(
+    get(expressionsOptions, 'locals', {}),
+    get(config, 'locals', {}),
+    {page: config}
+  )
+
+  return posthtml([
+    fetchPlugin,
+    layouts(
+      merge(
+        {
+          strict: false,
+          plugins: [
+            expressions({...expressionsOptions, locals})
+          ]
+        },
+        layoutsOptions
+      )
+    ),
+    modules({
+      parser: posthtmlOptions,
+      attributeAsLocals: true,
+      from: modulesFrom,
+      root: modulesRoot,
+      tag: 'component',
+      attribute: 'src',
+      plugins: [
+        fetchPlugin
+      ],
+      locals,
+      ...modulesOptions
+    }),
+    ...posthtmlPlugins
+  ])
+    .process(html, {...posthtmlOptions})
+    .then(result => fm(result.html).body)
+}

package/src/generators/tailwindcss.js

@@ -1,84 +1,114 @@
-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 + css
-      }
-
-      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
+    }
+
+    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,13 @@
-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 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
-  ...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
-      })
-  }
-}
+const serve = require('./commands/serve')
+const toFile = require('./commands/build')
+const transformers = require('./transformers')
+const toString = require('./functions/render')
+const toPlaintext = require('./functions/plaintext')
+
+module.exports = {
+  serve,
+  build: toFile,
+  ...transformers,
+  render: toString,
+  plaintext: toPlaintext
+}

package/src/transformers/baseUrl.js

@@ -0,0 +1,45 @@
+const posthtml = require('posthtml')
+const isUrl = require('is-url-superb')
+const baseUrl = require('posthtml-base-url')
+const {get, isObject, isEmpty} = require('lodash')
+
+// VML backgrounds need regex because they're inside HTML comments :(
+const rewriteVMLs = (html, url) => {
+  const vImageMatch = html.match(/(<v:image.+)(src=['"]([^'"]+)['"])/)
+  const vFillMatch = html.match(/(<v:fill.+)(src=['"]([^'"]+)['"])/)
+
+  if (vImageMatch && !isUrl(vImageMatch[3])) {
+    html = html.replace(vImageMatch[0], `${vImageMatch[1]}src="${url}${vImageMatch[3]}"`)
+  }
+
+  if (vFillMatch && !isUrl(vFillMatch[3])) {
+    html = html.replace(vFillMatch[0], `${vFillMatch[1]}src="${url}${vFillMatch[3]}"`)
+  }
+
+  return html
+}
+
+module.exports = async (html, config = {}, direct = false) => {
+  const url = direct ? config : get(config, 'baseURL')
+  const posthtmlOptions = get(config, 'build.posthtml.options', {})
+
+  // `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)
+  }
+
+  // `baseUrl: {}`
+  if (isObject(url) && !isEmpty(url)) {
+    html = rewriteVMLs(html, url.url)
+
+    return posthtml([baseUrl(url)]).process(html, posthtmlOptions).then(result => result.html)
+  }
+
+  return html
+}