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 Windows users have two options:
22 1. Install [msysgit](https://code.google.com/p/msysgit/) (Full installer for official Git) and a
23 [binary version of Node.js](http://nodejs.org). Make sure all two packages are installed to the same
24 location (by default, this is C:\Program Files\Git).
25 2. Install [Cygwin](http://cygwin.com/) (make sure you install the git and which packages), and
26 a [binary version of Node.js](http://nodejs.org/).
28 Mac OS users should install Xcode (comes on your Mac OS install DVD, or downloadable from
29 [Apple's Xcode site](http://developer.apple.com/technologies/xcode.html)) and
30 [Homebrew](http://mxcl.github.com/homebrew/). Once Homebrew is installed, run `brew install git` to install git,
31 and `brew install node` to install Node.js.
33 Linux/BSD users should use their appropriate package managers to install git and Node.js, or build from source
34 if you swing that way. Easy-peasy.
37 How to build your own jQuery
38 ----------------------------
40 First, clone a copy of the main jQuery git repo by running:
43 git clone git://github.com/jquery/jquery.git
46 Install the grunt-cli package so that you will have the correct version of grunt available from any project that needs it. This should be done as a global install:
49 npm install -g grunt-cli
52 Enter the jquery directory and install the Node dependencies, this time *without* specifying a global install:
55 cd jquery && npm install
58 Make sure you have `grunt` installed by testing:
64 Then, to get a complete, minified (w/ Uglify.js), linted (w/ JSHint) version of jQuery, type the following:
70 The built version of jQuery will be put in the `dist/` subdirectory, along with the minified copy and associated map file.
75 Special builds can be created that exclude subsets of jQuery functionality.
76 This allows for smaller custom builds when the builder is certain that those parts of jQuery are not being used.
77 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. The current modules that can be excluded are:
79 - **ajax**: All AJAX functionality: `$.ajax()`, `$.get()`, `$.post()`, `$.ajaxSetup()`, `.load()`, transports, and ajax event shorthands such as `.ajaxStart()`.
80 - **ajax/xhr**: The XMLHTTPRequest AJAX transport only.
81 - **ajax/script**: The `<script>` AJAX transport only; used to retrieve scripts.
82 - **ajax/jsonp**: The JSONP AJAX transport only; depends on the ajax/script transport.
83 - **css**: The `.css()` method plus non-animated `.show()`, `.hide()` and `.toggle()`.
84 - **deprecated**: Methods documented as deprecated but not yet removed; currently only `.andSelf()`.
85 - **dimensions**: The `.width()` and `.height()` methods, including `inner-` and `outer-` variations.
86 - **effects**: The `.animate()` method and its shorthands such as `.slideUp()` or `.hide("slow")`.
87 - **event-alias**: All event attaching/triggering shorthands like `.click()` or `.mouseover()`.
88 - **offset**: The `.offset()`, `.position()`, `.offsetParent()`, `.scrollLeft()`, and `.scrollTop()` methods.
89 - **wrap**: The `.wrap()`, `.wrapAll()`, `.wrapInner()`, and `.unwrap()` methods.
90 - **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.
92 The grunt build process is aware of dependencies across modules. If you explicitly remove a module, its dependent modules will be removed as well. For example, excluding the css module also excludes effects, since the effects module uses `.css()` to animate CSS properties. These dependencies are listed in Gruntfile.js and the build process shows a message for each dependent module it excludes.
94 To create a custom build of the latest stable version, first check out the version:
97 git pull; git checkout $(git describe --abbrev=0 --tags)
100 Then, make sure all Node dependencies are installed and all Git submodules are checked out:
106 Create the custom build, use the `grunt custom` option, listing the modules to be excluded. Examples:
108 Exclude all **ajax** functionality:
114 Exclude **css**, **effects**, **offset**, **dimensions**, and **position**. Excluding **css** automatically excludes its dependent modules:
117 grunt custom:-css:-position
120 Exclude **all** optional modules and use the `querySelectorAll`-based selector engine:
123 grunt custom:-ajax,-css,-deprecated,-dimensions,-effects,-event-alias,-offset,-sizzle
126 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.
128 Running the Unit Tests
129 --------------------------------------
131 Start grunt to auto-build jQuery as you work:
134 cd jquery && grunt watch
138 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:
140 - Windows: [WAMP download](http://www.wampserver.com/en/)
141 - Mac: [MAMP download](http://www.mamp.info/en/index.html)
142 - Linux: [Setting up LAMP](https://www.linux.com/learn/tutorials/288158-easy-lamp-server-installation)
143 - [Mongoose (most platforms)](http://code.google.com/p/mongoose/)
148 Building to a different directory
149 ---------------------------------
151 To copy the built jQuery files from `/dist` to another directory:
154 grunt && grunt dist:/path/to/special/location/
156 With this example, the output files would be:
159 /path/to/special/location/jquery.js
160 /path/to/special/location/jquery.min.js
163 To add a permanent copy destination, create a file in `dist/` called ".destination.json". Inside the file, paste and customize the following:
168 "/Absolute/path/to/other/destination": true
172 Additionally, both methods can be combined.
179 Update the submodules to what is probably the latest upstream code.
182 grunt update_submodules
185 Note: This task will also be run any time the default `grunt` command is used.
192 As the source code is handled by the version control system Git, it's useful to know some features used.
196 The repository uses submodules, which normally are handled directly by the `grunt update_submodules` command, but sometimes you want to
197 be able to work with them manually.
199 Following are the steps to manually get the submodules:
202 git clone https://github.com/jquery/jquery.git
211 git clone https://github.com/jquery/jquery.git
213 git submodule update --init
219 git clone --recursive https://github.com/jquery/jquery.git
223 If you want to work inside a submodule, it is possible, but first you need to checkout a branch:
230 After you've committed your changes to the submodule, you'll update the jquery project to point to the new commit,
231 but remember to push the submodule changes before pushing the new jquery commit:
235 git push origin master
244 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):
247 git reset --hard upstream/master
253 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:
256 git config branch.autosetuprebase local
258 (see `man git-config` for more information)
260 ### handling merge conflicts ###
262 If you're getting merge conflicts when merging, instead of editing the conflicted files manually, you can use the feature
263 `git mergetool`. Even though the default tool `xxdiff` looks awful/old, it's rather useful.
265 Following are some commands that can be used there:
267 * `Ctrl + Alt + M` - automerge as much as possible
268 * `b` - jump to next merge conflict
269 * `s` - change the order of the conflicted lines
270 * `u` - undo an merge
271 * `left mouse button` - mark a block to be the winner
272 * `middle mouse button` - mark a line to be the winner
276 [QUnit](http://docs.jquery.com/QUnit) Reference
282 expect( numAssertions );
288 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
290 ### Test assertions ###
294 ok( value, [message] );
295 equal( actual, expected, [message] );
296 notEqual( actual, expected, [message] );
297 deepEqual( actual, expected, [message] );
298 notDeepEqual( actual, expected, [message] );
299 strictEqual( actual, expected, [message] );
300 notStrictEqual( actual, expected, [message] );
301 raises( block, [expected], [message] );
305 Test Suite Convenience Methods Reference (See [test/data/testinit.js](https://github.com/jquery/jquery/blob/master/test/data/testinit.js))
306 ------------------------------
308 ### Returns an array of elements with the given IDs ###
317 q("main", "foo", "bar");
319 => [ div#main, span#foo, input#bar ]
322 ### Asserts that a selection matches the given IDs ###
325 t( testName, selector, [ "array", "of", "ids" ] );
331 t("Check for something", "//[a]", ["foo", "baar"]);
336 ### Fires a native DOM event without going through jQuery ###
339 fireNative( node, eventType )
345 fireNative( jQuery("#elem")[0], "click" );
348 ### Add random number to url to stop caching ###
351 url( "some/url.php" );
357 url("data/test.html");
359 => "data/test.html?10538358428943"
362 url("data/test.php?foo=bar");
364 => "data/test.php?foo=bar&10538358345554"
368 ### Load tests in an iframe ###
370 Loads a given page constructing a url with fileName: `"./data/" + fileName + ".html"`
371 and fires the given callback on jQuery ready (using the jQuery loading from that page)
372 and passes the iFrame's jQuery to the callback.
375 testIframe( fileName, testName, callback );
381 callback( jQueryFromIFrame, iFrameWindow, iFrameDocument );
384 ### Load tests in an iframe (window.iframeCallback) ###
386 Loads a given page constructing a url with fileName: `"./data/" + fileName + ".html"`
387 The given callback is fired when window.iframeCallback is called by the page
388 The arguments passed to the callback are the same as the
389 arguments passed to window.iframeCallback, whatever that may be
392 testIframeWithCallback( testName, fileName, callback );
398 If you have any questions, please feel free to ask on the
399 [Developing jQuery Core forum](http://forum.jquery.com/developing-jquery-core) or in #jquery on irc.freenode.net.