@maizzle/framework 4.0.0-alpha.7 → 4.0.0-alpha.8

package/.github/workflows/nodejs.yml

@@ -14,7 +14,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [12, 14, 16]
+        node-version: [14, 16, 17]
 
     steps:
       - uses: actions/checkout@v2

package/package.json

@@ -1,86 +1,87 @@
-{
-  "name": "@maizzle/framework",
-  "version": "4.0.0-alpha.7",
-  "description": "Maizzle is a framework that helps you quickly build HTML emails with Tailwind CSS.",
-  "license": "MIT",
-  "main": "src/index.js",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/maizzle/framework.git"
-  },
-  "bugs": "https://github.com/maizzle/framework/issues",
-  "homepage": "https://maizzle.com",
-  "author": "Cosmin Popovici (https://github.com/cossssmin)",
-  "keywords": [
-    "maizzle",
-    "tailwindcss",
-    "responsive-email",
-    "email-framework",
-    "email-template",
-    "email-marketing",
-    "email-campaigns",
-    "email-newsletter",
-    "email-boilerplate",
-    "html-emails"
-  ],
-  "publishConfig": {
-    "access": "public"
-  },
-  "scripts": {
-    "test": "c8 ava -s",
-    "pretest": "xo",
-    "style": "xo",
-    "release": "np"
-  },
-  "dependencies": {
-    "autoprefixer": "^10.4.0",
-    "browser-sync": "^2.26.13",
-    "color-shorthand-hex-to-six-digit": "^3.0.2",
-    "email-comb": "^5.0.0",
-    "front-matter": "^4.0.0",
-    "fs-extra": "^10.0.0",
-    "glob-promise": "^4.1.0",
-    "html-crush": "^4.0.0",
-    "is-url-superb": "^5.0.0",
-    "juice": "^8.0.0",
-    "lodash": "^4.17.20",
-    "ora": "^5.1.0",
-    "postcss": "^8.4.4",
-    "postcss-import": "^14.0.0",
-    "postcss-merge-longhand": "^5.0.1",
-    "posthtml": "^0.16.6",
-    "posthtml-attrs-parser": "^0.1.1",
-    "posthtml-base-url": "^1.0.1",
-    "posthtml-content": "^0.0.3",
-    "posthtml-expressions": "^1.8.1",
-    "posthtml-extend": "^0.6.0",
-    "posthtml-extra-attributes": "^1.0.0",
-    "posthtml-fetch": "^2.0.0",
-    "posthtml-markdownit": "^1.3.0",
-    "posthtml-modules": "^0.8.1",
-    "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",
-    "posthtml-url-parameters": "^1.0.4",
-    "pretty": "^2.0.0",
-    "prevent-widows": "^1.0.2",
-    "query-string": "^7.1.0",
-    "string-strip-html": "^8.2.0",
-    "tailwindcss": "^3.0.0"
-  },
-  "devDependencies": {
-    "ava": "^4.0.1",
-    "c8": "^7.11.0",
-    "np": "*",
-    "xo": "0.39.1"
-  },
-  "engines": {
-    "node": ">=12.13.0"
-  },
-  "ava": {
-    "files": [
-      "test/**/test*.js"
-    ]
-  }
-}
+{
+  "name": "@maizzle/framework",
+  "version": "4.0.0-alpha.8",
+  "description": "Maizzle is a framework that helps you quickly build HTML emails with Tailwind CSS.",
+  "license": "MIT",
+  "main": "src/index.js",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/maizzle/framework.git"
+  },
+  "bugs": "https://github.com/maizzle/framework/issues",
+  "homepage": "https://maizzle.com",
+  "author": "Cosmin Popovici (https://github.com/cossssmin)",
+  "keywords": [
+    "maizzle",
+    "tailwindcss",
+    "responsive-email",
+    "email-framework",
+    "email-template",
+    "email-marketing",
+    "email-campaigns",
+    "email-newsletter",
+    "email-boilerplate",
+    "html-emails"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "test": "c8 ava -s",
+    "pretest": "xo",
+    "style": "xo",
+    "release": "np"
+  },
+  "dependencies": {
+    "autoprefixer": "^10.4.0",
+    "browser-sync": "^2.26.13",
+    "color-shorthand-hex-to-six-digit": "^3.0.2",
+    "email-comb": "^5.2.0",
+    "front-matter": "^4.0.0",
+    "fs-extra": "^10.0.0",
+    "glob-promise": "^4.1.0",
+    "html-crush": "^4.0.0",
+    "is-url-superb": "^5.0.0",
+    "juice": "^8.0.0",
+    "lodash": "^4.17.20",
+    "ora": "^5.1.0",
+    "postcss": "^8.4.4",
+    "postcss-import": "^14.0.0",
+    "postcss-merge-longhand": "^5.0.1",
+    "posthtml": "^0.16.6",
+    "posthtml-attrs-parser": "^0.1.1",
+    "posthtml-base-url": "^1.0.1",
+    "posthtml-content": "^0.0.3",
+    "posthtml-expressions": "^1.8.1",
+    "posthtml-extend": "^0.6.0",
+    "posthtml-extra-attributes": "^1.0.0",
+    "posthtml-fetch": "^2.2.0",
+    "posthtml-markdownit": "^1.3.0",
+    "posthtml-match-helper": "^1.0.3",
+    "posthtml-modules": "^0.9.0",
+    "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",
+    "posthtml-url-parameters": "^1.0.4",
+    "pretty": "^2.0.0",
+    "prevent-widows": "^1.0.2",
+    "query-string": "^7.1.0",
+    "string-strip-html": "^8.2.0",
+    "tailwindcss": "^3.0.0"
+  },
+  "devDependencies": {
+    "ava": "^4.0.1",
+    "c8": "^7.11.0",
+    "np": "*",
+    "xo": "0.39.1"
+  },
+  "engines": {
+    "node": ">=14.19.1"
+  },
+  "ava": {
+    "files": [
+      "test/**/test*.js"
+    ]
+  }
+}

package/src/commands/serve.js

@@ -121,19 +121,22 @@ const serve = async (env = 'local', config = {}) => {
 
     // Initialize Browsersync
     browsersync()
-      .init({
-        notify: false,
-        open: false,
-        port: 3000,
-        server: {
-          baseDir,
-          directory: true
-        },
-        tunnel: false,
-        ui: {port: 3001},
-        logFileChanges: false,
-        ...get(config, 'build.browsersync', {})
-      }, () => {})
+      .init(
+        merge(
+          {
+            notify: false,
+            open: false,
+            port: 3000,
+            server: {
+              baseDir,
+              directory: true
+            },
+            tunnel: false,
+            ui: {port: 3001},
+            logFileChanges: false
+          },
+          get(config, 'build.browsersync', {})
+        ), () => {})
   } catch (error) {
     spinner.fail(error)
     throw error

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

@@ -22,7 +22,7 @@ module.exports = async (html, options) => {
   let config = merge(fileConfig, get(options, 'maizzle', {}))
 
   const tailwindConfig = get(options, 'tailwind.config', {})
-  const cssString = get(options, 'tailwind.css', '@tailwind components; @tailwind utilities;')
+  const cssString = get(options, 'tailwind.css', '')
 
   let {frontmatter} = fm(html)
 

package/src/generators/postcss.js

@@ -0,0 +1,29 @@
+const path = require('path')
+const {get} = require('lodash')
+const postcss = require('postcss')
+const postcssImport = require('postcss-import')
+const postcssNested = require('tailwindcss/nesting')
+const mergeLonghand = require('postcss-merge-longhand')
+
+module.exports = {
+  process: async (css = '', maizzleConfig = {}, spinner = null) => {
+    const userFilePath = get(maizzleConfig, 'build.tailwind.css', path.join(process.cwd(), 'src/css/tailwind.css'))
+
+    return postcss([
+      postcssImport({path: path.dirname(userFilePath)}),
+      postcssNested(),
+      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(`PostCSS processing failed`)
+      })
+  }
+}

package/src/generators/posthtml.js

@@ -1,61 +1,66 @@
-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)
-}
+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 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}
+  )
+
+  const fetchPlugin = fetch(
+    merge(
+      {
+        expressions: merge({...expressionsOptions, locals})
+      },
+      get(config, 'build.posthtml.fetch', {})
+    )
+  )
+
+  return posthtml([
+    fetchPlugin,
+    expressions({...expressionsOptions, locals}),
+    layouts(
+      merge(
+        {
+          strict: false,
+          expressions: merge({...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,116 +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 = {}, 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`)
-      })
-  }
-}
+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,13 +1,17 @@
-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
-}
+const serve = require('./commands/serve')
+const toFile = require('./commands/build')
+const transformers = require('./transformers')
+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: toString,
+  postcss: PostCSS,
+  plaintext: toPlaintext,
+  tailwindcss: TailwindCSS
+}