1 [jQuery](http://jquery.com/) - New Wave JavaScript
2 ==================================================
5 --------------------------------------
7 In the spirit of open source software development, jQuery always encourages community code contribution. To help you get started and before you jump into writing code, be sure to read these important contribution guidelines thoroughly:
9 1. [Getting Involved](http://docs.jquery.com/Getting_Involved)
10 2. [Core Style Guide](http://docs.jquery.com/JQuery_Core_Style_Guidelines)
11 3. [Tips For Bug Patching](http://docs.jquery.com/Tips_for_jQuery_Bug_Patching)
14 What you need to build your own jQuery
15 --------------------------------------
17 In order to build jQuery, you need to have Node.js/npm latest and git 1.7 or later.
18 (Earlier versions might work OK, but are not tested.)
20 For Windows you have to download and install [git](http://git-scm.com/downloads) and [Node.js](http://nodejs.org/download/).
22 Mac OS users should install [Homebrew](http://mxcl.github.com/homebrew/). Once Homebrew is installed, run `brew install git` to install git,
23 and `brew install node` to install Node.js.
25 Linux/BSD users should use their appropriate package managers to install git and Node.js, or build from source
26 if you swing that way. Easy-peasy.
29 How to build your own jQuery
30 ----------------------------
32 First, clone a copy of the main jQuery git repo by running:
35 git clone git://github.com/jquery/jquery.git
38 Install the [grunt-cli](http://gruntjs.com/getting-started#installing-the-cli) and [bower](http://bower.io/) packages if you haven't before. These should be done as global installs:
41 npm install -g grunt-cli bower
44 Make sure you have `grunt` and `bower` installed by testing:
51 Enter the jquery directory and install the Node and Bower dependencies, this time *without* specifying a global(-g) install:
54 cd jquery && npm install
57 Then, to get a complete, minified (w/ Uglify.js), linted (w/ JSHint) version of jQuery, type the following:
63 The built version of jQuery will be put in the `dist/` subdirectory, along with the minified copy and associated map file.
68 Special builds can be created that exclude subsets of jQuery functionality.
69 This allows for smaller custom builds when the builder is certain that those parts of jQuery are not being used.
70 For example, an app that only used JSONP for `$.ajax()` and did not need to calculate offsets or positions of elements could exclude the offset and ajax/xhr modules.
72 Any module may be excluded except for `core`, and `selector`. To exclude a module, pass its path relative to the `src` folder (without the `.js` extension).
74 Some example modules that can be excluded are:
76 - **ajax**: All AJAX functionality: `$.ajax()`, `$.get()`, `$.post()`, `$.ajaxSetup()`, `.load()`, transports, and ajax event shorthands such as `.ajaxStart()`.
77 - **ajax/xhr**: The XMLHTTPRequest AJAX transport only.
78 - **ajax/script**: The `<script>` AJAX transport only; used to retrieve scripts.
79 - **ajax/jsonp**: The JSONP AJAX transport only; depends on the ajax/script transport.
80 - **css**: The `.css()` method plus non-animated `.show()`, `.hide()` and `.toggle()`. Also removes **all** modules depending on css (including **effects**, **dimensions**, and **offset**).
81 - **deprecated**: Methods documented as deprecated but not yet removed; currently only `.andSelf()`.
82 - **dimensions**: The `.width()` and `.height()` methods, including `inner-` and `outer-` variations.
83 - **effects**: The `.animate()` method and its shorthands such as `.slideUp()` or `.hide("slow")`.
84 - **event**: The `.on()` and `.off()` methods and all event functionality. Also removes `event/alias`.
85 - **event/alias**: All event attaching/triggering shorthands like `.click()` or `.mouseover()`.
86 - **offset**: The `.offset()`, `.position()`, `.offsetParent()`, `.scrollLeft()`, and `.scrollTop()` methods.
87 - **wrap**: The `.wrap()`, `.wrapAll()`, `.wrapInner()`, and `.unwrap()` methods.
88 - **exports/amd**: Exclude the AMD definition.
89 - **core/ready**: Exclude the ready module if you place your scripts at the end of the body. Any ready callbacks bound with `jQuery()` will simply be called immediately. However, `jQuery(document).ready()` will not be a function and `.on("ready", ...)` or similar will not be triggered.
90 - **deferred**: Exclude jQuery.Deferred. This also removes jQuery.Callbacks. *Note* that 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`).
92 As a special case, you may also replace Sizzle by using a special flag `grunt custom:-sizzle`.
94 - **sizzle**: The Sizzle selector engine. When this module is excluded, it is replaced by a rudimentary selector engine based on the browser's `querySelectorAll` method that does not support jQuery selector extensions or enhanced semantics. See the selector-native.js file for details.
96 *Note*: Excluding Sizzle will also exclude all jQuery selector extensions (such as `effects/animatedSelector` and `css/hiddenVisibleSelectors`).
98 The build process shows a message for each dependent module it excludes or includes.
100 To create a custom build of the latest stable version, first check out the version:
103 git pull; git checkout $(git describe --abbrev=0 --tags)
106 Then, make sure all Node dependencies are installed:
112 Create the custom build, use the `grunt custom` option, listing the modules to be excluded. Examples:
114 Exclude all **ajax** functionality:
120 Excluding **css** removes modules depending on CSS: **effects**, **offset**, **dimensions**.
126 Exclude a bunch of modules:
129 grunt custom:-ajax,-css,-deprecated,-dimensions,-effects,-event/alias,-offset,-wrap
132 For questions or requests regarding custom builds, please start a thread on the [Developing jQuery Core](https://forum.jquery.com/developing-jquery-core) section 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.
134 Running the Unit Tests
135 --------------------------------------
137 Make sure you have the necessary dependencies:
143 Start `grunt watch` to auto-build jQuery as you work:
146 cd jquery && grunt watch
150 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:
152 - Windows: [WAMP download](http://www.wampserver.com/en/)
153 - Mac: [MAMP download](http://www.mamp.info/en/index.html)
154 - Linux: [Setting up LAMP](https://www.linux.com/learn/tutorials/288158-easy-lamp-server-installation)
155 - [Mongoose (most platforms)](http://code.google.com/p/mongoose/)
160 Building to a different directory
161 ---------------------------------
163 To copy the built jQuery files from `/dist` to another directory:
166 grunt && grunt dist:/path/to/special/location/
168 With this example, the output files would be:
171 /path/to/special/location/jquery.js
172 /path/to/special/location/jquery.min.js
175 To add a permanent copy destination, create a file in `dist/` called ".destination.json". Inside the file, paste and customize the following:
180 "/Absolute/path/to/other/destination": true
184 Additionally, both methods can be combined.
191 As the source code is handled by the version control system Git, it's useful to know some features used.
195 If you want to purge your working directory back to the status of upstream, following commands can be used (remember everything you've worked on is gone after these):
198 git reset --hard upstream/master
204 For feature/topic branches, you should always used the `--rebase` flag to `git pull`, or if you are usually handling many temporary "to be in a github pull request" branches, run following to automate this:
207 git config branch.autosetuprebase local
209 (see `man git-config` for more information)
211 ### handling merge conflicts ###
213 If you're getting merge conflicts when merging, instead of editing the conflicted files manually, you can use the feature
214 `git mergetool`. Even though the default tool `xxdiff` looks awful/old, it's rather useful.
216 Following are some commands that can be used there:
218 * `Ctrl + Alt + M` - automerge as much as possible
219 * `b` - jump to next merge conflict
220 * `s` - change the order of the conflicted lines
222 * `left mouse button` - mark a block to be the winner
223 * `middle mouse button` - mark a line to be the winner
227 [QUnit](http://docs.jquery.com/QUnit) Reference
233 expect( numAssertions );
239 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
241 ### Test assertions ###
245 ok( value, [message] );
246 equal( actual, expected, [message] );
247 notEqual( actual, expected, [message] );
248 deepEqual( actual, expected, [message] );
249 notDeepEqual( actual, expected, [message] );
250 strictEqual( actual, expected, [message] );
251 notStrictEqual( actual, expected, [message] );
252 raises( block, [expected], [message] );
256 Test Suite Convenience Methods Reference (See [test/data/testinit.js](https://github.com/jquery/jquery/blob/master/test/data/testinit.js))
257 ------------------------------
259 ### Returns an array of elements with the given IDs ###
268 q("main", "foo", "bar");
270 => [ div#main, span#foo, input#bar ]
273 ### Asserts that a selection matches the given IDs ###
276 t( testName, selector, [ "array", "of", "ids" ] );
282 t("Check for something", "//[a]", ["foo", "baar"]);
287 ### Fires a native DOM event without going through jQuery ###
290 fireNative( node, eventType )
296 fireNative( jQuery("#elem")[0], "click" );
299 ### Add random number to url to stop caching ###
302 url( "some/url.php" );
308 url("data/test.html");
310 => "data/test.html?10538358428943"
313 url("data/test.php?foo=bar");
315 => "data/test.php?foo=bar&10538358345554"
319 ### Load tests in an iframe ###
321 Loads a given page constructing a url with fileName: `"./data/" + fileName + ".html"`
322 and fires the given callback on jQuery ready (using the jQuery loading from that page)
323 and passes the iFrame's jQuery to the callback.
326 testIframe( fileName, testName, callback );
332 callback( jQueryFromIFrame, iFrameWindow, iFrameDocument );
335 ### Load tests in an iframe (window.iframeCallback) ###
337 Loads a given page constructing a url with fileName: `"./data/" + fileName + ".html"`
338 The given callback is fired when window.iframeCallback is called by the page
339 The arguments passed to the callback are the same as the
340 arguments passed to window.iframeCallback, whatever that may be
343 testIframeWithCallback( testName, fileName, callback );
349 If you have any questions, please feel free to ask on the
350 [Developing jQuery Core forum](http://forum.jquery.com/developing-jquery-core) or in #jquery on irc.freenode.net.