Sync with upstream

.eslint-plugin-local.js

@@ -0,0 +1,3 @@
+'use strict';
+
+module.exports = require( './lib/ve/.eslint-plugin-local' );

.gitignore

@@ -22,3 +22,4 @@ tests/selenium/log
 
 # OS
 .DS_Store
+/.stylelintcache

.stylelintrc.json

@@ -5,6 +5,6 @@
 	],
 	"rules": {
 		"no-descending-specificity": null,
-		"selector-class-pattern": "^(ve|mw|oo-ui|client|skin)-"
+		"selector-class-pattern": "^(ve|mw|oo-ui|client|skin|vector)-"
 	}
 }

.svgo.config.js

@@ -0,0 +1,39 @@
+/**
+ * SVGO Configuration
+ * Compatible with v4.0.0+
+ * Recommended options from:
+ * https://www.mediawiki.org/wiki/Manual:Coding_conventions/SVG#Exemplified_safe_configuration
+ */
+'use strict';
+module.exports = {
+	plugins: [
+		{
+			// Set of built-in plugins enabled by default.
+			name: 'preset-default',
+			params: {
+				overrides: {
+					cleanupIds: false,
+					removeDesc: false,
+					// If the SVG doesn't start with an XML declaration, then its MIME type will
+					// be detected as "text/plain" rather than "image/svg+xml" by libmagic and,
+					// consequently, MediaWiki's CSSMin CSS minifier. libmagic's default database
+					// currently requires that SVGs contain an XML declaration:
+					// https://github.com/threatstack/libmagic/blob/master/magic/Magdir/sgml#L5
+					removeXMLProcInst: false
+				}
+			}
+		},
+		'removeRasterImages',
+		'sortAttrs'
+	],
+	// Set whitespace according to Wikimedia Coding Conventions.
+	// @see https://github.com/svg/svgo/blob/main/lib/stringifier.js#L39 for available options.
+	js2svg: {
+		eol: 'lf',
+		finalNewline: true,
+		// Configure the indent to tabs (default 4 spaces) used by `--pretty` here.
+		indent: '\t',
+		pretty: true
+	},
+	multipass: true
+};

Gruntfile.js

@@ -34,7 +34,6 @@ module.exports = function ( grunt ) {
 	grunt.loadNpmTasks( 'grunt-banana-checker' );
 	grunt.loadNpmTasks( 'grunt-contrib-watch' );
 	grunt.loadNpmTasks( 'grunt-eslint' );
-	grunt.loadNpmTasks( 'grunt-image' );
 	grunt.loadNpmTasks( 'grunt-mocha-test' );
 	grunt.loadNpmTasks( 'grunt-stylelint' );
 	grunt.loadNpmTasks( 'grunt-tyops' );
@@ -60,41 +59,6 @@ module.exports = function ( grunt ) {
 				src: [ 'build/screenshots.diffs.js' ]
 			}
 		},
-		image: {
-			pngs: {
-				options: {
-					zopflipng: true,
-					pngout: true,
-					optipng: true,
-					advpng: true,
-					pngcrush: true
-				},
-				'screenshots-en': {
-					expand: true,
-					src: 'screenshots/*-en.png'
-				},
-				'screenshots-all': {
-					expand: true,
-					src: 'screenshots/*.png'
-				}
-			},
-			svgs: {
-				options: {
-					svgo: [
-						'--pretty',
-						'--enable=removeRasterImages',
-						'--enable=sortAttrs',
-						'--disable=cleanupIDs',
-						'--disable=removeDesc',
-						'--disable=removeTitle',
-						'--disable=removeViewBox',
-						'--disable=removeXMLProcInst'
-					]
-				},
-				expand: true,
-				src: 'images/*.svg'
-			}
-		},
 		tyops: {
 			options: {
 				typos: 'build/typos.json'
@@ -120,7 +84,8 @@ module.exports = function ( grunt ) {
 		},
 		stylelint: {
 			options: {
-				reportNeedlessDisables: true
+				reportNeedlessDisables: true,
+				cache: true
 			},
 			all: [
 				'**/*.{css,less}',
@@ -165,14 +130,14 @@ module.exports = function ( grunt ) {
 
 	grunt.registerTask( 'test', [ 'tyops', 'eslint', 'stylelint', 'banana' ] );
 	grunt.registerTask( 'test-ci', [ 'git-status' ] );
-	grunt.registerTask( 'screenshots', [ 'mochaTest:screenshots-en', 'image:pngs' ] );
-	grunt.registerTask( 'screenshots-all', [ 'mochaTest:screenshots-all', 'image:pngs' ] );
+	grunt.registerTask( 'screenshots', [ 'mochaTest:screenshots-en' ] );
+	grunt.registerTask( 'screenshots-all', [ 'mochaTest:screenshots-all' ] );
 	grunt.registerTask( 'default', 'test' );
 
 	if ( process.env.JENKINS_HOME ) {
 		grunt.renameTask( 'test', 'test-internal' );
 		grunt.registerTask( 'test', [ 'test-internal', 'test-ci' ] );
 	} else {
-		grunt.registerTask( 'ci', [ 'test', 'image:svgs', 'test-ci' ] );
+		grunt.registerTask( 'ci', [ 'test', 'test-ci' ] );
 	}
 };

bin/updateSubmodule.sh

@@ -46,18 +46,28 @@ fi
 
 # Generate commit summary
 NEWCHANGES=$(git log ..$TARGET --oneline --no-merges --topo-order --reverse --color=never)
+
+if [ -z "$NEWCHANGES" ]; then
+	echo >&2 "No new changes"
+	exit 1
+fi
+
+LOCALISATION_UPDATES=$(echo "$NEWCHANGES" | grep "Localisation updates from https://translatewiki.net" | awk '{print $1}' | paste -sd, - | sed -E 's/,/, /g' | sed -E 's/(([^,]+, ?){6}) /\1\n/g')
+NEWCHANGES=$(echo "$NEWCHANGES" | grep -v "Localisation updates from https://translatewiki.net")
 TASKS=$(git log ..$TARGET --no-merges --format=format:%B | grep "Bug: T" | sort | uniq)
 
 # Ensure script continues if grep "fails" (returns nothing) with || : (due to -e flag in bash)
 
-# Addede/removed i18n keys
+# Added/removed i18n keys
   ADDED_I18N_KEYS=$(git diff HEAD..$TARGET -- i18n/en.json | grep -E '^\+' | grep --color=never -vE '^\+\+\+' | sed -E 's/^\+\s*"([^"]+)":.*/\1/' | sed 's/^/- /' || :)
 DELETED_I18N_KEYS=$(git diff HEAD..$TARGET -- i18n/en.json | grep -E '^\-' | grep --color=never -vE '^\-\-\-' | sed -E 's/^\-\s*"([^"]+)":.*/\1/' | sed 's/^/- /' || :)
+
 # Find common keys (modified keys)
 MODIFIED_KEYS=$(echo -e "$ADDED_I18N_KEYS\n$DELETED_I18N_KEYS" | sort | uniq -d)
+
 # Remove modified keys from the added and removed lists
-  ADDED_I18N_KEYS=$(echo "$ADDED_I18N_KEYS" | grep -vxF -f <(echo "$MODIFIED_KEYS") | sed 's/^/- /')
-DELETED_I18N_KEYS=$(echo "$DELETED_I18N_KEYS" | grep -vxF -f <(echo "$MODIFIED_KEYS") | sed 's/^/- /')
+  ADDED_I18N_KEYS=$(echo "$ADDED_I18N_KEYS" | grep -vxF -f <(echo "$MODIFIED_KEYS") || :)
+DELETED_I18N_KEYS=$(echo "$DELETED_I18N_KEYS" | grep -vxF -f <(echo "$MODIFIED_KEYS") || :)
 
 # Added/removed files
   ADDED_FILES=$(git diff HEAD..$TARGET --name-only --diff-filter=A | grep --color=never -E "\.(js|css|less)$" | sed 's/^/- /' || :)
@@ -68,6 +78,13 @@ COMMITMSG="Update VE core submodule to $TARGETDESC
 New changes:
 $NEWCHANGES"
 
+if [ -n "$LOCALISATION_UPDATES" ]; then
+    COMMITMSG+="
+
+Localisation Updates:
+$LOCALISATION_UPDATES"
+fi
+
 if [ -n "$ADDED_I18N_KEYS" ]; then
     COMMITMSG+="
 

build/checkModules.js

@@ -1,10 +1,24 @@
+/**
+ * Checks that all files referenced in lib/ve/build/modules.json are either:
+ *   - referenced by a ResourceModule's veModules in extension.json (and thus loaded dynamically), or
+ *   - explicitly listed in scripts/styles in extension.json, or
+ *   - ignored via the ignore list in this script.
+ *
+ * Warns about unused "ignored" entries and errors on missing files.
+ */
+
 'use strict';
 
 const path = require( 'path' );
 
 const extensionJson = require( '../extension.json' );
 const modulesJson = require( '../lib/ve/build/modules.json' );
 
+/**
+ * List of file/directory patterns to ignore.
+ *
+ * @type {string[]}
+ */
 const ignored = [
 	'node_modules/',
 	'lib/',
@@ -28,8 +42,20 @@ const ignored = [
 	'tests/dm/ve.dm.TransportServer.test.js'
 ];
 
+/**
+ * Ignored entries which haven't been used yet.
+ *
+ * @type {Set<string>}
+ */
 const unusedIgnores = new Set( ignored );
 
+/**
+ * Add file or files to a Set, prefixing with basePath.
+ *
+ * @param {string|string[]|Object[]} files
+ * @param {Set<string>} set
+ * @param {string} [basePath='']
+ */
 function addFilesToSet( files, set, basePath = '' ) {
 	if ( Array.isArray( files ) ) {
 		files.forEach( ( file ) => set.add( path.join( basePath, file.file || file ) ) );
@@ -38,6 +64,14 @@ function addFilesToSet( files, set, basePath = '' ) {
 	}
 }
 
+/**
+ * Check if the filePath matches any 'ignored' entry.
+ *
+ * If matched, the entry is removed from unusedIgnores.
+ *
+ * @param {string} filePath
+ * @return {boolean}
+ */
 function isIgnored( filePath ) {
 	return ignored.some( ( ignorePath ) => {
 		const fullIgnorePath = path.join( 'lib/ve', ignorePath );
@@ -49,6 +83,13 @@ function isIgnored( filePath ) {
 	} );
 }
 
+/**
+ * Add all scripts and styles files from a modules object to a Set.
+ *
+ * @param {Object} modules
+ * @param {Set<string>} set
+ * @param {string} [basePath]
+ */
 function addModulesToSet( modules, set, basePath = '' ) {
 	Object.values( modules ).forEach( ( module ) => {
 		[
@@ -68,34 +109,38 @@ function addModulesToSet( modules, set, basePath = '' ) {
 	} );
 }
 
-function checkFiles() {
-	const extensionFiles = new Set();
-	addModulesToSet( extensionJson.ResourceModules, extensionFiles );
-	addModulesToSet( { QUnitTestModule: extensionJson.QUnitTestModule }, extensionFiles );
-
-	const modulesFiles = new Set();
-	addModulesToSet( modulesJson, modulesFiles, 'lib/ve' );
+const extensionFiles = new Set();
+addModulesToSet( extensionJson.ResourceModules, extensionFiles );
+addModulesToSet( { QUnitTestModule: extensionJson.QUnitTestModule }, extensionFiles );
 
-	const missingFiles = Array.from( modulesFiles ).filter( ( file ) => !extensionFiles.has( file ) && !isIgnored( file ) );
-
-	if ( unusedIgnores.size ) {
-		console.warn(
-			'Unused ignore path(s) in checkModules.js:\n\n' +
-			Array.from( unusedIgnores ).map( ( ignore ) => `* ${ ignore }\n` ).join( '' )
-		);
+// Modules listed in veModules of ResourceModules are loaded automatically.
+Object.values( extensionJson.ResourceModules ).forEach( ( module ) => {
+	if ( module.veModules ) {
+		module.veModules.forEach( ( veModule ) => {
+			addModulesToSet( { [ veModule ]: modulesJson[ veModule ] || {} }, extensionFiles, 'lib/ve' );
+		} );
 	}
+} );
 
-	if ( missingFiles.length ) {
-		console.error(
-			`${ missingFiles.length } file(s) from lib/ve/modules.json are missing from extension.json:\n\n` +
-			missingFiles.map( ( file ) => `* ${ file }\n` ).join( '' ) +
-			'\nIf any of these files are not required, add them to the ignore list in build/checkModules.js.'
-		);
-		// eslint-disable-next-line n/no-process-exit
-		process.exit( 1 );
-	} else {
-		console.log( 'No missing files.' );
-	}
+const modulesFiles = new Set();
+addModulesToSet( modulesJson, modulesFiles, 'lib/ve' );
+const missingFiles = Array.from( modulesFiles ).filter( ( file ) => !extensionFiles.has( file ) && !isIgnored( file ) );
+
+if ( unusedIgnores.size ) {
+	console.warn(
+		'Unused ignore path(s) in checkModules.js:\n\n' +
+		Array.from( unusedIgnores ).map( ( ignore ) => `* ${ ignore }\n` ).join( '' )
+	);
 }
 
-checkFiles();
+if ( missingFiles.length ) {
+	console.error(
+		`${ missingFiles.length } file(s) from lib/ve/modules.json are missing from extension.json:\n\n` +
+		missingFiles.map( ( file ) => `* ${ file }\n` ).join( '' ) +
+		'\nIf any of these files are not required, add them to the ignore list in build/checkModules.js.'
+	);
+	// eslint-disable-next-line n/no-process-exit
+	process.exit( 1 );
+} else {
+	console.log( 'No missing files.' );
+}

build/screenshots-client/userGuide.js

@@ -136,7 +136,7 @@ module.exports = {
 		const done = arguments[ arguments.length - 1 ],
 			surface = ve.init.target.surface;
 
-		surface.getToolbarDialogs().once( 'opening', ( win, opening ) => {
+		surface.getToolbarDialogs( 'above' ).once( 'opening', ( win, opening ) => {
 			opening.then( () => {
 				setTimeout( () => {
 					done(
@@ -153,7 +153,7 @@ module.exports = {
 	specialCharactersTeardown: function () {
 		const done = arguments[ arguments.length - 1 ],
 			surface = ve.init.target.surface;
-		surface.getToolbarDialogs().currentWindow.close().closed.then( done );
+		surface.getToolbarDialogs( 'above' ).currentWindow.close().closed.then( done );
 	},
 	formula: function () {
 		const done = arguments[ arguments.length - 1 ],

build/screenshots-client/utils.js

@@ -3,28 +3,9 @@ module.exports = function () {
 
 	window.seleniumUtils = {
 		getBoundingRect: function ( elements ) {
-			let boundingRect;
-			for ( let i = 0, l = elements.length; i < l; i++ ) {
-				const rect = elements[ i ].getBoundingClientRect();
-				if ( !boundingRect ) {
-					boundingRect = {
-						left: rect.left,
-						top: rect.top,
-						right: rect.right,
-						bottom: rect.bottom
-					};
-				} else {
-					boundingRect.left = Math.min( boundingRect.left, rect.left );
-					boundingRect.top = Math.min( boundingRect.top, rect.top );
-					boundingRect.right = Math.max( boundingRect.right, rect.right );
-					boundingRect.bottom = Math.max( boundingRect.bottom, rect.bottom );
-				}
-			}
-			if ( boundingRect ) {
-				boundingRect.width = boundingRect.right - boundingRect.left;
-				boundingRect.height = boundingRect.bottom - boundingRect.top;
-			}
-			return boundingRect;
+			return ve.getBoundingRect(
+				elements.map( ( element ) => element.getBoundingClientRect() )
+			);
 		},
 		collapseToolbar: function () {
 			ve.init.target.toolbar.items.forEach( ( group ) => {