Addons can provide their resolver module configuration via resolverConfig()

index.js

@@ -1,9 +1,25 @@
 'use strict';
 
+var writeFile = require('broccoli-file-creator');
 var VersionChecker = require('ember-cli-version-checker');
 var path = require('path');
 var isModuleUnification;
 
+function mergeRecursivelyAddonResolverConfig(config, addon) {
+
+  if (!config.hasOwnProperty(addon.name)) {
+
+    if (addon.resolverConfig) {
+      config[addon.name] = addon.resolverConfig() || {};
+    }
+
+    addon.addons.forEach(nestedAddon => {
+      mergeRecursivelyAddonResolverConfig(config, nestedAddon);
+    });
+  }
+
+}
+
 module.exports = {
   name: 'ember-resolver',
 
@@ -57,7 +73,60 @@ module.exports = {
     return new MergeTrees(addonTrees);
   },
 
-  _moduleUnificationTrees() {
+  // Trigger exception if the result of `addon.resolverConfig` method has an unexpected format
+  // Show a warning if there are collisions between addon types or addon collections
+  validateAddonsConfig: function(addonsConfig) {
+
+    let types = {};
+    let collections = {};
+
+    Object.keys(addonsConfig).forEach(addonName => {
+
+      let addonConfig = addonsConfig[addonName];
+      if (addonConfig) {
+        if (typeof(addonConfig) !== 'object') {
+          throw new Error(`"addon.resolverConfig" returns an unexpected value. Addon: ${addonName}.`);
+        }
+
+        let addonTypes = addonConfig.types || {};
+        if (typeof(addonTypes) !== 'object') {
+          throw new Error(`"addon.resolverConfig" returns an unexpected "types" value. Addon: ${addonName}.`);
+        }
+
+        let addonCollections = addonConfig.collections || {};
+        if (typeof(addonCollections) !== 'object') {
+          throw new Error(`"addon.resolverConfig" returns an unexpected "collections" value. Addon: ${addonName}.`);
+        }
+
+        Object.keys(addonTypes).forEach(key => {
+          if (!types.hasOwnProperty(key)) {
+            types[key] = key;
+          } else {
+            this.ui.writeLine(`Addon '${types[key]}' configured the type '${key}' on the resolver, but addon '${addonName}' has overwritten the type '${key}'.`);
+          }
+        });
+        Object.keys(addonCollections).forEach(key => {
+          if (!collections.hasOwnProperty(key)) {
+            collections[key] = key;
+          } else {
+            this.ui.writeLine(`Addon '${types[key]}' configured the collection '${key}' on the resolver, but addon '${addonName}' has overwritten the collection '${key}'.`);
+          }
+        });
+      }
+    });
+  },
+
+  _moduleUnificationTrees: function() {
+
+    let addonConfigs = {};
+
+    this.project.addons.forEach(addon => {
+      mergeRecursivelyAddonResolverConfig(addonConfigs, addon);
+    });
+    this.validateAddonsConfig(addonConfigs);
+
+    let addonConfigsFileContent = `export default ${JSON.stringify(addonConfigs)};`;
+
     var resolve = require('resolve');
     var Funnel = require('broccoli-funnel');
 
@@ -66,6 +135,11 @@ module.exports = {
       destDir: 'ember-resolver'
     });
 
+    var addonsConfigTree = writeFile(
+      'ember-resolver/addons-config.js',
+      addonConfigsFileContent
+    );
+
     var glimmerResolverSrc = require.resolve('@glimmer/resolver/package');
     var glimmerResolverPath = path.dirname(glimmerResolverSrc);
     var glimmerResolverTree = new Funnel(glimmerResolverPath, {
@@ -80,6 +154,7 @@ module.exports = {
     });
 
     return [
+      this.preprocessJs(addonsConfigTree, { registry: this.registry }),
       this.preprocessJs(featureTree, { registry: this.registry }),
       this.preprocessJs(glimmerResolverTree, { registry: this.registry }),
       this.preprocessJs(glimmerDITree, { registry: this.registry }),

mu-trees/addon/ember-config.js

@@ -1,115 +1,17 @@
-/*
- * This config describes canonical Ember, as described in the
- * module unification spec:
- *
- *   https://github.com/emberjs/rfcs/blob/master/text/0143-module-unification.md
- *
- */
+import addonsConfig from 'ember-resolver/addons-config';
+import moduleConfig from 'ember-resolver/module-config';
+import mergeAddonsConfig from 'ember-resolver/utils/merge-addons-config';
+
 export default function generateConfig(name) {
-  return {
+
+  let config = {
     app: {
       name,
       rootName: name
     },
-    types: {
-      adapter: { definitiveCollection: 'models' },
-      application: { definitiveCollection: 'main' },
-      config: { definitiveCollection: 'config' },
-      controller: { definitiveCollection: 'routes' },
-      component: { definitiveCollection: 'components' },
-      'component-lookup': { definitiveCollection: 'main' },
-      'component-manager': { definitiveCollection: 'component-managers' },
-      event_dispatcher: { definitiveCollection: 'main' },
-      helper: { definitiveCollection: 'components' },
-      initializer: { definitiveCollection: 'initializers' },
-      'instance-initializers': { definitiveCollection: 'instance-initializer' },
-      location: { definitiveCollection: 'main' },
-      model: { definitiveCollection: 'models' },
-      modifier: { definitiveCollection: 'components' },
-      'modifier-manager': { definitiveCollection: 'modifier-managers' },
-      partial: { definitiveCollection: 'partials' },
-      renderer: { definitiveCollection: 'main' },
-      route: { definitiveCollection: 'routes' },
-      router: { definitiveCollection: 'main' },
-      'route-map': { definitiveCollection: 'main' },
-      serializer: { definitiveCollection: 'models' },
-      service: { definitiveCollection: 'services' },
-      template: { definitiveCollection: 'components' },
-      'template-compiler': { definitiveCollection: 'main' },
-      transform: { definitiveCollection: 'transforms' },
-      view: { definitiveCollection: 'views' },
-      '-view-registry': { definitiveCollection: 'main' },
-      '-bucket-cache': { definitiveCollection: 'main' },
-      '-environment': { definitiveCollection: 'main' },
-      '-application-instance': { definitiveCollection: 'main' }
-    },
-    collections: {
-      'main': {
-        types: ['router', '-bucket-cache', 'component-lookup', '-view-registry', 'event_dispatcher', 'application', 'location', 'renderer', '-environment', '-application-instance', 'route-map']
-      },
-      components: {
-        group: 'ui',
-        privateCollections: ['utils'],
-        types: ['component', 'helper', 'template', 'modifier']
-      },
-      'component-managers': {
-        types: ['component-manager']
-      },
-      config: {
-        unresolvable: true
-      },
-      initializers: {
-        group: 'init',
-        defaultType: 'initializer',
-        privateCollections: ['utils'],
-        types: ['initializer']
-      },
-      'instance-initializers': {
-        group: 'init',
-        defaultType: 'instance-initializer',
-        privateCollections: ['utils'],
-        types: ['instance-initializers']
-      },
-      models: {
-        group: 'data',
-        defaultType: 'model',
-        privateCollections: ['utils'],
-        types: ['model', 'adapter', 'serializer']
-      },
-      'modifier-managers': {
-        types: ['modifier-manager']
-      },
-      partials: {
-        group: 'ui',
-        defaultType: 'partial',
-        privateCollections: ['utils'],
-        types: ['partial']
-      },
-      routes: {
-        group: 'ui',
-        defaultType: 'route',
-        privateCollections: ['components', 'utils'],
-        types: ['route', 'controller', 'template']
-      },
-      services: {
-        defaultType: 'service',
-        privateCollections: ['utils'],
-        types: ['service']
-      },
-      utils: {
-        unresolvable: true
-      },
-      views: {
-        defaultType: 'view',
-        privateCollections: ['utils'],
-        types: ['view']
-      },
-      transforms: {
-        group: 'data',
-        defaultType: 'transform',
-        privateCollections: ['utils'],
-        types: ['transform']
-      }
-    }
   };
+
+  mergeAddonsConfig(moduleConfig, addonsConfig);
+
+  return Object.assign(config, moduleConfig);
 }

mu-trees/addon/module-config.js

@@ -0,0 +1,109 @@
+/*
+ * This config describes canonical Ember, as described in the
+ * module unification spec:
+ *
+ *   https://github.com/emberjs/rfcs/blob/master/text/0143-module-unification.md
+ *
+ */
+export default {
+  types: {
+    adapter: { definitiveCollection: 'models' },
+    application: { definitiveCollection: 'main' },
+    config: { definitiveCollection: 'config' },
+    controller: { definitiveCollection: 'routes' },
+    component: { definitiveCollection: 'components' },
+    'component-lookup': { definitiveCollection: 'main' },
+    'component-manager': { definitiveCollection: 'component-managers' },
+    event_dispatcher: { definitiveCollection: 'main' },
+    helper: { definitiveCollection: 'components' },
+    initializer: { definitiveCollection: 'initializers' },
+    'instance-initializers': { definitiveCollection: 'instance-initializer' },
+    location: { definitiveCollection: 'main' },
+    model: { definitiveCollection: 'models' },
+    modifier: { definitiveCollection: 'components' },
+    'modifier-manager': { definitiveCollection: 'modifier-managers' },
+    partial: { definitiveCollection: 'partials' },
+    renderer: { definitiveCollection: 'main' },
+    route: { definitiveCollection: 'routes' },
+    router: { definitiveCollection: 'main' },
+    'route-map': { definitiveCollection: 'main' },
+    serializer: { definitiveCollection: 'models' },
+    service: { definitiveCollection: 'services' },
+    template: { definitiveCollection: 'components' },
+    'template-compiler': { definitiveCollection: 'main' },
+    transform: { definitiveCollection: 'transforms' },
+    view: { definitiveCollection: 'views' },
+    '-view-registry': { definitiveCollection: 'main' },
+    '-bucket-cache': { definitiveCollection: 'main' },
+    '-environment': { definitiveCollection: 'main' },
+    '-application-instance': { definitiveCollection: 'main' }
+  },
+  collections: {
+    'main': {
+      types: ['router', '-bucket-cache', 'component-lookup', '-view-registry', 'event_dispatcher', 'application', 'location', 'renderer', '-environment', '-application-instance', 'route-map']
+    },
+    components: {
+      group: 'ui',
+      privateCollections: ['utils'],
+      types: ['component', 'helper', 'template', 'modifier']
+    },
+    'component-managers': {
+      types: ['component-manager']
+    },
+    config: {
+      unresolvable: true
+    },
+    initializers: {
+      group: 'init',
+      defaultType: 'initializer',
+      privateCollections: ['utils'],
+      types: ['initializer']
+    },
+    'instance-initializers': {
+      group: 'init',
+      defaultType: 'instance-initializer',
+      privateCollections: ['utils'],
+      types: ['instance-initializers']
+    },
+    models: {
+      group: 'data',
+      defaultType: 'model',
+      privateCollections: ['utils'],
+      types: ['model', 'adapter', 'serializer']
+    },
+    'modifier-managers': {
+      types: ['modifier-manager']
+    },
+    partials: {
+      group: 'ui',
+      defaultType: 'partial',
+      privateCollections: ['utils'],
+      types: ['partial']
+    },
+    routes: {
+      group: 'ui',
+      defaultType: 'route',
+      privateCollections: ['components', 'utils'],
+      types: ['route', 'controller', 'template']
+    },
+    services: {
+      defaultType: 'service',
+      privateCollections: ['utils'],
+      types: ['service']
+    },
+    utils: {
+      unresolvable: true
+    },
+    views: {
+      defaultType: 'view',
+      privateCollections: ['utils'],
+      types: ['view']
+    },
+    transforms: {
+      group: 'data',
+      defaultType: 'transform',
+      privateCollections: ['utils'],
+      types: ['transform']
+    }
+  }
+};

mu-trees/addon/utils/merge-addons-config.js

@@ -0,0 +1,43 @@
+/*
+   This function merges the types and collections from addons `addonsConfig` into `config`.
+
+   It will throw an exception if an addon tries to override
+   an existing type or collection on the resolver config object or
+   if two addons provide the same type or collection.
+
+   - `config`: is a resolver config object.
+
+   - `addonsConfig`: is a hash object containing the result of the call of
+      `addon.resolverConfig` method on all the project addons.
+
+     ```js
+     {
+      my-addon1: { types: { ... } },
+      my-addon2: { collections: { ... } },
+      hola-addon: { types: { ... }, collections: { ... } }
+     }
+     ```
+ */
+export default function mergeAddonsConfig(config, addonsConfig) {
+
+  Object.keys(addonsConfig).forEach(function (addonName) {
+    let addonConfig = addonsConfig[addonName];
+    let addonTypes = addonConfig.types || {};
+    let addonCollections = addonConfig.collections || {};
+
+    Object.keys(addonTypes).forEach(function (key) {
+      if (!config.types.hasOwnProperty(key)) {
+        config.types[key] = addonTypes[key];
+      } else {
+        throw new Error(`Addon '${addonName}' attempts to configure the type '${key}' on the resolver but '${key}' has already been configured.`);
+      }
+    });
+    Object.keys(addonCollections).forEach(function (key) {
+      if (!config.collections.hasOwnProperty(key)) {
+        config.collections[key] = addonCollections[key];
+      } else {
+        throw new Error(`Addon '${addonName}' attempts to configure the collection '${key}' on the resolver but '${key}' has already been configured.`);
+      }
+    });
+  });
+}