Montage Require (aka mr)

This is a CommonJS module system, highly compatible with NodeJS, intended for front-end development of web applications using npm style packages. It is designed to be automatically replaced by the Montage Optimizer with a smaller, faster and bundled production module system.

Mr is installed as a package in your application using npm:

$ npm init                  # if you don't already have a package.json
$ npm install --save mr

In an HTML file next to your package.json add the Mr script and provide a module to load:

<script src="node_modules/mr/bootstrap.js" data-module="index"></script>

Start writing your code in index.js, using the require function as you would in Node. Have a look at the demo for working example.

You can place your package.json in a different location, or avoid having one at all, with other script tag attributes.

Optimization

Take a look at Mop, the Montage Optimizer to optimize applications for production. The optimizer can bundle packages with all of the dependent modules, can preload bundles of progressive enhancements in phases, and can generate HTML5 application cache manifests.

Documentation

Mr is compatible with Node and npm, although there are some differences.

There is documentation for:

• package.json properties
• require function
• module object
• The package config object

And you may be interested in an in-depth look at how Mr works.

Compatibility

At present, Mr depends on document.querySelector and probably several other recent EcmaScript methods that might not be available in legacy browsers. With your help, I intend to isolate and fix these bugs.

At time of writing, tests pass in Chrome 21, Safari 5.1.5, and Firefox 13 on Mac OS 10.6.

Maintenance

Tests are in the spec directory. Use npm test to run the tests in NodeJS or open spec/run.html in a browser.

To run the tests in your browser, simply use npm run test:jasmine.

To run the tests using Karma use npm run test:karma and for continious tests run with file changes detection npm run test:karma-dev.

About

This implementation is a part from Motorola Mobility’s Montage web application framework. The module system was written by Tom Robinson and Kris Kowal. Motorola holds the copyright on much of the original content, and provided it as open source under the permissive BSD 3-Clause license. This project is maintained by Kris Kowal and Stuart Knightley, continuing with that license.

17.0.12

• Fix commented require issue
• Add support for require('dir') dir/index.js

17.0.0

• Update Travis NodeJS to 4.8.0
• Migrate Montage custom loaders to MontageRequire
  • Import support for module types html, mjson and reel from Montage.js
  • Import module metadata annotation from Montage.js
• Upgrade tests stack
  • Migrate specs to Jasmine 2.5.2O (npm run test:jasmine)
  • Revamp NodeJS tests runner (npm test)
  • Migrate Phantom.js tests runner to Karma (npm run test:karma)

16.0.4

• Memory optimization by caching a regex and making sure XHRs that are re-used don’t hold on their responses by calling abort() after the request succeeded or failed
  • Minimize object creation and closure scope
  • speed optimization
    • reducing scope lookup
    • reducing scope lookup in closure

16.0.3

• updates bluebird dependency to ~3.4.6

16.0.2

• Fixes a bug where a JSON module would fail to load because it would try to re-parse the content while it was already done

16.0.1

• Addresses an issue caused by IE11 non-standard Map.prototype.set that returns undefined instead of Map itself

16.0.0

• Performance Improvements

0.15.7

• Don't load Mr's devDependencies into the mappings

0.15.6

• Update Q to v1.0.1

0.15.5

• Disable Firebug workaround that breaks modern Firefox

0.15.4

• Fix display name for packages beginning with digits

0.15.3

• Revert sourceMappingURL change, causes issues in Chrome and doesn't work great in Firefox.

0.15.2

• Change //@ for //# for SourceURL comment to match the spec
• Use sourceMappingURL instead of sourceURL. This allows the evaled code to appear as source files in Firefox.
• Friendlier display names for modules: __FILE__http______localhost__8081__montagejs__mr__demo__data__ is now mr_demo__data

0.15.1

• Fix requiring dependencies with ".js" in their name in script-injection mode (thanks @evax)
• Fix requiring twice a module that throws an error

0.15.0

• Added moduleTypes config parameter so that all loadable extensions are known. This fixes a bug where modules with a "." in them would not be loaded as JavaScript modules. When implementing a custom extension loader you must add the extension to the config.moduleTypes array when loading a package.

0.14.2

• Use overlays in config given to loadPackage.

0.14.1

• Correct extension detection

0.14.0

• Remove support for directories package.json property. Node ignores the property, and continuing to support it breaks compatibility
• Remove support for package reflexive module names
• Fix main linkage for relative identifiers. Previously, a package with a main property that started with "./" would be linked incorrectly.
• Fix loading of modules with a .min.js extension
• Don't block XHR for the file: protocol. Firefox and Safari allow it as long as requests remain within the HTML page's directory.
• Add support for the browser property in package.json, as pioneered by Browserify
• Add "sandbox", to inject dependencies into a module. Require with require("mr/sandbox")

0.13.4

• Update Q from v0.9.6 to v0.9.7
• Fix loading of bundles
• Wait for preload to finish before issuing requests for modules that might be included in one of the bundles

0.13.3

• Use config.read when running on Node

0.13.2

• Use config.read to load package.json if given to loadPackage

0.13.1

• Fix require.identify to work with cyclic package dependencies

0.13.0

• Fix bootstrap stopping if document had finished loading.
• Update to Q v0.9.6
• Add more complete demo and split the readme into multiple documentation files.

0.12.14

• Fix bug when loading dependencies that use script-injection which are not included in a preloading bundle. Before Mr would hang when waiting for them to load.

0.12.13

• Fix bug in preloading, where isResolved was replaced with isPending in Q 0.9

0.12.12

• Fix preloading. Fixes some logic in figuring out whether to issue a script request for a package.json in production
• Test runner updates

0.12.11

• Add injectDependency and injectMapping
• Update case sensitivity test to capture errors on first require, for case sensitive file systems
• Add support for running tests under PhantomJS and Travis

0.12.10

• Update Q from v0.9.0 to v0.9.2

0.12.9

• Update Q from v0.8.12 to v0.9.0

0.12.8

• Defer throwing load errors to execution (Fixes #14)
• Update bootstrapping for latest Q

0.12.7

• Support returned exports in bootstrapping
• Export more Node utilities (when used on Node)
  • Require.urlToPath -> Require.locationToPath(location)
  • Add Require.filePathToLocation(path)
  • Add Require.directoryPathToLocation(path)
  • Add Require.findPackagePath(directory)
  • Add Require.findPackageLocationAndModuleId(path)

0.12.6

• Add support for production mode. Currently causes Mr to ignore devDependencies

0.12.5

• Update Q to 0.8.12