@maizzle/framework 4.0.0 → 4.0.1

package/.editorconfig

@@ -1,9 +1,9 @@
-root = true
-
-[*]
-indent_style = space
-indent_size = 2
-end_of_line = lf
-charset = utf-8
-trim_trailing_whitespace = true
-insert_final_newline = true
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true

package/.github/workflows/nodejs.yml

@@ -1,28 +1,28 @@
-# This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node
-# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
-
-name: Node.js CI
-
-on:
-  push:
-    branches: [master]
-  pull_request:
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-
-    strategy:
-      matrix:
-        node-version: [14, 16, 18]
-
-    steps:
-      - uses: actions/checkout@v2
-      - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v1
-        with:
-          node-version: ${{ matrix.node-version }}
-      - run: npm install
-      - run: npm test
-        env:
-          CI: true
+# This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
+
+name: Node.js CI
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [14, 16, 18]
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v1
+        with:
+          node-version: ${{ matrix.node-version }}
+      - run: npm install
+      - run: npm test
+        env:
+          CI: true

package/LICENSE

@@ -1,21 +1,21 @@
-The MIT License (MIT)
-
-Copyright (c) Cosmin Popovici
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+The MIT License (MIT)
+
+Copyright (c) Cosmin Popovici
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/bin/maizzle

@@ -1,3 +1,3 @@
-#!/usr/bin/env node
-
-require('@maizzle/cli')
+#!/usr/bin/env node
+
+require('@maizzle/cli')

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@maizzle/framework",
-  "version": "4.0.0",
+  "version": "4.0.1",
   "description": "Maizzle is a framework that helps you quickly build HTML emails with Tailwind CSS.",
   "license": "MIT",
   "main": "src/index.js",
@@ -72,7 +72,7 @@
     "prevent-widows": "^1.0.2",
     "query-string": "^7.1.0",
     "string-strip-html": "^8.2.0",
-    "tailwindcss": "^3.0.0"
+    "tailwindcss": "^3.1.0"
   },
   "devDependencies": {
     "ava": "^4.0.1",

package/src/generators/config.js

@@ -1,32 +1,32 @@
-const path = require('path')
-const {merge} = require('lodash')
-const {requireUncached} = require('../utils/helpers')
-
-module.exports = {
-  getMerged: async (env = 'local') => {
-    if (typeof env !== 'string') {
-      throw new TypeError(`env name must be a string, received ${typeof env}(${env})`)
-    }
-
-    let baseConfig = {env}
-    let envConfig = {env}
-
-    const cwd = env === 'maizzle-ci' ? './test/stubs/config' : process.cwd()
-
-    for (const module of ['./config', './config.local']) {
-      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 {
-        throw new Error(`could not load config.${env}.js`)
-      }
-    }
-
-    return merge(baseConfig, envConfig)
-  }
-}
+const path = require('path')
+const {merge} = require('lodash')
+const {requireUncached} = require('../utils/helpers')
+
+module.exports = {
+  getMerged: async (env = 'local') => {
+    if (typeof env !== 'string') {
+      throw new TypeError(`env name must be a string, received ${typeof env}(${env})`)
+    }
+
+    let baseConfig = {env}
+    let envConfig = {env}
+
+    const cwd = env === 'maizzle-ci' ? './test/stubs/config' : process.cwd()
+
+    for (const module of ['./config', './config.local']) {
+      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 {
+        throw new Error(`could not load config.${env}.js`)
+      }
+    }
+
+    return merge(baseConfig, envConfig)
+  }
+}

package/src/generators/output/index.js

@@ -1,4 +1,4 @@
-module.exports = {
-  toDisk: require('./to-disk'),
-  toString: require('./to-string')
-}
+module.exports = {
+  toDisk: require('./to-disk'),
+  toString: require('./to-string')
+}

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

@@ -1,208 +1,208 @@
-const path = require('path')
-const fs = require('fs-extra')
-const glob = require('glob-promise')
-const {get, isEmpty, merge} = require('lodash')
-const {asyncForEach} = require('../../utils/helpers')
-const removePlaintextTags = require('../../transformers/plaintext')
-
-const Config = require('../config')
-const Tailwind = require('../tailwindcss')
-const Plaintext = require('../plaintext')
-
-const render = require('./to-string')
-
-module.exports = async (env, spinner, config) => {
-  process.env.NODE_ENV = env || 'local'
-
-  if (isEmpty(config)) {
-    config = await Config.getMerged(env).catch(error => {
-      spinner.fail('Build failed')
-      throw error
-    })
-  }
-
-  const buildTemplates = get(config, 'build.templates')
-  const templatesConfig = Array.isArray(buildTemplates) ? buildTemplates : [buildTemplates]
-
-  const parsed = []
-  let files = []
-
-  const css = (typeof get(config, 'tailwind.compiled') === 'string')
-    ? config.tailwind.compiled
-    : await Tailwind.compile('', '', {}, config, spinner)
-
-  // Parse each template config object
-  await asyncForEach(templatesConfig, async templateConfig => {
-    const outputDir = get(templateConfig, 'destination.path', `build_${env}`)
-
-    await fs.remove(outputDir)
-
-    /**
-     * Get all files in the template config's source directory
-     * Supports `source` defined as:
-     * - string
-     * - array of strings
-     * - function that returns either of the above
-     *
-     *  */
-    const templateSource = []
-    const templateTypeErrorMessage = 'Invalid template source: expected string or array of strings, got '
-
-    if (typeof templateConfig.source === 'function') {
-      const sources = templateConfig.source(config)
-
-      if (Array.isArray(sources)) {
-        templateSource.push(...sources)
-      } 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 if (typeof templateConfig.source === 'string') {
-        templateSource.push(templateConfig.source)
-      } else {
-        throw new TypeError(templateTypeErrorMessage + typeof templateConfig.source)
-      }
-    }
-
-    // Parse each template source
-    await asyncForEach(templateSource, async source => {
-      /**
-       * Copy single-file sources correctly
-       * If `src` is a file, `dest` cannot be a directory
-       * https://github.com/jprichardson/node-fs-extra/issues/323
-       */
-      const out = fs.lstatSync(source).isFile() ? `${outputDir}/${path.basename(source)}` : outputDir
-
-      await fs
-        .copy(source, out)
-        .then(async () => {
-          const extensions = Array.isArray(templateConfig.filetypes)
-            ? templateConfig.filetypes.join('|')
-            : templateConfig.filetypes || get(templateConfig, 'filetypes', 'html')
-
-          const templates = await glob(`${outputDir}/**/*.+(${extensions})`)
-
-          if (templates.length === 0) {
-            spinner.warn(`Error: no files with the .${extensions} extension found in ${templateConfig.source}`)
-            return
-          }
-
-          if (config.events && typeof config.events.beforeCreate === 'function') {
-            await config.events.beforeCreate(config)
-          }
-
-          await asyncForEach(templates, async file => {
-            const html = await fs.readFile(file, 'utf8')
-
-            try {
-              const compiled = await render(html, {
-                maizzle: {
-                  ...config,
-                  env
-                },
-                tailwind: {
-                  compiled: css
-                },
-                ...config.events
-              })
-
-              const destination = config.permalink || file
-
-              /**
-               * Generate plaintext
-               *
-               * We do this first so that we can remove the <plaintext>
-               * tags from the markup before outputting the file.
-               */
-
-              const plaintextConfig = get(templateConfig, 'plaintext')
-              const plaintextPath = get(plaintextConfig, 'destination.path', config.permalink || file)
-
-              if (Boolean(plaintextConfig) || !isEmpty(plaintextConfig)) {
-                await Plaintext
-                  .generate(
-                    compiled.html,
-                    plaintextPath,
-                    merge(plaintextConfig, {filepath: file})
-                  )
-                  .then(({plaintext, destination}) => fs.outputFile(destination, plaintext))
-              }
-
-              compiled.html = removePlaintextTags(compiled.html, config)
-
-              /**
-               * Output file
-               */
-              const parts = path.parse(destination)
-              const extension = get(templateConfig, 'destination.extension', 'html')
-              const finalDestination = `${parts.dir}/${parts.name}.${extension}`
-
-              await fs.outputFile(finalDestination, compiled.html)
-
-              /**
-               * Remove original file if its path is different
-               * from the final destination path.
-               *
-               * This ensures non-HTML files do not pollute
-               * the build destination folder.
-               */
-              if (finalDestination !== file) {
-                await fs.remove(file)
-              }
-
-              // Keep track of handled files
-              files.push(file)
-              parsed.push(file)
-            } catch (error) {
-              switch (config.build.fail) {
-                case 'silent':
-                  spinner.warn(`Failed to compile template: ${path.basename(file)}`)
-                  break
-                case 'verbose':
-                  spinner.warn(`Failed to compile template: ${path.basename(file)}`)
-                  console.error(error)
-                  break
-                default:
-                  spinner.fail(`Failed to compile template: ${path.basename(file)}`)
-                  throw error
-              }
-            }
-          })
-
-          const assets = {source: '', destination: 'assets', ...get(templateConfig, 'assets')}
-
-          if (Array.isArray(assets.source)) {
-            await asyncForEach(assets.source, async source => {
-              if (fs.existsSync(source)) {
-                await fs.copy(source, path.join(templateConfig.destination.path, assets.destination)).catch(error => spinner.warn(error.message))
-              }
-            })
-          } else {
-            if (fs.existsSync(assets.source)) {
-              await fs.copy(assets.source, path.join(templateConfig.destination.path, assets.destination)).catch(error => spinner.warn(error.message))
-            }
-          }
-
-          await glob(path.join(templateConfig.destination.path, '/**/*.*'))
-            .then(contents => {
-              files = [...new Set([...files, ...contents])]
-            })
-        })
-        .catch(error => spinner.warn(error.message))
-    })
-  })
-
-  if (config.events && typeof config.events.afterBuild === 'function') {
-    await config.events.afterBuild(files)
-  }
-
-  return {
-    files,
-    parsed,
-    css
-  }
-}
+const path = require('path')
+const fs = require('fs-extra')
+const glob = require('glob-promise')
+const {get, isEmpty, merge} = require('lodash')
+const {asyncForEach} = require('../../utils/helpers')
+const removePlaintextTags = require('../../transformers/plaintext')
+
+const Config = require('../config')
+const Tailwind = require('../tailwindcss')
+const Plaintext = require('../plaintext')
+
+const render = require('./to-string')
+
+module.exports = async (env, spinner, config) => {
+  process.env.NODE_ENV = env || 'local'
+
+  if (isEmpty(config)) {
+    config = await Config.getMerged(env).catch(error => {
+      spinner.fail('Build failed')
+      throw error
+    })
+  }
+
+  const buildTemplates = get(config, 'build.templates')
+  const templatesConfig = Array.isArray(buildTemplates) ? buildTemplates : [buildTemplates]
+
+  const parsed = []
+  let files = []
+
+  const css = (typeof get(config, 'tailwind.compiled') === 'string')
+    ? config.tailwind.compiled
+    : await Tailwind.compile('', '', {}, config, spinner)
+
+  // Parse each template config object
+  await asyncForEach(templatesConfig, async templateConfig => {
+    const outputDir = get(templateConfig, 'destination.path', `build_${env}`)
+
+    await fs.remove(outputDir)
+
+    /**
+     * Get all files in the template config's source directory
+     * Supports `source` defined as:
+     * - string
+     * - array of strings
+     * - function that returns either of the above
+     *
+     *  */
+    const templateSource = []
+    const templateTypeErrorMessage = 'Invalid template source: expected string or array of strings, got '
+
+    if (typeof templateConfig.source === 'function') {
+      const sources = templateConfig.source(config)
+
+      if (Array.isArray(sources)) {
+        templateSource.push(...sources)
+      } 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 if (typeof templateConfig.source === 'string') {
+        templateSource.push(templateConfig.source)
+      } else {
+        throw new TypeError(templateTypeErrorMessage + typeof templateConfig.source)
+      }
+    }
+
+    // Parse each template source
+    await asyncForEach(templateSource, async source => {
+      /**
+       * Copy single-file sources correctly
+       * If `src` is a file, `dest` cannot be a directory
+       * https://github.com/jprichardson/node-fs-extra/issues/323
+       */
+      const out = fs.lstatSync(source).isFile() ? `${outputDir}/${path.basename(source)}` : outputDir
+
+      await fs
+        .copy(source, out)
+        .then(async () => {
+          const extensions = Array.isArray(templateConfig.filetypes)
+            ? templateConfig.filetypes.join('|')
+            : templateConfig.filetypes || get(templateConfig, 'filetypes', 'html')
+
+          const templates = await glob(`${outputDir}/**/*.+(${extensions})`)
+
+          if (templates.length === 0) {
+            spinner.warn(`Error: no files with the .${extensions} extension found in ${templateConfig.source}`)
+            return
+          }
+
+          if (config.events && typeof config.events.beforeCreate === 'function') {
+            await config.events.beforeCreate(config)
+          }
+
+          await asyncForEach(templates, async file => {
+            const html = await fs.readFile(file, 'utf8')
+
+            try {
+              const compiled = await render(html, {
+                maizzle: {
+                  ...config,
+                  env
+                },
+                tailwind: {
+                  compiled: css
+                },
+                ...config.events
+              })
+
+              const destination = config.permalink || file
+
+              /**
+               * Generate plaintext
+               *
+               * We do this first so that we can remove the <plaintext>
+               * tags from the markup before outputting the file.
+               */
+
+              const plaintextConfig = get(templateConfig, 'plaintext')
+              const plaintextPath = get(plaintextConfig, 'destination.path', config.permalink || file)
+
+              if (Boolean(plaintextConfig) || !isEmpty(plaintextConfig)) {
+                await Plaintext
+                  .generate(
+                    compiled.html,
+                    plaintextPath,
+                    merge(plaintextConfig, {filepath: file})
+                  )
+                  .then(({plaintext, destination}) => fs.outputFile(destination, plaintext))
+              }
+
+              compiled.html = removePlaintextTags(compiled.html, config)
+
+              /**
+               * Output file
+               */
+              const parts = path.parse(destination)
+              const extension = get(templateConfig, 'destination.extension', 'html')
+              const finalDestination = `${parts.dir}/${parts.name}.${extension}`
+
+              await fs.outputFile(finalDestination, compiled.html)
+
+              /**
+               * Remove original file if its path is different
+               * from the final destination path.
+               *
+               * This ensures non-HTML files do not pollute
+               * the build destination folder.
+               */
+              if (finalDestination !== file) {
+                await fs.remove(file)
+              }
+
+              // Keep track of handled files
+              files.push(file)
+              parsed.push(file)
+            } catch (error) {
+              switch (config.build.fail) {
+                case 'silent':
+                  spinner.warn(`Failed to compile template: ${path.basename(file)}`)
+                  break
+                case 'verbose':
+                  spinner.warn(`Failed to compile template: ${path.basename(file)}`)
+                  console.error(error)
+                  break
+                default:
+                  spinner.fail(`Failed to compile template: ${path.basename(file)}`)
+                  throw error
+              }
+            }
+          })
+
+          const assets = {source: '', destination: 'assets', ...get(templateConfig, 'assets')}
+
+          if (Array.isArray(assets.source)) {
+            await asyncForEach(assets.source, async source => {
+              if (fs.existsSync(source)) {
+                await fs.copy(source, path.join(templateConfig.destination.path, assets.destination)).catch(error => spinner.warn(error.message))
+              }
+            })
+          } else {
+            if (fs.existsSync(assets.source)) {
+              await fs.copy(assets.source, path.join(templateConfig.destination.path, assets.destination)).catch(error => spinner.warn(error.message))
+            }
+          }
+
+          await glob(path.join(templateConfig.destination.path, '/**/*.*'))
+            .then(contents => {
+              files = [...new Set([...files, ...contents])]
+            })
+        })
+        .catch(error => spinner.warn(error.message))
+    })
+  })
+
+  if (config.events && typeof config.events.afterBuild === 'function') {
+    await config.events.afterBuild(files)
+  }
+
+  return {
+    files,
+    parsed,
+    css
+  }
+}