Pull request Compare This branch is 89 commits behind amdjs:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
impl/requirejs
tests
README.md
start.html
tasks.txt

README.md

AMD Tests

A set of Asynchronous Module Definition AMD compliance tests.

Right now the tests only run in the browser, but it will be possible to run them in Node and Rhino.

Configuration

An implementation needs to have the following two files in the impl directory:

  • AMD loader implementation
  • configure script

The configure script should define the following global variables:

  • config: a function that accepts configuration parameters. Similar to the RequireJS form of require({}).

  • go: a function that implements the top level, global function that starts loading of modules. Equivalent to the RequireJS global require([], function(){}) signature.

  • implemented: an object whose properties are the types of tests that the loader expects to pass.

Test Types

Each test type builds on the other: supporting later test types implies support for earlier test types.

basic

Very basic loading of named modules that have dependency arrays.

  • Support for define.amd to indicate an AMD loader.
  • Named modules.
  • Dependency arrays.
  • Circular dependency support via the "exports" and "require" dependency.
  • Test for the CommonJS "module" dependency.

anon

Similar tests to basic, but using anonymous modules.

funcString

Tests parsing of definition functions via Function.prototype.toString() to get out dependencies. Used to support simplified module wrapping:

    define(function (require) {
        var a = require('a');
        //Return the module definition.
        return {};
    });

plugins

Support for loader plugins.

  • Calling the same plugin resource twice and getting the same value.
  • Testing a plugin that implements normalize().
  • Testing a plugin that uses load.fromText().

Running the tests

Run the tests through a web server. The URL should look like the following:

http://127.0.0.1/amd-tests/tests/doh/runner.html?config=path/to/config.js&impl=path/to/loader.js

Where both the config and impl paths are paths that are inside the impl directory in this project.

To run the tests using the version of RequireJS in this repository:

http://127.0.0.1/amd-tests/tests/doh/runner.html?config=requirejs/config.js&impl=requirejs/require.js

Or, use the start.html page for a page of quick links to start testing.