Skip to content

Build: Switch form Terser to SWC for JS minification #5286

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mgol merged 1 commit into from
Jul 10, 2023
Merged

Build: Switch form Terser to SWC for JS minification #5286

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 29 additions & 15 deletions Gruntfile.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -312,27 +312,41 @@ module.exports = function( grunt ) {
files: [ "<%= eslint.dev.src %>" ],
tasks: [ "dev" ]
},
terser: {
minify: {
all: {
files: {
"dist/<%= grunt.option('filename').replace('.js', '.min.js') %>":
"dist/<%= grunt.option('filename') %>"
},
options: {
ecma: 5,
sourceMap: {
filename: "dist/<%= grunt.option('filename').replace('.js', '.min.map') %>"
},
format: {
ascii_only: true,
comments: false,
preamble: "/*! jQuery v<%= pkg.version %> | " +
"(c) OpenJS Foundation and other contributors | " +
"jquery.org/license */"
filename: "dist/<%= grunt.option('filename').replace('.js', '.min.map') %>",

// The map's `files` & `sources` property are set incorrectly, fix
// them via overrides from the task config.
// See https://github.com/swc-project/swc/issues/7588#issuecomment-1624345254
overrides: {
file: "jquery.min.js",
sources: [
"jquery.js"
]
}
},
compress: {
hoist_funs: false,
loops: false
swc: {
format: {
ecma: 5,
asciiOnly: true,
comments: false,
preamble: "/*! jQuery v4.0.0-pre | " +
"(c) OpenJS Foundation and other contributors | " +
"jquery.org/license */\n"
},
compress: {
ecma: 5,
hoist_funs: false,
loops: false
},
mangle: true
}
}
}
Expand Down Expand Up @@ -400,7 +414,7 @@ module.exports = function( grunt ) {
grunt.registerTask( "dev", [
"build:*:*",
runIfNewNode( "newer:eslint:dev" ),
"newer:terser",
"newer:minify",
"remove_map_comment",
"dist:*",
"qunit_fixture",
Expand All @@ -410,7 +424,7 @@ module.exports = function( grunt ) {
grunt.registerTask( "default", [
runIfNewNode( "eslint:dev" ),
"build:*:*",
"terser",
"minify",
"remove_map_comment",
"dist:*",
"test:prepare",
Expand Down
2 changes: 1 addition & 1 deletion build/tasks/build.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -339,6 +339,6 @@ module.exports = function( grunt ) {
"";

grunt.log.writeln( "Creating custom build...\n" );
grunt.task.run( [ "build:*:*" + ( modules ? ":" + modules : "" ), "terser", "dist" ] );
grunt.task.run( [ "build:*:*" + ( modules ? ":" + modules : "" ), "minify", "dist" ] );
} );
};
56 changes: 56 additions & 0 deletions build/tasks/minify.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
/**
* Minify JavaScript using SWC.
*/

"use strict";

module.exports = ( grunt ) => {
const swc = require( "@swc/core" );

grunt.registerMultiTask(
"minify",
"Minify JavaScript using SWC",
async function() {
const done = this.async();
const options = this.options();
const sourceMapFilename = options.sourceMap && options.sourceMap.filename;
const sourceMapOverrides = options.sourceMap && options.sourceMap.overrides || {};

await Promise.all( this.files.map( async( { src, dest } ) => {
if ( src.length !== 1 ) {
grunt.fatal( "The minify task requires a single source per destination" );
}

const { code, map: incompleteMap } = await swc.minify(
grunt.file.read( src[ 0 ] ),
{
...options.swc,
inlineSourcesContent: false,
sourceMap: sourceMapFilename ?
{
filename: sourceMapFilename
} :
false
}
);

grunt.file.write( dest, code );

if ( sourceMapFilename ) {

// Apply map overrides if needed. See the task config description
// for more details.
const mapObject = {
...JSON.parse( incompleteMap ),
...sourceMapOverrides
};
const map = JSON.stringify( mapObject );
Comment on lines +41 to +47
Copy link
Member Author

@mgol mgol Jul 6, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wish we could avoid this parse + fix + stringify back behavior, but it's still quick enough (I actually cannot measure a meaningful time difference with & without this code) and there's not much we can do until the issues are fixed or I learn which parameters to use to get what we need out of the box.


grunt.file.write( sourceMapFilename, map );
}
} ) );

done();
}
);
};
2 changes: 1 addition & 1 deletion build/tasks/sourcemap.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
var fs = require( "fs" );

module.exports = function( grunt ) {
var config = grunt.config( "terser.all.files" );
var config = grunt.config( "minify.all.files" );
grunt.registerTask( "remove_map_comment", function() {
var minLoc = grunt.config.process( Object.keys( config )[ 0 ] );

Expand Down
3 changes: 1 addition & 2 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
"devDependencies": {
"@babel/core": "7.10.5",
"@babel/plugin-transform-for-of": "7.10.4",
"@swc/core": "1.3.66",
"colors": "1.4.0",
"commitplease": "3.2.0",
"core-js-bundle": "3.6.5",
Expand All @@ -42,7 +43,6 @@
"grunt-karma": "4.0.2",
"grunt-newer": "1.3.0",
"grunt-npmcopy": "0.2.0",
"grunt-terser": "2.0.0",
"gzip-js": "0.3.2",
"husky": "4.2.5",
"jsdom": "19.0.0",
Expand All @@ -67,7 +67,6 @@
"rollup": "2.21.0",
"sinon": "7.3.1",
"strip-json-comments": "3.1.1",
"terser": "5.17.6",
"testswarm": "1.1.2"
},
"scripts": {
Expand Down