Skip to content

Commit 763ade6

Browse files
mgolmgol
authored
Build: Generate the slim build on grunt & run compare_size on it
Summary of the changes: * expand `node_smoke_tests` to test the full & slim builds * run `compare_size` on all built minified files; don't run it anymore on unminified files where they don't provide lots of value The main goal of this change is to make it easier to compare sizes of both the full & slim builds between the `3.x-stable` & `main` branches. Closes gh-5291 Ref gh-5255 (partially cherry-picked from commit 8be4c0e)
1 parent a288838 commit 763ade6

21 files changed

+202
-111
lines changed

‎.eslintignore

+2
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ node_modules
44
dist/**
55
!dist/jquery.js
66
!dist/jquery.min.js
7+
!dist/jquery.slim.js
8+
!dist/jquery.slim.min.js
79
test/data/jquery-1.9.1.js
810
test/data/badcall.js
911
test/data/badjson.js

‎.gitignore

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ package-lock.json
1212

1313
npm-debug.log*
1414

15-
# Ignore everything in dist folder except for eslint config
15+
# Ignore everything in `dist` folder except for the ESLint config
1616
/dist/*
1717
!/dist/.eslintrc.json
1818

‎.npmignore

+1-4
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,7 @@
66
/.mailmap
77

88
/build
9+
/external
910
/speed
1011
/test
1112
/Gruntfile.js
12-
13-
/external/qunit
14-
/external/requirejs
15-
/external/sinon

‎Gruntfile.js

+37-16
Original file line numberDiff line numberDiff line change
@@ -13,19 +13,19 @@ module.exports = function( grunt ) {
1313
}
1414

1515
const fs = require( "fs" );
16+
const { spawn } = require( "child_process" );
1617
const gzip = require( "gzip-js" );
17-
const nodeV14OrNewer = !/^v1[0-3]\./.test( process.version );
18+
const nodeV16OrNewer = !/^v1[0-5]\./.test( process.version );
1819
const nodeV17OrNewer = !/^v1[0-6]\./.test( process.version );
1920
const customBrowsers = process.env.BROWSERS && process.env.BROWSERS.split( "," );
2021

21-
// Support: Node.js <14
22-
// Skip running tasks that dropped support for Node.js 10 or 12
23-
// in this Node version.
22+
// Support: Node.js <16
23+
// Skip running tasks that dropped support for old Node.js in these Node versions.
2424
function runIfNewNode( task ) {
25-
return nodeV14OrNewer ? task : "print_old_node_message:" + task;
25+
return nodeV16OrNewer ? task : "print_old_node_message:" + task;
2626
}
2727

28-
if ( nodeV14OrNewer ) {
28+
if ( nodeV16OrNewer ) {
2929
const playwright = require( "playwright-webkit" );
3030
process.env.WEBKIT_HEADLESS_BIN = playwright.webkit.executablePath();
3131
}
@@ -34,11 +34,21 @@ module.exports = function( grunt ) {
3434
grunt.option( "filename", "jquery.js" );
3535
}
3636

37+
const builtJsFiles = [
38+
"dist/jquery.js",
39+
"dist/jquery.min.js",
40+
"dist/jquery.slim.js",
41+
"dist/jquery.slim.min.js"
42+
];
43+
44+
const builtJsMinFiles = builtJsFiles
45+
.filter( filepath => filepath.endsWith( ".min.js" ) );
46+
3747
grunt.initConfig( {
3848
pkg: grunt.file.readJSON( "package.json" ),
3949
dst: readOptionalJSON( "dist/.destination.json" ),
40-
"compare_size": {
41-
files: [ "dist/jquery.js", "dist/jquery.min.js" ],
50+
compare_size: {
51+
files: builtJsMinFiles,
4252
options: {
4353
compress: {
4454
gz: function( contents ) {
@@ -124,7 +134,7 @@ module.exports = function( grunt ) {
124134
// We have to explicitly declare "src" property otherwise "newer"
125135
// task wouldn't work properly :/
126136
dist: {
127-
src: [ "dist/jquery.js", "dist/jquery.min.js" ]
137+
src: builtJsFiles
128138
},
129139
dev: {
130140
src: [ "src/**/*.js", "Gruntfile.js", "test/**/*.js", "build/**/*.js" ]
@@ -308,7 +318,7 @@ module.exports = function( grunt ) {
308318
uglify: {
309319
all: {
310320
files: {
311-
"dist/<%= grunt.option('filename').replace('.js', '.min.js') %>":
321+
"dist/<%= grunt.option('filename').replace(/\\.js$/, '.min.js') %>":
312322
"dist/<%= grunt.option('filename') %>"
313323
},
314324
options: {
@@ -343,7 +353,7 @@ module.exports = function( grunt ) {
343353

344354
// Load grunt tasks from NPM packages
345355
require( "load-grunt-tasks" )( grunt, {
346-
pattern: nodeV14OrNewer ? [ "grunt-*" ] : [ "grunt-*", "!grunt-eslint" ]
356+
pattern: nodeV16OrNewer ? [ "grunt-*" ] : [ "grunt-*", "!grunt-eslint" ]
347357
} );
348358

349359
// Integrate jQuery specific tasks
@@ -354,6 +364,20 @@ module.exports = function( grunt ) {
354364
grunt.log.writeln( "Old Node.js detected, running the task \"" + task + "\" skipped..." );
355365
} );
356366

367+
grunt.registerTask( "build-all-variants",
368+
"Build both the full & slim builds",
369+
function() {
370+
const done = this.async();
371+
372+
spawn( "npm run build-all-variants", {
373+
stdio: "inherit",
374+
shell: true
375+
} )
376+
.on( "close", code => {
377+
done( code === 0 );
378+
} );
379+
} );
380+
357381
grunt.registerTask( "print_jsdom_message", () => {
358382
grunt.log.writeln( "Node.js 17 or newer detected, skipping jsdom tests..." );
359383
} );
@@ -377,7 +401,7 @@ module.exports = function( grunt ) {
377401
runIfNewNode( "newer:eslint:dist" )
378402
] );
379403

380-
grunt.registerTask( "test:fast", runIfNewNode( "node_smoke_tests" ) );
404+
grunt.registerTask( "test:fast", [ "node_smoke_tests" ] );
381405
grunt.registerTask( "test:slow", [
382406
runIfNewNode( "promises_aplus_tests" ),
383407

@@ -410,10 +434,7 @@ module.exports = function( grunt ) {
410434

411435
grunt.registerTask( "default", [
412436
runIfNewNode( "eslint:dev" ),
413-
"build:*:*",
414-
"uglify",
415-
"remove_map_comment",
416-
"dist:*",
437+
"build-all-variants",
417438
"test:prepare",
418439
runIfNewNode( "eslint:dist" ),
419440
"test:fast",

‎README.md

+11-1
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ The build process shows a message for each dependent module it excludes or inclu
117117

118118
##### AMD name
119119

120-
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:
120+
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 pass it to the `--amd` parameter:
121121

122122
```bash
123123
grunt custom --amd="custom-name"
@@ -129,6 +129,16 @@ Or, to define anonymously, set the name to an empty string.
129129
grunt custom --amd=""
130130
```
131131

132+
##### File name
133+
134+
The default name for the built jQuery file is `jquery.js`; it is placed under the `dist/` directory. It's possible to change the file name using the `--filename` parameter:
135+
136+
```bash
137+
grunt custom:slim --filename="jquery.slim.js"
138+
```
139+
140+
This would create a slim version of jQuery and place it under `dist/jquery.slim.js`. In fact, this is exactly the command we use to generate the slim jQuery during the release process.
141+
132142
#### Custom Build Examples
133143

134144
To create a custom build, first check out the version:

‎build/release.js

+5-10
Original file line numberDiff line numberDiff line change
@@ -42,12 +42,8 @@ module.exports = function( Release ) {
4242
* @param {Function} callback
4343
*/
4444
generateArtifacts: function( callback ) {
45-
Release.exec( "npx grunt", "Grunt command failed" );
46-
Release.exec(
47-
"npx grunt custom:slim --filename=jquery.slim.js && " +
48-
"npx grunt remove_map_comment --filename=jquery.slim.js",
49-
"Grunt custom failed"
50-
);
45+
Release.exec( "npx grunt" );
46+
5147
cdn.makeReleaseCopies( Release );
5248
Release._setSrcVersion();
5349
callback( filesToCommit );
@@ -69,10 +65,9 @@ module.exports = function( Release ) {
6965
* Publish to distribution repo and npm
7066
* @param {Function} callback
7167
*/
72-
dist: function( callback ) {
73-
cdn.makeArchives( Release, function() {
74-
dist( Release, distFiles, callback );
75-
} );
68+
dist: async callback => {
69+
await cdn.makeArchives( Release );
70+
dist( Release, distFiles, callback );
7671
}
7772
} );
7873
};

‎build/tasks/build.js

+6-1
Original file line numberDiff line numberDiff line change
@@ -358,6 +358,11 @@ module.exports = function( grunt ) {
358358
"";
359359

360360
grunt.log.writeln( "Creating custom build...\n" );
361-
grunt.task.run( [ "build:*:*" + ( modules ? ":" + modules : "" ), "uglify", "dist" ] );
361+
grunt.task.run( [
362+
"build:*:*" + ( modules ? ":" + modules : "" ),
363+
"uglify",
364+
"remove_map_comment",
365+
"dist"
366+
] );
362367
} );
363368
};

‎build/tasks/dist.js

+12-12
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
"use strict";
22

33
module.exports = function( grunt ) {
4-
var fs = require( "fs" ),
5-
filename = grunt.option( "filename" ),
6-
distpaths = [
7-
"dist/" + filename,
8-
"dist/" + filename.replace( ".js", ".min.map" ),
9-
"dist/" + filename.replace( ".js", ".min.js" )
10-
];
4+
const fs = require( "fs" );
5+
const filename = grunt.option( "filename" );
6+
const distPaths = [
7+
`dist/${ filename }`,
8+
`dist/${ filename.replace( ".js", ".min.js" ) }`,
9+
`dist/${ filename.replace( ".js", ".min.map" ) }`
10+
];
1111

1212
// Process files for distribution
1313
grunt.registerTask( "dist", function() {
14-
var stored, flags, paths, nonascii;
14+
let stored, flags, paths, nonascii;
1515

1616
// Check for stored destination paths
1717
// ( set in dist/.destination.json )
@@ -28,9 +28,9 @@ module.exports = function( grunt ) {
2828
// Ensure the dist files are pure ASCII
2929
nonascii = false;
3030

31-
distpaths.forEach( function( filename ) {
32-
var i, c,
33-
text = fs.readFileSync( filename, "utf8" );
31+
distPaths.forEach( function( filename ) {
32+
let i, c;
33+
const text = fs.readFileSync( filename, "utf8" );
3434

3535
// Ensure files use only \n for line endings, not \r\n
3636
if ( /\x0d\x0a/.test( text ) ) {
@@ -54,7 +54,7 @@ module.exports = function( grunt ) {
5454

5555
// Optionally copy dist files to other locations
5656
paths.forEach( function( path ) {
57-
var created;
57+
let created;
5858

5959
if ( !/\/$/.test( path ) ) {
6060
path += "/";

‎build/tasks/node_smoke_tests.js

+34-23
Original file line numberDiff line numberDiff line change
@@ -3,29 +3,40 @@
33
module.exports = ( grunt ) => {
44
const fs = require( "fs" );
55
const spawnTest = require( "./lib/spawn_test.js" );
6-
const testsDir = "./test/node_smoke_tests/";
7-
const nodeSmokeTests = [];
8-
9-
// Fire up all tests defined in test/node_smoke_tests/*.js in spawned sub-processes.
10-
// All the files under test/node_smoke_tests/*.js are supposed to exit with 0 code
11-
// on success or another one on failure. Spawning in sub-processes is
12-
// important so that the tests & the main process don't interfere with
13-
// each other, e.g. so that they don't share the require cache.
14-
15-
fs.readdirSync( testsDir )
16-
.filter( ( testFilePath ) =>
17-
fs.statSync( testsDir + testFilePath ).isFile() &&
18-
/\.js$/.test( testFilePath )
19-
)
20-
.forEach( ( testFilePath ) => {
21-
const taskName = `node_${ testFilePath.replace( /\.js$/, "" ) }`;
22-
23-
grunt.registerTask( taskName, function() {
24-
spawnTest( this.async(), `node "test/node_smoke_tests/${ testFilePath }"` );
25-
} );
6+
const nodeV16OrNewer = !/^v1[0-5]\./.test( process.version );
7+
8+
grunt.registerTask( "node_smoke_tests", function( jQueryModuleSpecifier = "./dist/jquery.js" ) {
9+
if ( !nodeV16OrNewer ) {
10+
grunt.log.writeln( "Old Node.js detected, running the task " +
11+
`"node_smoke_tests:${ jQueryModuleSpecifier }" skipped...` );
12+
return;
13+
}
14+
15+
const testsDir = "./test/node_smoke_tests";
16+
const nodeSmokeTests = [];
17+
18+
// Fire up all tests defined in test/node_smoke_tests/*.js in spawned sub-processes.
19+
// All the files under test/node_smoke_tests/*.js are supposed to exit with 0 code
20+
// on success or another one on failure. Spawning in sub-processes is
21+
// important so that the tests & the main process don't interfere with
22+
// each other, e.g. so that they don't share the `require` cache.
2623

27-
nodeSmokeTests.push( taskName );
28-
} );
24+
fs.readdirSync( testsDir )
25+
.filter( ( testFilePath ) =>
26+
fs.statSync( `${ testsDir }/${ testFilePath }` ).isFile() &&
27+
/\.[cm]?js$/.test( testFilePath )
28+
)
29+
.forEach( ( testFilePath ) => {
30+
const taskName = `node_${ testFilePath.replace( /\.[cm]?js$/, "" ) }:${ jQueryModuleSpecifier }`;
31+
32+
grunt.registerTask( taskName, function() {
33+
spawnTest( this.async(), `node "${ testsDir }/${
34+
testFilePath }" ${ jQueryModuleSpecifier }` );
35+
} );
36+
37+
nodeSmokeTests.push( taskName );
38+
} );
2939

30-
grunt.registerTask( "node_smoke_tests", nodeSmokeTests );
40+
grunt.task.run( nodeSmokeTests );
41+
} );
3142
};

‎dist/.eslintrc.json

+15-1
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,26 @@
88

99
"overrides": [
1010
{
11-
"files": "jquery.js",
11+
"files": "jquery{,.slim}.min.js",
12+
13+
"parserOptions": {
14+
"ecmaVersion": 5,
15+
"sourceType": "script"
16+
}
17+
},
18+
19+
{
20+
"files": "jquery{,.slim}.js",
1221
"extends": "../.eslintrc-browser.json",
1322

1423
"rules": {
24+
1525
// That is okay for the built version
1626
"no-multiple-empty-lines": "off",
27+
28+
// When custom compilation is used, the version string
29+
// can get large. Accept that in the built version.
30+
"max-len": "off",
1731
"one-var": "off"
1832
}
1933
}

‎package.json

+7-3
Original file line numberDiff line numberDiff line change
@@ -68,15 +68,19 @@
6868
"uglify-js": "3.4.7"
6969
},
7070
"scripts": {
71-
"build": "npm install && grunt",
71+
"build": "npm install && npm run build-all-variants",
72+
"build-all-variants": "grunt custom:slim --filename=jquery.slim.js && grunt custom",
7273
"start": "grunt watch",
73-
"test:browserless": "grunt && grunt test:slow",
74+
"test:browserless": "grunt && npm run test:node_smoke_tests && grunt test:slow",
7475
"test:browser": "grunt && grunt karma:main",
7576
"test:amd": "grunt && grunt karma:amd",
7677
"test:no-deprecated": "grunt test:prepare && grunt custom:-deprecated && grunt karma:main",
7778
"test:selector-native": "grunt test:prepare && grunt custom:-selector && grunt karma:main",
7879
"test:slim": "grunt test:prepare && grunt custom:slim && grunt karma:main",
79-
"test": "npm run test:slim && npm run test:no-deprecated && npm run test:selector-native && grunt && grunt test:slow && grunt karma:main && grunt karma:amd",
80+
"test:node_smoke_tests:full": "grunt node_smoke_tests:./dist/jquery.js",
81+
"test:node_smoke_tests:slim": "grunt node_smoke_tests:./dist/jquery.slim.js",
82+
"test:node_smoke_tests": "npm run test:node_smoke_tests:full && npm run test:node_smoke_tests:slim",
83+
"test": "npm run test:browserless && npm run test:slim && npm run test:no-deprecated && npm run test:selector-native && grunt && grunt test:slow && grunt karma:main && grunt karma:amd",
8084
"jenkins": "npm run test:browserless"
8185
},
8286
"commitplease": {

‎test/node_smoke_tests/.eslintrc.json

+3-3
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@
44
"extends": "../../.eslintrc-node.json",
55

66
"parserOptions": {
7-
"ecmaVersion": 6
7+
"ecmaVersion": 2015,
8+
"sourceType": "script"
89
},
9-
1010
"env": {
11-
"es6": true
11+
"es2020": true
1212
}
1313
}

0 commit comments

Comments
 (0)