#[jQuery](https://jquery.com/)— New Wave JavaScript
ajax/script: TheAJAX transport only; used to retrieve scripts.
ajax/jsonp: The JSONP AJAX transport only; depends on the ajax/script transport.
css: The.css()method. Also removesallmodules depending on css (includingeffects,dimensions, andoffset).
css/showHide: Non-animated.show(),.hide()and.toggle(); can be excluded if you use classes or explicit.css()calls to set thedisplayproperty. Also removes theeffectsmodule.
deprecated: Methods documented as deprecated but not yet removed.
dimensions: The.width()and.height()methods, includinginner-andouter-variations.
effects: The.animate()method and its shorthands such as.slideUp()or.hide("slow").
event: The.on()and.off()methods and all event functionality. Also removesevent/alias.
event/alias: All event attaching/triggering shorthands like.click()or.mouseover().
event/focusin: Cross-browser support for the focusin and focusout events.
event/trigger: The.trigger()and.triggerHandler()methods. Used byaliasandfocusinmodules.
offset: The.offset(),.position(),.offsetParent(),.scrollLeft(), and.scrollTop()methods.
wrap: The.wrap(),.wrapAll(),.wrapInner(), and.unwrap()methods.
core/ready: Exclude the ready module if you place your scripts at the end of the body. Any ready callbacks bound withjQuery()will simply be called immediately. However,jQuery(document).ready()will not be a function and.on("ready", ...)or similar will not be triggered.
deferred: Exclude jQuery.Deferred. This also removes jQuery.Callbacks.Notethat modules that depend on jQuery.Deferred(AJAX, effects, core/ready) will not be removed and will still expect jQuery.Deferred to be there. Include your own jQuery.Deferred implementation or exclude those modules as well (grunt custom:-deferred,-ajax,-effects,-core/ready).
exports/global: Exclude the attachment of global jQuery variables ($ and jQuery) to the window.
exports/amd: Exclude the AMD definition.
As a special case, you may also replace Sizzle by using a special flaggrunt custom:-sizzle.
sizzle: The Sizzle selector engine. When this module is excluded, it is replaced by a rudimentary selector engine based on the browser'squerySelectorAllmethod that does not support jQuery selector extensions or enhanced semantics. See theselector-native.jsfile for details.
Note: Excluding Sizzle will also exclude all jQuery selector extensions (such aseffects/animatedSelectorandcss/hiddenVisibleSelectors).
The build process shows a message for each dependent module it excludes or includes.
As an option, you can set the module name for jQuery's AMD definition. By default, it is set to "jquery", which plays nicely with plugins and third-party libraries, but there may be cases where you'd like to change this. Simply set the"amd"option:
grunt custom --amd="custom-name"
Or, to define anonymously, set the name to an empty string.
grunt custom --amd=""
To create a custom build, first check out the version:
git pull;git checkout VERSION
Where VERSION is the version you want to customize. Then, make sure all Node dependencies are installed:
npm install
Create the custom build using thegrunt customoption, listing the modules to be excluded.
Exclude allajaxfunctionality:
grunt custom:-ajax
Excludingcssremoves modules depending on CSS:effects,offset,dimensions.
grunt custom:-css
Exclude a bunch of modules:
grunt custom:-ajax,-css,-deprecated,-dimensions,-effects,-event/alias,-offset,-wrap
For questions or requests regarding custom builds, please start a thread on theDeveloping jQuery Coresection of the forum. Due to the combinatorics and custom nature of these builds, they are not regularly tested in jQuery's unit test process. The non-Sizzle selector engine currently does not pass unit tests because it is missing too much essential functionality.
Make sure you have the necessary dependencies:
npm install
Startgrunt watchornpm startto auto-build jQuery as you work:
grunt watch
Run the unit tests with a local server that supports PHP. Ensure that you run the site from the root directory, not the "test" directory. No database is required. Pre-configured php local servers are available for Windows and Mac. Here are some options:
Windows:WAMP download
Mac:MAMP download
Linux:Setting up LAMP
Building to a different directory
To copy the built jQuery files from/distto another directory:
grunt&&grunt dist:/path/to/special/location/
With this example, the output files would be:
/path/to/special/location/jquery.js
/path/to/special/location/jquery.min.js
To add a permanent copy destination, create a file indist/called ".destination.json". Inside the file, paste and customize the following:
{"/Absolute/path/to/other/destination":true}
Additionally, both methods can be combined.
As the source code is handled by the Git version control system, it's useful to know some features used.
If you want to purge your working directory back to the status of upstream, the following commands can be used (remember everything you've worked on is gone after these):
git reset --hard upstream/master
git clean -fdx
For feature/topic branches, you should always use the--rebaseflag togit pull, or if you are usually handling many temporary "to be in a github pull request" branches, run the following to automate this:
git config branch.autosetuprebaselocal
(seeman git-configfor more information)
If you're getting merge conflicts when merging, instead of editing the conflicted files manually, you can use the featuregit mergetool. Even though the default toolxxdifflooks awful/old, it's rather useful.
The following are some commands that can be used there:
Ctrl + Alt + M- automerge as much as possible
b- jump to next merge conflict
s- change the order of the conflicted lines
u- undo a merge
left mouse button- mark a block to be the winner
middle mouse button- mark a line to be the winner
Ctrl + S- save
Ctrl + Q- quit
QUnitReference
expect( numAssertions );stop();start();
Note: QUnit's eventual addition of an argument to stop/start is ignored in this test suite so that start and stop can be passed as callbacks without worrying about their parameters.
ok( value, [message] );equal( actual, expected, [message] );notEqual( actual, expected, [message] );deepEqual( actual, expected, [message] );notDeepEqual( actual, expected, [message] );strictEqual( actual, expected, [message] );notStrictEqual( actual, expected, [message] );throws( block, [expected], [message] );
Test Suite Convenience Methods Reference (Seetest/data/testinit.js)
Returns an array of elements with the given IDs
q(...);
Example:
q("main","foo","bar");=>[ div#main, span#foo, input#bar ]
Asserts that a selection matches the given IDs
t( testName, selector, ["array","of","ids"] );
Example:
t("Check for something","http://[a]", ["foo","bar"]);
Fires a native DOM event without going through jQuery
fireNative( node, eventType )
Example:
fireNative(jQuery("#elem")[0],"click");
Add random number to url to stop caching
url("some/url.php");
Example:
url("data/test.html");=>"data/test.html?10538358428943"url("data/test.php?foo=bar");=>"data/test.php?foo=bar&10538358345554"
Some tests may require a document other than the standard test fixture, and these can be run in a separate iframe. The actual test code and assertions remain in jQuery's main test files; only the minimal test fixture markup and setup code should be placed in the iframe file.
testIframe( testName, fileName,functiontestCallback(assert,jQuery,window,document,? [additionalargs] ) {...} );
This loads a page, constructing a url with fileName"./data/" + fileName. The iframed page determines when the callback occurs in the test by including the "/test/data/iframeTest.js" script and callingstartIframeTest( [ additional args ] )when appropriate. Often this will be after either document ready orwindow.onloadfires.
ThetestCallbackreceives the QUnitassertobject created bytestIframefor this test, followed by the globaljQuery,window, anddocumentfrom the iframe. If the iframe code passes any arguments tostartIframeTest, they follow thedocumentargument.
If you have any questions, please feel free to ask on theDeveloping jQuery Core forumor in #jquery on irc.freenode.net.
