cjs2: Recursive CommonJS Loader Plugin for RequireJS

Load CommonJS modules without needing to convert them to AMD. Any dependency will also be loaded through cjs2, unless specified otherwise in the require configuration.

Adapted from the CommonJS Loader Plugin for RequireJS (cjs).

AMD and CommonJS are actually incredibly similar formats so this plugin is very short.

Usage

To load a CommonJS module in RequireJS simply do:

require(['cjs2!my-commonjs-module'], function(mymodule) {
  // Do something
});

How it works

If your module looks like:

var someDep = require('a-dependency');
exports.out = 'asdf';

…then it is dynamically converted into:

define(function(require, exports, module) {
(function() {
  var define = undefined; // ensures any amd detection is disabled
  var someDep = require('cjs2!a-dependency');
  exports.out = 'asdf';
})();
});

…which is the AMD module format.

Dependencies are naturally handled by referring back to the plugin.

Supports:

• Cross-origin dynamic loading
• Builds
• Precompilation with the optimizeAllPluginResources r.js build option
• Amazingness

Built with the AMD-Loader plugin helper.

Use global require for sub-dependencies

In some cases, we replace some sub-dependencies by modules that are not in CommonJS format. In such situations, we can have cjs2 plugin use the global require instead of recursively using cjs2 to load those modules. Use the require.config.cjs2config.globalRequire array to list those modules:

require.config({
  cjs2config: {
    globalRequire: [
        'path', // List of modules (sub-dependencies) that should be loaded through global require instead of cjs2
        'unfetch'
    ]
  }
});

Install

volo add ghybs/cjs2

If not using package management, ensure that the AMD-Loader plugin is installed.

License

The cjs2 loader plugin is distributed under the MIT License (Expat type), like the CommonJS Loader Plugin for RequireJS (cjs).