mirror of
https://github.com/nasa/openmct.git
synced 2025-06-17 06:38:17 +00:00
[Framework] Add RequireJS configurator
Add a configuration step (as part of the resolve phase) to the framework layer, where bundle-defined paths and shims are passed to RequireJS configuration. This permits both the use of non-AMD modules and the exposure of libraries across bundles. WTD-568.
This commit is contained in:
@ -15,7 +15,7 @@ define(
|
||||
*
|
||||
* @constructor
|
||||
*/
|
||||
function BundleResolver(extensionResolver, $log) {
|
||||
function BundleResolver(extensionResolver, requireConfigurator, $log) {
|
||||
|
||||
/**
|
||||
* Merge resolved bundles (where each is expressed as an
|
||||
@ -88,6 +88,10 @@ define(
|
||||
* extensions belonging to those categories
|
||||
*/
|
||||
resolveBundles: function (bundles) {
|
||||
// First, make sure Require is suitably configured
|
||||
requireConfigurator.configure(bundles);
|
||||
|
||||
// Then, resolve all extension implementations.
|
||||
return Promise.all(bundles.map(resolveBundle))
|
||||
.then(mergeResolvedBundles);
|
||||
}
|
||||
|
90
platform/framework/src/resolve/RequireConfigurator.js
Normal file
90
platform/framework/src/resolve/RequireConfigurator.js
Normal file
@ -0,0 +1,90 @@
|
||||
/*global define*/
|
||||
|
||||
define(
|
||||
[],
|
||||
function () {
|
||||
"use strict";
|
||||
|
||||
/**
|
||||
* Handles configuration of RequireJS to expose libraries
|
||||
* from bundles with module names that can be used from other
|
||||
* bundles.
|
||||
* @constructor
|
||||
* @param requirejs an instance of RequireJS
|
||||
*/
|
||||
function RequireConfigurator(requirejs) {
|
||||
// Utility function to clone part of a bundle definition
|
||||
function clone(obj) {
|
||||
return JSON.parse(JSON.stringify(obj));
|
||||
}
|
||||
|
||||
// Look up module configuration from the bundle definition.
|
||||
// This will adjust paths to libraries as-needed.
|
||||
function getConfiguration(bundle) {
|
||||
var configuration = bundle.getConfiguration();
|
||||
|
||||
// Adjust paths to point to libraries
|
||||
if (configuration.paths) {
|
||||
// Don't modify the actual bundle definition...
|
||||
configuration = configuration.clone(configuration);
|
||||
// ...replace values in a clone instead.
|
||||
Object.keys(configuration.paths).forEach(function (path) {
|
||||
configuration.paths[path] =
|
||||
bundle.getLibraryPath(configuration.paths[path]);
|
||||
});
|
||||
}
|
||||
|
||||
return configuration;
|
||||
}
|
||||
|
||||
// Build up paths and shim values from multiple bundles;
|
||||
// this is sensitive to the value from baseConfiguration
|
||||
// passed via reduce in buildConfiguration below, insofar
|
||||
// as it assumes paths and shim will have initial empty values.
|
||||
function mergeConfigurations(base, next) {
|
||||
["paths", "shim"].forEach(function (k) {
|
||||
Object.keys(next[k] || {}).forEach(function (p) {
|
||||
base[k][p] = next[k][p];
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
// Build a configuration object, to pass to requirejs.config,
|
||||
// based on the defined configurations for all bundles.
|
||||
// The paths and shim properties from all bundles will be
|
||||
// merged to allow one requirejs.config call.
|
||||
function buildConfiguration(bundles) {
|
||||
// Provide an initial requirejs configuration...
|
||||
var baseConfiguration = {
|
||||
baseUrl: "",
|
||||
paths: {},
|
||||
shim: {}
|
||||
},
|
||||
// ...and pull out all bundle-specific parts
|
||||
bundleConfigurations = bundles.map(getConfiguration);
|
||||
|
||||
// Reduce this into one configuration object.
|
||||
return bundleConfigurations.reduce(
|
||||
mergeConfigurations,
|
||||
baseConfiguration
|
||||
);
|
||||
}
|
||||
|
||||
return {
|
||||
/**
|
||||
* Configure RequireJS to utilize any path/shim definitions
|
||||
* provided by these bundles.
|
||||
*
|
||||
* @param {Bundle[]} the bundles to include in this
|
||||
* configuration
|
||||
*/
|
||||
configure: function (bundles) {
|
||||
return requirejs.config(buildConfiguration(bundles));
|
||||
}
|
||||
};
|
||||
}
|
||||
|
||||
return RequireConfigurator;
|
||||
|
||||
}
|
||||
);
|
Reference in New Issue
Block a user