npm - @maizzle/framework - Versions diffs - 4.0.0-alpha.9 → 4.0.0 - Mend

@maizzle/framework 4.0.0-alpha.9 → 4.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (21) hide show

package/.github/media/logo-dark.svg +1 -0
package/.github/media/logo-light.svg +1 -0
package/.github/workflows/nodejs.yml +1 -1
package/README.md +42 -35
package/package.json +91 -91
package/src/generators/output/to-string.js +67 -71
package/src/transformers/index.js +63 -60
package/src/transformers/inlineCss.js +0 -13
package/src/transformers/prettify.js +27 -29
package/src/transformers/shorthandInlineCSS.js +19 -0
package/test/expected/posthtml/component.html +1 -1
package/test/expected/transformers/atimport-in-style.html +12 -13
package/test/expected/transformers/preserve-transform-css.html +33 -45
package/test/expected/useConfig.html +6 -6
package/test/fixtures/posthtml/component.html +2 -2
package/test/test-config.js +19 -19
package/test/test-postcss.js +8 -8
package/test/test-posthtml.js +72 -66
package/test/test-tailwindcss.js +117 -117
package/test/test-todisk.js +511 -511
package/test/test-transformers.js +510 -490

package/src/transformers/prettify.js CHANGED Viewed

@@ -1,29 +1,27 @@
-/* eslint-disable camelcase */
-const pretty = require('pretty')
-const {get, merge, isEmpty} = require('lodash')
-module.exports = async (html, config = {}, direct = false) => {
-  if (get(config, 'prettify') === false) {
-    return html
-  }
-  const defaultConfig = {
-    space_around_combinator: true, // Preserve space around CSS selector combinators
-    newline_between_rules: false, // Remove empty lines between CSS rules
-    indent_inner_html: false, // Helps reduce file size
-    extra_liners: [] // Don't add extra new line before any tag
-  }
-  config = direct ? config : merge(defaultConfig, get(config, 'prettify', {}))
-  if (typeof config === 'boolean' && config) {
-    return pretty(html, defaultConfig)
-  }
-  if (!isEmpty(config)) {
-    return pretty(html, config)
-  }
-  return html
-}
+/* eslint-disable camelcase */
+const pretty = require('pretty')
+const {get, merge, isEmpty, isObject} = require('lodash')
+module.exports = async (html, config = {}, direct = false) => {
+  const defaultConfig = {
+    space_around_combinator: true, // Preserve space around CSS selector combinators
+    newline_between_rules: false, // Remove empty lines between CSS rules
+    indent_inner_html: false, // Helps reduce file size
+    extra_liners: [] // Don't add extra new line before any tag
+  }
+  config = direct ? config : get(config, 'prettify')
+  // Don't prettify if not explicitly enabled in config
+  if (!config || (isObject(config) && isEmpty(config))) {
+    return html
+  }
+  if (typeof config === 'boolean' && config) {
+    return pretty(html, defaultConfig)
+  }
+  config = merge(defaultConfig, config)
+  return pretty(html, config)
+}

package/src/transformers/shorthandInlineCSS.js ADDED Viewed

@@ -0,0 +1,19 @@
+const posthtml = require('posthtml')
+const {get, isObject, isEmpty} = require('lodash')
+const mergeLonghand = require('posthtml-postcss-merge-longhand')
+module.exports = async (html, config, direct = false) => {
+  config = direct ? (isObject(config) ? config : true) : get(config, 'shorthandInlineCSS', [])
+  const posthtmlOptions = get(config, 'build.posthtml.options', {})
+  if (typeof config === 'boolean' && config) {
+    html = await posthtml([mergeLonghand()]).process(html, posthtmlOptions).then(result => result.html)
+  }
+  if (isObject(config) && !isEmpty(config)) {
+    html = await posthtml([mergeLonghand(config)]).process(html, posthtmlOptions).then(result => result.html)
+  }
+  return html
+}

package/test/expected/posthtml/component.html CHANGED Viewed

@@ -5,7 +5,7 @@ Variable from locals attribute: bar
 Variable from page: maizzle-ci
-Variable from attribute: Nested component
+  Variable from attribute: Nested component
 Variable from locals attribute: bar (nested)

package/test/expected/transformers/atimport-in-style.html CHANGED Viewed

@@ -1,16 +1,15 @@
 <!doctype html>
 <html>
-<head>
-  <style>
-    div {
-      margin-top: 1px;
-      margin-right: 2px;
-      margin-bottom: 3px;
-      margin-left: 4px;
-    }
-  </style>
-</head>
-<body>
-  <div>test</div>
-</body>
+  <head>
+    <style>div {
+  margin-top: 1px;
+  margin-right: 2px;
+  margin-bottom: 3px;
+  margin-left: 4px;
+}
+    </style>
+  </head>
+  <body>
+    <div>test</div>
+  </body>
 </html>

package/test/expected/transformers/preserve-transform-css.html CHANGED Viewed

@@ -1,48 +1,36 @@
 <!doctype html>
 <html>
-<head>
-  <style data-embed="">
-    .block {
-      display: block !important;
-    }
-    .inline {
-      display: inline !important;
-    }
-    .table {
-      display: table !important;
-    }
-    .contents {
-      display: contents !important;
-    }
-    .truncate {
-      overflow: hidden !important;
-      text-overflow: ellipsis !important;
-      white-space: nowrap !important;
-    }
-    .uppercase {
-      text-transform: uppercase !important;
-    }
-    .lowercase {
-      text-transform: lowercase !important;
-    }
-    .capitalize {
-      text-transform: capitalize !important;
-    }
-    div {
-      text-transform: uppercase;
-    }
-    [data-ogsc] .inexistent {
-      color: #ef4444;
-    }
-    div > u + .body .gmail-android-block {
-      display: block !important;
-    }
-    u + #body a {
-      color: inherit;
-    }
-  </style>
-</head>
-<body>
-  <div>test</div>
-</body>
+  <head>
+    <style data-embed="">.block {
+        display: block !important;
+} .inline {
+        display: inline !important;
+} .table {
+        display: table !important;
+} .contents {
+        display: contents !important;
+} .truncate {
+        overflow: hidden !important;
+        text-overflow: ellipsis !important;
+        white-space: nowrap !important;
+} .uppercase {
+        text-transform: uppercase !important;
+} .lowercase {
+        text-transform: lowercase !important;
+} .capitalize {
+        text-transform: capitalize !important;
+} div {
+        text-transform: uppercase;
+} [data-ogsc] .inexistent {
+        color: #ef4444;
+      } div > u + .body .gmail-android-block {
+        display: block !important;
+      } u + #body a {
+        color: inherit;
+      }
+    </style>
+  </head>
+  <body>
+    <div>test</div>
+  </body>
 </html>

package/test/expected/useConfig.html CHANGED Viewed

@@ -1,9 +1,9 @@
 <!doctype html>
 <html>
-<head>
-  <title>test></title>
-</head>
-<body>
-  <div>build_production</div>
-</body>
+  <head>
+    <title>test></title>
+  </head>
+  <body>
+    <div>build_production</div>
+  </body>
 </html>

package/test/fixtures/posthtml/component.html CHANGED Viewed

@@ -5,7 +5,7 @@
     "foo": "bar"
   }'
 >
-  Variable from page: [[ page.env ]]
+Variable from page: [[ page.env ]]
   <component
     src="test/stubs/components/component.html"
@@ -14,6 +14,6 @@
       "foo": "bar (nested)"
     }'
   >
-    Variable from page (nested): [[ page.env ]]
+Variable from page (nested): [[ page.env ]]
   </component>
 </component>

package/test/test-config.js CHANGED Viewed

@@ -1,19 +1,19 @@
-const test = require('ava')
-const Config = require('../src/generators/config')
-test('returns the merged config', async t => {
-  const config = await Config.getMerged('maizzle-ci')
-  t.is(config.env, 'maizzle-ci')
-})
-test('throws if env name is not a string', async t => {
-  await t.throwsAsync(async () => {
-    await Config.getMerged(false)
-  }, {instanceOf: TypeError, message: `env name must be a string, received boolean(false)`})
-})
-test('throws if a config could not be loaded for the specified environment', async t => {
-  await t.throwsAsync(async () => {
-    await Config.getMerged('fake')
-  }, {instanceOf: Error, message: `could not load config.fake.js`})
-})
+const test = require('ava')
+const Config = require('../src/generators/config')
+test('returns the merged config', async t => {
+  const config = await Config.getMerged('maizzle-ci')
+  t.is(config.env, 'maizzle-ci')
+})
+test('throws if env name is not a string', async t => {
+  await t.throwsAsync(async () => {
+    await Config.getMerged(false)
+  }, {instanceOf: TypeError, message: `env name must be a string, received boolean(false)`})
+})
+test('throws if a config could not be loaded for the specified environment', async t => {
+  await t.throwsAsync(async () => {
+    await Config.getMerged('fake')
+  }, {instanceOf: Error, message: `could not load config.fake.js`})
+})

package/test/test-postcss.js CHANGED Viewed

@@ -1,8 +1,8 @@
-const test = require('ava')
-const PostCSS = require('../src/generators/postcss')
-test('throws on processing error', async t => {
-  await t.throwsAsync(async () => {
-    await PostCSS.process(null, {})
-  }, {instanceOf: Error, message: 'PostCSS processing failed'})
-})
+const test = require('ava')
+const PostCSS = require('../src/generators/postcss')
+test('throws on processing error', async t => {
+  await t.throwsAsync(async () => {
+    await PostCSS.process(null, {})
+  }, {instanceOf: Error, message: 'PostCSS processing failed'})
+})

package/test/test-posthtml.js CHANGED Viewed

@@ -1,66 +1,72 @@
-const test = require('ava')
-const Maizzle = require('../src')
-const path = require('path')
-const {readFileSync} = require('fs')
-const fixture = file => readFileSync(path.join(__dirname, 'fixtures', `${file}.html`), 'utf8')
-const expected = file => readFileSync(path.join(__dirname, 'expected', `${file}.html`), 'utf8')
-const renderString = (string, options = {}) => Maizzle.render(string, options).then(({html}) => html)
-test('layouts', async t => {
-  const source = fixture('posthtml/layout')
-  const html = await renderString(source, {maizzle: {env: 'maizzle-ci'}})
-  t.is(html.trim(), expected('posthtml/layout').trim())
-})
-test('inheritance when extending a template', async t => {
-  let html = await renderString(fixture('posthtml/extend-template'))
-  html = html.replace(/[^\S\r\n]+$/gm, '').trim()
-  t.is(html, expected('posthtml/extend-template').trim())
-})
-test('components', async t => {
-  const source = fixture('posthtml/component')
-  const options = {
-    maizzle: {
-      env: 'maizzle-ci',
-      build: {
-        components: {
-          expressions: {
-            delimiters: ['[[', ']]']
-          }
-        }
-      }
-    }
-  }
-  const html = await renderString(source, options)
-  t.is(html.trim(), expected('posthtml/component').trim())
-})
-test('fetch component', async t => {
-  const source = fixture('posthtml/fetch')
-  const options = {
-    maizzle: {
-      env: 'maizzle-ci',
-      build: {
-        posthtml: {
-          expressions: {
-            delimiters: ['[[', ']]']
-          }
-        }
-      }
-    }
-  }
-  let html = await renderString(source, options)
-  html = html.replace(/[^\S\r\n]+$/gm, '')
-  t.is(html.trim(), expected('posthtml/fetch').trim())
-})
+const test = require('ava')
+const Maizzle = require('../src')
+const path = require('path')
+const fs = require('fs')
+const readFile = (dir, filename) => fs.promises
+  .readFile(path.join(__dirname, dir, `${filename}.html`), 'utf8')
+  .then(html => html.trim())
+const fixture = file => readFile('fixtures', file)
+const expected = file => readFile('expected', file)
+const renderString = (string, options = {}) => Maizzle.render(string, options).then(({html}) => html)
+test('layouts', async t => {
+  const source = await fixture('posthtml/layout')
+  const html = await renderString(source, {maizzle: {env: 'maizzle-ci'}})
+  t.is(html.trim(), await expected('posthtml/layout'))
+})
+test('inheritance when extending a template', async t => {
+  const source = await fixture('posthtml/extend-template')
+  let html = await renderString(source)
+  html = html.replace(/[^\S\r\n]+$/gm, '').trim()
+  t.is(html, await expected('posthtml/extend-template'))
+})
+test('components', async t => {
+  const source = await fixture('posthtml/component')
+  const options = {
+    maizzle: {
+      env: 'maizzle-ci',
+      build: {
+        components: {
+          expressions: {
+            delimiters: ['[[', ']]']
+          }
+        }
+      }
+    }
+  }
+  const html = await renderString(source, options)
+  t.is(html.trim(), await expected('posthtml/component'))
+})
+test('fetch component', async t => {
+  const source = await fixture('posthtml/fetch')
+  const options = {
+    maizzle: {
+      env: 'maizzle-ci',
+      build: {
+        posthtml: {
+          expressions: {
+            delimiters: ['[[', ']]']
+          }
+        }
+      }
+    }
+  }
+  let html = await renderString(source, options)
+  html = html.replace(/[^\S\r\n]+$/gm, '')
+  t.is(html.trim(), await expected('posthtml/fetch'))
+})