requirejs / xrayquire Goto Github PK

An auxillary script that gives extra info on the use of requirejs in a web page.

License: Other

JavaScript 98.02% HTML 1.98%

xrayquire's Introduction

RequireJS

RequireJS loads plain JavaScript files as well as more defined modules. It is optimized for in-browser use, including in a Web Worker, but it can be used in other JavaScript environments, like Rhino and Node. It implements the Asynchronous Module API.

RequireJS uses plain script tags to load modules/files, so it should allow for easy debugging. It can be used simply to load existing JavaScript files, so you can add it to your existing project without having to re-write your JavaScript files.

RequireJS includes an optimization tool you can run as part of your packaging steps for deploying your code. The optimization tool can combine and minify your JavaScript files to allow for better performance.

If the JavaScript file defines a JavaScript module via define(), then there are other benefits RequireJS can offer: improvements over traditional CommonJS modules and loading multiple versions of a module in a page. RequireJS also has a plugin system that supports features like i18n string bundles, and text file dependencies.

RequireJS does not have any dependencies on a JavaScript framework.

RequireJS works in IE 6+, Firefox 2+, Safari 3.2+, Chrome 3+, and Opera 10+.

Latest Release

License

MIT

Code of Conduct

jQuery Foundation Code of Conduct.

Directories

dist: Scripts and assets to generate the requirejs.org docs, and for generating a require.js release.
docs: The raw HTML files for the requirejs.org docs. Only includes the body of each page. Files in dist are used to generate a complete HTML page.
tests: Tests for require.js.
testBaseUrl.js: A file used in the tests inside tests. Purposely placed outside the tests directory for testing paths that go outside a baseUrl.
updatesubs.sh: Updates projects that depend on require.js Assumes the projects are siblings to this directory and have specific names. Useful to copy require.js to dependent projects easily while in development.

Tests

This repo assumes some other repos are checked out as siblings to this repo:

git clone https://github.com/requirejs/text.git
git clone https://github.com/requirejs/i18n.git
git clone https://github.com/requirejs/domReady.git
git clone https://github.com/requirejs/requirejs.git

So when the above clones are done, the directory structure should look like:

domReady
i18n
text
requirejs (this repo)

You will need to be connected to the internet because the JSONP and remoteUrls tests access the internet to complete their tests.

Serve the directory with these 4 siblings from a web server. It can be a local web server.

Open requirejs/tests/index.html in all the browsers, click the arrow button to run all the tests.

xrayquire's People

Contributors

Stargazers

Watchers

Forkers

maxlk leachryanb maxbc davidmccabe wyantb akumpf dahmian facundocabrera nguyenlamzx pressreader dulumao runt18 zx204721 isabella232

xrayquire's Issues

Inform when two modules map to same path but did not include both modules

From requirejs/requirejs#381: @bnickel suggested there be a way to get notifications when the module IDs that are set to the same path but do not include both modules give some sort of message, like:

Timeout on file 'appA/Module2.js'.
    Expected definition(s) for 'app/Module2' and 'appA/Module2'.
   Got definition(s) for 'app/Module2' (inferred).

Better 'mismatched anonymous define' info

Originally logged as requirejs/requirejs#334: right now the error does not really help identify the source:

Error: Mismatched anonymous define() module: [object Object]

Look at printing out any dependency array, any function, and if an object literal, iterate over the properties to give an idea of what define() call was bad.

Show a graphic representation of the dependencies involved

Ideally, hook into the new Module code as well as onResourceLoad, to show what was requested/known and what got executed.

Call out circular dependencies.

Do a pretty graph. https://github.com/pahen/node-madge might be good to consult, but do something that can be generated in the browser.

Give error when shim is used on a module that calls define() already.

Triggered from this thread:

http://groups.google.com/group/requirejs/browse_thread/thread/e8381a7ffe36d8dd

Make sure it works with minified require.js

There was a report on twitter that it did not work with the minified require.js

Provide a way for node to use and report the results in a build

It would be nice if this gave a console report so that we can add it to our build process.

Not working with requirejs 2.2.0

Uncaught TypeError: Cannot read property 'prototype' of undefined
at modProto = context.Module.prototype,

Warn if module ID is outside baseUrl

This came up as part of requirejs/requirejs#448: a module ID was outside the baseUrl, so it kept some '../' references, which led to two different modules in play. Warn if this is occurring.

Warn if data-main does not match a module ID that gets loaded

With the requirejs 2.0 "only execute modules that are explicitly required", a build may specify the build file to be named "main", but the data-main value may not match that string.

Can xrayquire be added after everything is loaded?

Would be handy as a way to leave xrayquire out of the page HTML, but when debugging, just drop a line into the console like this:

$.getScript("https://raw.github.com/requirejs/xrayquire/master/xrayquire.js", function(){xrayquire.showTree();})

That line will work (it fetches and executes) but none of the modules show up. Thoughts?

Warn on possible mixed-case issues

See this ticket for more information:

requirejs/requirejs#270

ShowCycles Blocked By Pop-Up Blocker

For the longest time I thought that showCycles just didn't work, but then today for the first time I noticed a little flash in the corner and realized that it's always worked ... it was just getting blocked by Chrome!

I'm not sure how much you can actually do to prevent this behavior, seeing as how it's coming from the browser itself, but putting a note in the documentation might really help other Chrome users who failed to notice the (very small) blocked pop-up notice.