wip(core): Work on v3

packages/core/src/design.mjs

@@ -1,43 +1,40 @@
 import Pattern from './pattern.mjs'
 import { addPartConfig } from './utils.mjs'
 
+
 /*
  * The Design constructor. Returns a Pattern constructor
  * So it's sort of a super-constructor
  */
-export default function Design(config, plugins = false, conditionalPlugins = false) {
-  // Add part options/measurements/optionalMeasurements to config
-  if (!config.options) config.options = {}
-  if (!config.measurements) config.measurements = []
-  if (!config.optionalMeasurements) config.optionalMeasurements = []
-  if (Array.isArray(config.parts)) {
-    const parts = {}
-    for (const part of config.parts) {
-      if (typeof part === 'object') {
-        parts[part.name] = part
-        config = addPartConfig(parts[part.name], config)
-      } else if (typeof part === 'string') {
-        parts[part] = part
-      } else throw("Part should be passed as a name of part config object")
-    }
-    config.parts = parts
-  }
+export default function Design(config) {
 
-  // Ensure all options have a hide() method
-  config.options = optionsWithHide(config.options)
+  // Merge config with defaults
+  config = {
+    parts: [],
+    options: {},
+    measurements: [],
+    optionalMeasurements: [],
+    plugins: [],
+    conditionalPlugins: [],
+    ...config
+  }
+  const parts = {}
+  for (const part of config.parts) {
+    if (typeof part === 'object') {
+      parts[part.name] = part
+      config = addPartConfig(parts[part.name], config)
+    }
+    else throw("Invalid part configuration. Part is not an object")
+  }
+  // Replace config.parts with the resolved config
+  config.parts = parts
+
+  // Ensure all options have a hide() method and menu property
+  config.options = completeOptions(config.options)
 
   // A place to store deprecation and other warnings before we even have a pattern instantiated
   config.warnings = []
 
-  /*
-   * The newer way to initalize a design is to pass one single parameter
-   * The old way passed multiple parameters.
-   * So let's figure out which is which and be backwards compatible
-   *
-   * This mitigation should be removed in v3 when we drop support for the legacy way
-   */
-  config = migrateConfig(config, plugins, conditionalPlugins)
-
   const pattern = function (settings) {
     Pattern.call(this, config)
 
@@ -66,55 +63,22 @@ export default function Design(config, plugins = false, conditionalPlugins = fal
   return pattern
 }
 
-/*
- * Helper method to handle the legacy way of passing configuration
- * to the design constructor
- */
-const migrateConfig = (config, plugins, conditionalPlugins) => {
-
-  // Migrate plugins
-  if (plugins && config.plugins) config.warnings.push(
-    'Passing plugins to the Design constructor both as a second parameter and in the config is unsupported',
-    'Ignoring plugins passed as parameter. Only config.plugins will be used.'
-  )
-  else if (plugins && !config.plugins) {
-    config.plugins = plugins
-    config.warnings.push(
-      'Passing a plugins parameter to the Design constructure is deprecated',
-      'Please store them in the `plugins` key of the config object that is the first parameter'
-    )
-  } else if (!config.plugins) config.plugins = []
-
-  // Migrate conditional plugins
-  if (conditionalPlugins && config.conditionalPlugins) config.warnings.push(
-    'Passing conditionalPlugins to the Design constructor both as a third parameter and in the config is unsupported.',
-    'Ignoring conditionalPlugins passes as parameter. Only config.conditionalPlugins will be used.',
-  )
-  else if (conditionalPlugins && !config.conditionalPlugins) {
-    config.conditionalPlugins = conditionalPlugins
-    config.warnings.push(
-      'Passing a conditionalPlugins parameter to the Design constructure is deprecated.',
-      'Please store them in the `conditionalPlugins` key of the config object that is the first parameter'
-    )
-  }
-  else if (!config.conditionalPlugins) config.conditionalPlugins = []
-
-  return config
-}
-
 /*
  * A default hide() method for options that lack it
- * Since this will always return false, the option will never be hidden
+ * As this always return false, the option will never be hidden
  */
-const hide = () => false // The default hide() method
+const hide = () => false
 
 /*
  * Helper method to add the default hide() method to options who lack one
+ * as well as set the `menu` property to false (if it's missing)
  */
-const optionsWithHide = options => {
+const completeOptions = options => {
   if (options) {
     for (const option in options) {
-      if (typeof options[option] === 'object') options[option] = { hide, ...options[option] }
+      if (typeof options[option] === 'object') {
+        options[option] = { hide, menu: false, ...options[option] }
+      }
     }
   }