files: distpaths
},
selector: {
- destFile: "src/selector.js",
+ destFile: "src/selector-sizzle.js",
apiFile: "src/sizzle-jquery.js",
srcFile: "src/sizzle/dist/sizzle.js"
},
"src/queue.js",
"src/attributes.js",
"src/event.js",
- "src/selector.js",
+ "src/selector-sizzle.js",
"src/traversing.js",
"src/manipulation.js",
-
{ flag: "css", src: "src/css.js" },
"src/serialize.js",
{ flag: "event-alias", src: "src/event-alias.js" },
});
});
- // Build src/selector.js
- grunt.registerTask( "selector", "Build src/selector.js", function() {
+ grunt.registerTask( "selector", "Build Sizzle-based selector module", function() {
var cfg = grunt.config("selector"),
name = cfg.destFile,
// Rejoin the pieces
compiled = parts.join("");
- grunt.verbose.write("Injected sizzle-jquery.js into sizzle.js");
+ grunt.verbose.writeln("Injected " + cfg.apiFile + " into " + cfg.srcFile);
// Write concatenated source to file, and ensure newline-only termination
grunt.file.write( name, compiled.replace( /\x0d\x0a/g, "\x0a" ) );
var flag = filepath.flag,
specified = false,
omit = false,
- message = "";
+ messages = [];
if ( flag ) {
if ( excluded[ flag ] !== undefined ) {
- message = ( "Excluding " + flag ).red;
+ messages.push([
+ ( "Excluding " + flag ).red,
+ ( "(" + filepath.src + ")" ).grey
+ ]);
specified = true;
- omit = true;
- } else {
- message = ( "Including " + flag ).green;
+ omit = !filepath.alt;
+ if ( !omit ) {
+ flag += " alternate";
+ filepath.src = filepath.alt;
+ }
+ }
+ if ( excluded[ flag ] === undefined ) {
+ messages.push([
+ ( "Including " + flag ).green,
+ ( "(" + filepath.src + ")" ).grey
+ ]);
// If this module was actually specified by the
- // builder, then st the flag to include it in the
+ // builder, then set the flag to include it in the
// output list
if ( modules[ "+" + flag ] ) {
specified = true;
}
}
+ filepath = filepath.src;
+
// Only display the inclusion/exclusion list when handling
// an explicit list.
//
// Additionally, only display modules that have been specified
// by the user
if ( explicit && specified ) {
- grunt.log.writetableln([ 27, 30 ], [
- message,
- ( "(" + filepath.src + ")").grey
- ]);
+ messages.forEach(function( message ) {
+ grunt.log.writetableln( [ 27, 30 ], message );
+ });
}
-
- filepath = filepath.src;
}
if ( !omit ) {
The built version of jQuery will be put in the `dist/` subdirectory.
-### Modules (new in 1.8)
+### Modules
-Starting in jQuery 1.8, special builds can now be created that optionally exclude or include any of the following modules:
+Special builds can be created that exclude subsets of jQuery functionality.
+This allows for smaller custom builds when the builder is certain that those parts of jQuery are not being used.
+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:
-- ajax
-- css
-- dimensions
-- effects
-- offset
+- **ajax**: All AJAX functionality: `$.ajax()`, `$.get()`, `$.post()`, `$.ajaxSetup()`, `.load()`, transports, and ajax event shorthands such as `.ajaxStart()`.
+- **ajax/xhr**: The XMLHTTPRequest AJAX transport only.
+- **ajax/script**: The `<script>` AJAX transport only; used to retrieve scripts.
+- **ajax/jsonp**: The JSONP AJAX transport only; depends on the ajax/script transport.
+- **css**: The `.css()` method plus non-animated `.show()`, `.hide()` and `.toggle()`.
+- **deprecated**: Methods documented as deprecated but not yet removed; currently only `.andSelf()`.
+- **dimensions**: The `.width()` and `.height()` methods, including `inner-` and `outer-` variations.
+- **effects**: The `.animate()` method and its shorthands such as `.slideUp()` or `.hide("slow")`.
+- **event-alias**: All event attaching/triggering shorthands like `.click()` or `.mouseover()`.
+- **offset**: The `.offset()`, `.position()`, `.offsetParent()`, `.scrollLeft()`, and `.scrollTop()` methods.
+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.
-Before creating a custom build for use in production, be sure to check out the latest stable version:
+To create a custom build of the latest stable version, first check out the version:
```bash
git pull; git checkout $(git describe --abbrev=0 --tags)
npm install && grunt
```
-To create a custom build, use the following special `grunt` commands:
+Create the custom build, use the `grunt custom` option, listing the modules to be excluded. Examples:
-Exclude **ajax**:
+Exclude all **ajax** functionality:
```bash
grunt custom:-ajax
```
-Exclude **css**:
+Exclude **css**, **effects**, **offset**, **dimensions**, and **position**. Excluding **css** automatically excludes its dependent modules:
```bash
-grunt custom:-css
-```
-
-Exclude **deprecated**:
-
-```bash
-grunt custom:-deprecated
-```
-
-Exclude **dimensions**:
-
-```bash
-grunt custom:-dimensions
-```
-
-Exclude **effects**:
-
-```bash
-grunt custom:-effects
-```
-
-Exclude **offset**:
-
-```bash
-grunt custom:-offset
+grunt custom:-css:-position
```
Exclude **all** optional modules:
```bash
-grunt custom:-ajax,-css,-deprecated,-dimensions,-effects,-offset
+grunt custom:-ajax,-css,-deprecated,-dimensions,-effects,-event-alias,-offset
```
-
-Note: dependencies will be handled internally, by the build process.
-
+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.
Running the Unit Tests
--------------------------------------
-
Start grunt to auto-build jQuery as you work:
```bash
projects / jquery.git / commitdiff