feat: added $map suffix for object arrays

jakobrosenberg · jakobrosenberg · commit 179fa1abb359 · 2020-10-17T17:38:44.000+02:00
diff --git a/examples/basic/_roxi/roxi.config.yaml b/examples/basic/_roxi/roxi.config.yaml
@@ -26,7 +26,7 @@ plugins:
   - spassr:
       port: 3400
       ssr: true
-  - postcss:
   - mdsvex:
+  - postcss:
   - vite:
   - debugger:
diff --git a/lib/app.js b/lib/app.js
@@ -1,9 +1,6 @@
 /// <reference path="../typedef.js" />
 
-
-/** @ts-ignore */
-const esmRequire = require("esm")(module, {}/*, options*/)
-const { deepAssign, log } = require('./utils')
+const { deepAssign, log, keysAsFunctionsRecursive } = require('./utils')
 
 
 /** @type {AppEvent[]} */
@@ -42,20 +39,25 @@ const App = class {
   async run(events = this.events) {
     try {
       for (const event of events) {
+        console.log('event', event)
         this.state.event = event
         await runPlugins(event, this)
       }
     } catch (err) { this.errorHandler(err) }
   }
 }
 
+//todo move this somewhere else?
+const objToArray = {
+  hooks: [{ event: 'bundle', action: app => keysAsFunctionsRecursive(app) }]
+}
 
 /**
  * @param {AppEvent} event
  * @param {RoxiApp} app
  */
 async function runPlugins(event, app) {
-  const plugins = [...app.config.roxi.plugins]
+  const plugins = [objToArray, ...app.config.roxi.plugins]
   for (const plugin of plugins) {
     const hooks = plugin.hooks.filter(hookCondition(app, plugin.params, { event }))
     for (const hook of hooks)
diff --git a/lib/plugins/mdsvex/index.js b/lib/plugins/mdsvex/index.js
@@ -1,36 +1,31 @@
 /// <reference path="../../../typedef.js" />
 
 import { mdsvex } from 'mdsvex'
-const extension = ['.md', '.svx', '.svelte']
 
 /** @type {RoxiPlugin} */
 module.exports.default = {
   name: 'mdsvex',
   hooks: [
     {
       event: 'start',
-      action: app => app.config.mdsvex = {}, //provide an mdsvex object for developers to modify
-    },
-    {
-      event: 'before:bundle',
       action: (app, params) => {
+        const extension = params.extension || .md
+
+        //provide an mdsvex object for developers to modify
+        const conf = { extension, ...params }
+
+
         app.merge({
           config: {
+            mdsvex: conf,
             svelte: {
-              preprocess: [
-                mdsvex({
-                  extension: '.md',
-                  ...app.config.mdsvex,
-                  ...params
-                })
-              ],
-              extensions: params.extension
-                || app.config.mdsvex.extension
-                || extension
+              preprocess: { mdsvex: conf },
+              preprocess$map: { mdsvex },
+              extensions: [extension]
             }
           }
         })
       }
-    }
+    },
   ]
 }
diff --git a/lib/plugins/postcss/index.js b/lib/plugins/postcss/index.js
@@ -8,43 +8,34 @@ export default {
       event: 'start',
       action: async (app, params) => {
         const postcssImport = (await import('postcss-import')).default
-        app.merge({
-          config: {
-            postcss: {
-              pluginsMap: { postcssImport },
-              plugins: {
-                postcssImport: {}
-              }
-            }
-          }
-        })
-      }
-    },
-    {
-      event: 'before:bundle',
-      action: async (app, params) => {
-        const { keysAsFunctions } = (await import('../../utils'))
-        const { plugins, pluginsMap } = app.config.postcss
         const postcss = (await import('rollup-plugin-postcss')).default
-        const autoPreprocess = (await import('svelte-preprocess')).default
-        app.config.postcss.plugins = await keysAsFunctions(plugins, pluginsMap)
-        delete app.config.postcss.pluginsMap
+
+        const postcssConfig = {
+          plugins$map: { postcssImport },
+          plugins: {
+            postcssImport: {},
+          }
+        }
 
         app.merge({
           config: {
+            // add postcss to the config
+            postcss: postcssConfig,
+
+            // rollup needs access
             rollup: {
-              pluginsMap: { postcss },
-              plugins: {
-                postcss: app.config.postcss
-              }
+              plugins: { postcss: postcssConfig },
+              plugins$map: { postcss }
             },
+
+            // and so does svelte preprocess
             svelte: {
-              preprocess: [
-                autoPreprocess({
-                  postcss: app.config.postcss,
+              preprocess: {
+                autoPreprocess: {
+                  _postcss: postcssConfig,
                   defaults: { style: 'postcss' }
-                })
-              ]
+                }
+              }
             }
           }
         })
diff --git a/lib/plugins/preprocess/index.js b/lib/plugins/preprocess/index.js
@@ -1,20 +1,15 @@
+import autoPreprocess from 'svelte-preprocess'
+
 export default {
   hooks: [
     {
-      condition: 'start',
-      action: app => app.config.autoPreprocess = {}
-    },
-    {
-      condition: 'before:bundle',
-      action: async (app, params) => {
-        const autoPreprocess = (await import('svelte-preprocess')).default
-
+      event: 'start',
+      action: app => {
         app.merge({
           config: {
             svelte: {
-              preprocess: [
-                autoPreprocess(app.config.autoPreprocess)
-              ]
+              preprocess: { autoPreprocess: {} },
+              preprocess$map: { autoPreprocess }
             }
           }
         })
diff --git a/lib/plugins/rollup/index.js b/lib/plugins/rollup/index.js
@@ -1,6 +1,5 @@
 const rollup = require('rollup')
 import rollupTemplate from './rollup.template'
-import rollupCompile from './rollup.compile'
 
 export default {
   name: 'rollup',
@@ -9,14 +8,6 @@ export default {
       event: 'start',
       action: rollupTemplate
     },
-    {
-      event: 'bundle',
-      condition: app =>
-        app.state.production
-        || app.config.rollup.compileConfig
-        || app.config.rollup.writeConfig,
-      action: rollupCompile
-    },
     {
       event: 'bundle',
       condition: app => app.state.production || app.config.rollup.writeConfig,
diff --git a/lib/plugins/rollup/rollup.compile.js b/lib/plugins/rollup/rollup.compile.js
diff --git a/lib/plugins/rollup/rollup.template.js b/lib/plugins/rollup/rollup.template.js
@@ -24,7 +24,7 @@ module.exports = function rollup(app, params) {
       sourcemap: true,
       format: 'esm', dir: buildDir
     },
-    pluginsMap: { svelte, resolve, commonjs, terser, hmr, livereload },
+    plugins$map: { svelte, resolve, commonjs, terser, hmr, livereload },
     plugins: {
       terser: production && {},
       svelte: app.config.svelte,
diff --git a/lib/plugins/svelte/index.js b/lib/plugins/svelte/index.js
@@ -3,9 +3,15 @@ export default {
     {
       event: 'start',
       action: async (app, params, ctx) => {
-        app.config.svelte = {
-          extensions: []
-        }
+        app.merge({
+          config: {
+            svelte: {
+              extensions: ['.svelte'],
+              preprocess: {},
+              preprocess$map: {}
+            }
+          }
+        })
       }
     }
   ]
diff --git a/lib/utils/index.js b/lib/utils/index.js
@@ -42,7 +42,47 @@ function deepAssign(target, ...sources) {
   return target
 }
 
-async function keysAsFunctions(obj, map) {
+async function keysAsFunctionsRecursive(obj, suffix = '$map') {
+  const maps = []
+
+  // process all descendants' maps first
+  const children = Object.entries(obj).map(([key, value]) => {
+    if (isObject(value)) {
+      if (key.endsWith(suffix))
+        maps.push({ key, value })
+      else
+        return keysAsFunctionsRecursive(value, suffix)
+    }
+  })
+  await Promise.all(children)
+
+  // process own maps
+  const ownMaps = await Promise.all(maps.map(async ({ key, value }) => {
+    delete obj[key]
+    key = key.substr(0, key.length - suffix.length)
+    const result = await keysAsFunctions(obj[key], value, key)
+    return {
+      key,
+      result
+    }
+  }))
+  ownMaps.forEach(thing => obj[thing.key] = thing.result)
+
+  return obj
+}
+
+/**
+ * converts objects to arrays
+ * each field value is parsed through a function from the map which corresponds to the field's key
+ * map = { aPlugin: val => val + 'bar' }
+ * obj = { aPlugin: 'foo', _n: 123 }
+ * keysAsFunctions(obj, map) // ['foobar', 123]
+ * @param {object} obj
+ * @param {Object.<string, function>} map
+ */
+async function keysAsFunctions(obj, map, name) {
+  if (!isObject(obj))
+    throw new Error(`expected an object for "${name}", but got ${JSON.stringify(obj, null, 2)}`)
   const { log } = require('./log')
   const promises = Object.entries(obj).map(([key, value]) => {
     const isFn = !key.startsWith('_')
@@ -51,7 +91,9 @@ async function keysAsFunctions(obj, map) {
 
     if (!fn && isFn) log.info(
       `there's no map method named ${key}. Available methods: ${Object.keys(map)}.` +
-      `\nRenaming to "_${key}" will hide this message.`
+      `\nRenaming to "_${key}" will hide this message.` +
+      `\nvalue: ${JSON.stringify(value, null, 2)}` +
+      `\nobj: ${JSON.stringify(obj, null, 2)}`
     )
     return fn && value ? fn(value) : value
   })
@@ -63,5 +105,6 @@ module.exports = {
   isObject,
   deepAssign,
   keysAsFunctions,
+  keysAsFunctionsRecursive,
   ...require('./log')
 }
diff --git a/lib/utils/tests/keysAsFunctionsRecursive.spec.js b/lib/utils/tests/keysAsFunctionsRecursive.spec.js
@@ -0,0 +1,60 @@
+const { keysAsFunctionsRecursive } = require("..");
+
+const fn = async val => ({ ...val, touched: true })
+const getBaseObj = () => ({
+  aPlugin: {
+    string: 'abc',
+    number: 123,
+    obj: { foo: 'bar' },
+    target$map: { fn },
+    target: {
+      fn: { isTarget: true, touched: false }
+    }
+  }
+})
+
+it('converts objects to arrays', async () => {
+  const config = getBaseObj()
+  const result = await keysAsFunctionsRecursive(config)
+
+  expect(result).toEqual({
+    aPlugin: {
+      string: 'abc',
+      number: 123,
+      obj: { foo: 'bar' },
+      target: [
+        {
+          "isTarget": true,
+          "touched": true,
+        },
+      ]
+    }
+  })
+})
+
+it('processes children first', async () => {
+  const config = getBaseObj()
+  config.aPlugin.target.fn.child = { fn: { isTarget: true, touched: false } }
+  config.aPlugin.target.fn.child$map = { fn }
+
+
+  const result = await keysAsFunctionsRecursive(config)
+
+  expect(result).toEqual({
+    aPlugin: {
+      string: 'abc',
+      number: 123,
+      obj: { foo: 'bar' },
+      target: [
+        {
+          isTarget: true,
+          touched: true,
+          child: [{
+            isTarget: true,
+            touched: true,
+          }]
+        },
+      ]
+    }
+  })
+})

Original file line number	Diff line number	Diff line change
`@@ -3,9 +3,15 @@ export default {`
`3`	`3`	`{`
`4`	`4`	`event: 'start',`
`5`	`5`	`action: async (app, params, ctx) => {`
`6`		`- app.config.svelte = {`
`7`		`- extensions: []`
`8`		`- }`
	`6`	`+ app.merge({`
	`7`	`+ config: {`
	`8`	`+ svelte: {`
	`9`	`+ extensions: ['.svelte'],`
	`10`	`+ preprocess: {},`
	`11`	`+ preprocess$map: {}`
	`12`	`+ }`
	`13`	`+ }`
	`14`	`+ })`
`9`	`15`	`}`
`10`	`16`	`}`
`11`	`17`	`]`