WIP All: Support selectively disabling Migrate patches

Fixes gh-449

Author: mgol

src/disableWarnings.js

@@ -0,0 +1,29 @@
+// A map from disabled patch codes to `true`. This should really
+// be a `Set` but those are unsupported in IE.
+export var disabledPatches = Object.create( null );
+
+// Don't apply patches for specified codes. Helpful for code bases
+// where some Migrate warnings have been addressed and it's desirable
+// to avoid needless patches or false positives.
+jQuery.migrateDisablePatches = function() {
+	var i;
+	for ( i = 0; i < arguments.length; i++ ) {
+		disabledPatches[ arguments[ i ] ] = true;
+	}
+};
+
+// Allow enabling patches disabled via `jQuery.migrateDisablePatches`.
+// Helpful if you want to disable a patch only for some code that won't
+// be updated soon to be able to focus on other warnings - and enable it
+// immediately after such a call:
+// ```js
+// jQuery.migrateDisablePatches( "workaroundA" );
+// elem.pluginViolatingWarningA( "pluginMethod" );
+// jQuery.migrateEnablePatches( "workaroundA" );
+// ```
+jQuery.migrateEnablePatches = function() {
+	var i;
+	for ( i = 0; i < arguments.length; i++ ) {
+		delete disabledPatches[ arguments[ i ] ];
+	}
+};

src/jquery/ajax.js

@@ -12,11 +12,11 @@ jQuery.ajax = function( ) {
 
 	// Be sure we got a jQXHR (e.g., not sync)
 	if ( jQXHR.promise ) {
-		migrateWarnFunc( jQXHR, "success", jQXHR.done,
+		migrateWarnFunc( jQXHR, "success", jQXHR.done, "jqxhr-methods",
 			"jQXHR.success is deprecated and removed" );
-		migrateWarnFunc( jQXHR, "error", jQXHR.fail,
+		migrateWarnFunc( jQXHR, "error", jQXHR.fail, "jqxhr-methods",
 			"jQXHR.error is deprecated and removed" );
-		migrateWarnFunc( jQXHR, "complete", jQXHR.always,
+		migrateWarnFunc( jQXHR, "complete", jQXHR.always, "jqxhr-methods",
 			"jQXHR.complete is deprecated and removed" );
 	}
 
@@ -40,7 +40,7 @@ if ( !jQueryVersionSince( "4.0.0" ) ) {
 					.indexOf( "application/x-www-form-urlencoded" ) === 0 &&
 				rjsonp.test( s.data )
 		) ) {
-			migrateWarn( "JSON-to-JSONP auto-promotion is deprecated" );
+			migrateWarn( "jsonp-promotion", "JSON-to-JSONP auto-promotion is deprecated" );
 		}
 	} );
 }

src/jquery/attributes.js

@@ -1,4 +1,5 @@
-import { migrateWarn } from "../main.js";
+import { migratePatchFunc, migrateWarn } from "../main.js";
+import { disabledPatches } from "../disableWarnings.js";
 
 var oldRemoveAttr = jQuery.fn.removeAttr,
 	oldToggleClass = jQuery.fn.toggleClass,
@@ -7,24 +8,28 @@ var oldRemoveAttr = jQuery.fn.removeAttr,
 jQuery.fn.removeAttr = function( name ) {
 	var self = this;
 
-	jQuery.each( name.match( rmatchNonSpace ), function( _i, attr ) {
-		if ( jQuery.expr.match.bool.test( attr ) ) {
-			migrateWarn( "jQuery.fn.removeAttr no longer sets boolean properties: " + attr );
-			self.prop( attr, false );
-		}
-	} );
+	if ( !disabledPatches[ "removeattr-bool" ] ) {
+		jQuery.each( name.match( rmatchNonSpace ), function( _i, attr ) {
+			if ( jQuery.expr.match.bool.test( attr ) ) {
+				migrateWarn( "removeattr-bool",
+					"jQuery.fn.removeAttr no longer sets boolean properties: " + attr );
+				self.prop( attr, false );
+			}
+		} );
+	}
 
 	return oldRemoveAttr.apply( this, arguments );
 };
 
-jQuery.fn.toggleClass = function( state ) {
+migratePatchFunc( jQuery.fn, "toggleClass", function( state ) {
 
 	// Only deprecating no-args or single boolean arg
 	if ( state !== undefined && typeof state !== "boolean" ) {
+
 		return oldToggleClass.apply( this, arguments );
 	}
 
-	migrateWarn( "jQuery.fn.toggleClass( boolean ) is deprecated" );
+	migrateWarn( "toogleclass-bool", "jQuery.fn.toggleClass( boolean ) is deprecated" );
 
 	// Toggle entire class name of each element
 	return this.each( function() {
@@ -46,4 +51,4 @@ jQuery.fn.toggleClass = function( state ) {
 			);
 		}
 	} );
-};
+}, "toogleclass-bool" );

src/jquery/core.js

@@ -1,5 +1,6 @@
 import { jQueryVersionSince } from "../compareVersions.js";
 import { migrateWarn, migrateWarnFunc, migrateWarnProp } from "../main.js";
+import { disabledPatches } from "../disableWarnings.js";
 
 var findProp,
 	class2type = {},
@@ -16,23 +17,26 @@ var findProp,
 jQuery.fn.init = function( arg1 ) {
 	var args = Array.prototype.slice.call( arguments );
 
-	if ( typeof arg1 === "string" && arg1 === "#" ) {
+	if ( !disabledPatches[ "code-TODO" ] && typeof arg1 === "string" && arg1 === "#" ) {
 
-		// JQuery( "#" ) is a bogus ID selector, but it returned an empty set before jQuery 3.0
-		migrateWarn( "jQuery( '#' ) is not a valid selector" );
+		// JQuery( "#" ) is a bogus ID selector, but it returned an empty set
+		// before jQuery 3.0
+		migrateWarn( "code-TODO", "jQuery( '#' ) is not a valid selector" );
 		args[ 0 ] = [];
 	}
 
 	return oldInit.apply( this, args );
 };
+
 jQuery.fn.init.prototype = jQuery.fn;
 
 jQuery.find = function( selector ) {
 	var args = Array.prototype.slice.call( arguments );
 
 	// Support: PhantomJS 1.x
 	// String#match fails to match when used with a //g RegExp, only on some strings
-	if ( typeof selector === "string" && rattrHashTest.test( selector ) ) {
+	if ( !disabledPatches[ "selector-hash" ] &&
+		typeof selector === "string" && rattrHashTest.test( selector ) ) {
 
 		// The nonstandard and undocumented unquoted-hash was removed in jQuery 1.12.0
 		// First see if qS thinks it's a valid selector, if so avoid a false positive
@@ -49,10 +53,12 @@ jQuery.find = function( selector ) {
 			// Note that there may be false alarms if selector uses jQuery extensions
 			try {
 				window.document.querySelector( selector );
-				migrateWarn( "Attribute selector with '#' must be quoted: " + args[ 0 ] );
+				migrateWarn( "selector-hash",
+					"Attribute selector with '#' must be quoted: " + args[ 0 ] );
 				args[ 0 ] = selector;
 			} catch ( err2 ) {
-				migrateWarn( "Attribute selector with '#' was not fixed: " + args[ 0 ] );
+				migrateWarn( "selector-hash",
+					"Attribute selector with '#' was not fixed: " + args[ 0 ] );
 			}
 		}
 	}
@@ -70,24 +76,24 @@ for ( findProp in oldFind ) {
 // The number of elements contained in the matched element set
 migrateWarnFunc( jQuery.fn, "size", function() {
 	return this.length;
-},
+}, "size",
 "jQuery.fn.size() is deprecated and removed; use the .length property" );
 
 migrateWarnFunc( jQuery, "parseJSON", function() {
 	return JSON.parse.apply( null, arguments );
-},
+}, "parse-json",
 "jQuery.parseJSON is deprecated; use JSON.parse" );
 
 migrateWarnFunc( jQuery, "holdReady", jQuery.holdReady,
-	"jQuery.holdReady is deprecated" );
+	"hold-ready", "jQuery.holdReady is deprecated" );
 
 migrateWarnFunc( jQuery, "unique", jQuery.uniqueSort,
-	"jQuery.unique is deprecated; use jQuery.uniqueSort" );
+	"unique-sort", "jQuery.unique is deprecated; use jQuery.uniqueSort" );
 
 // Now jQuery.expr.pseudos is the standard incantation
-migrateWarnProp( jQuery.expr, "filters", jQuery.expr.pseudos,
+migrateWarnProp( jQuery.expr, "filters", jQuery.expr.pseudos, "expr-colon",
 	"jQuery.expr.filters is deprecated; use jQuery.expr.pseudos" );
-migrateWarnProp( jQuery.expr, ":", jQuery.expr.pseudos,
+migrateWarnProp( jQuery.expr, ":", jQuery.expr.pseudos, "expr-filters",
 	"jQuery.expr[':'] is deprecated; use jQuery.expr.pseudos" );
 
 // Prior to jQuery 3.1.1 there were internal refs so we don't warn there
@@ -96,18 +102,18 @@ if ( jQueryVersionSince( "3.1.1" ) ) {
 		return text == null ?
 			"" :
 			( text + "" ).replace( rtrim, "" );
-	},
+	}, "trim",
 	"jQuery.trim is deprecated; use String.prototype.trim" );
 }
 
 // Prior to jQuery 3.2 there were internal refs so we don't warn there
 if ( jQueryVersionSince( "3.2.0" ) ) {
 	migrateWarnFunc( jQuery, "nodeName", function( elem, name ) {
 		return elem.nodeName && elem.nodeName.toLowerCase() === name.toLowerCase();
-	},
+	}, "node-name",
 	"jQuery.nodeName is deprecated" );
 
-	migrateWarnFunc( jQuery, "isArray", Array.isArray,
+	migrateWarnFunc( jQuery, "isArray", Array.isArray, "is-array",
 		"jQuery.isArray is deprecated; use Array.isArray"
 	);
 }
@@ -126,7 +132,7 @@ if ( jQueryVersionSince( "3.3.0" ) ) {
 				// ...but misinterprets leading-number strings, e.g. hex literals ("0x...")
 				// subtraction forces infinities to NaN
 				!isNaN( obj - parseFloat( obj ) );
-		},
+		}, "is-numeric",
 		"jQuery.isNumeric() is deprecated"
 	);
 
@@ -146,19 +152,19 @@ if ( jQueryVersionSince( "3.3.0" ) ) {
 		return typeof obj === "object" || typeof obj === "function" ?
 			class2type[ Object.prototype.toString.call( obj ) ] || "object" :
 			typeof obj;
-	},
+	}, "type",
 	"jQuery.type is deprecated" );
 
 	migrateWarnFunc( jQuery, "isFunction",
 		function( obj ) {
 			return typeof obj === "function";
-		},
+		}, "is-function",
 		"jQuery.isFunction() is deprecated" );
 
 	migrateWarnFunc( jQuery, "isWindow",
 		function( obj ) {
 			return obj != null && obj === obj.window;
-		},
+		}, "is-window",
 		"jQuery.isWindow() is deprecated"
 	);
 }

src/jquery/css.js

@@ -1,8 +1,9 @@
 import { jQueryVersionSince } from "../compareVersions.js";
-import { migrateWarn } from "../main.js";
+import { migrateWarn, migratePatchFunc } from "../main.js";
 import { camelCase } from "../utils.js";
+import { disabledPatches } from "../disableWarnings.js";
 
-var oldFnCss,
+var origFnCss,
 	internalSwapCall = false,
 	ralphaStart = /^[a-z]/,
 
@@ -47,12 +48,12 @@ if ( jQuery.swap ) {
 	} );
 }
 
-jQuery.swap = function( elem, options, callback, args ) {
+migratePatchFunc( jQuery, "swap", function( elem, options, callback, args ) {
 	var ret, name,
 		old = {};
 
 	if ( !internalSwapCall ) {
-		migrateWarn( "jQuery.swap() is undocumented and deprecated" );
+		migrateWarn( "swap", "jQuery.swap() is undocumented and deprecated" );
 	}
 
 	// Remember the old values, and insert the new ones
@@ -69,13 +70,13 @@ jQuery.swap = function( elem, options, callback, args ) {
 	}
 
 	return ret;
-};
+}, "swap" );
 
 if ( jQueryVersionSince( "3.4.0" ) && typeof Proxy !== "undefined" ) {
 
 	jQuery.cssProps = new Proxy( jQuery.cssProps || {}, {
 		set: function() {
-			migrateWarn( "jQuery.cssProps is deprecated" );
+			migrateWarn( "css-props", "jQuery.cssProps is deprecated" );
 			return Reflect.set.apply( this, arguments );
 		}
 	} );
@@ -119,24 +120,29 @@ function isAutoPx( prop ) {
 		rautoPx.test( prop[ 0 ].toUpperCase() + prop.slice( 1 ) );
 }
 
-oldFnCss = jQuery.fn.css;
+origFnCss = jQuery.fn.css;
 
 jQuery.fn.css = function( name, value ) {
 	var camelName,
 		origThis = this;
-	if ( name && typeof name === "object" && !Array.isArray( name ) ) {
-		jQuery.each( name, function( n, v ) {
-			jQuery.fn.css.call( origThis, n, v );
-		} );
-		return this;
-	}
-	if ( typeof value === "number" ) {
-		camelName = camelCase( name );
-		if ( !isAutoPx( camelName ) && !jQuery.cssNumber[ camelName ] ) {
-			migrateWarn( "Number-typed values are deprecated for jQuery.fn.css( \"" +
-				name + "\", value )" );
+
+	if ( !disabledPatches[ "css-number" ] ) {
+		if ( name && typeof name === "object" && !Array.isArray( name ) ) {
+			jQuery.each( name, function( n, v ) {
+				jQuery.fn.css.call( origThis, n, v );
+			} );
+			return this;
+		}
+
+		if ( typeof value === "number" ) {
+			camelName = camelCase( name );
+			if ( !isAutoPx( camelName ) && !jQuery.cssNumber[ camelName ] ) {
+				migrateWarn( "css-number",
+					"Number-typed values are deprecated for jQuery.fn.css( \"" +
+					name + "\", value )" );
+			}
 		}
 	}
 
-	return oldFnCss.apply( this, arguments );
+	return origFnCss.apply( this, arguments );
 };

src/jquery/data.js

@@ -1,40 +1,47 @@
 import { migrateWarn } from "../main.js";
 import { camelCase } from "../utils.js";
+import { disabledPatches } from "../disableWarnings.js";
 
-var oldData = jQuery.data;
+var origData = jQuery.data;
 
 jQuery.data = function( elem, name, value ) {
 	var curData, sameKeys, key;
 
 	// Name can be an object, and each entry in the object is meant to be set as data
-	if ( name && typeof name === "object" && arguments.length === 2 ) {
-		curData = jQuery.hasData( elem ) && oldData.call( this, elem );
+	if ( !disabledPatches[ "data-camel-case" ] &&
+		name && typeof name === "object" && arguments.length === 2 ) {
+
+		curData = jQuery.hasData( elem ) && origData.call( this, elem );
 		sameKeys = {};
 		for ( key in name ) {
 			if ( key !== camelCase( key ) ) {
-				migrateWarn( "jQuery.data() always sets/gets camelCased names: " + key );
+				migrateWarn( "data-camel-case",
+					"jQuery.data() always sets/gets camelCased names: " + key );
 				curData[ key ] = name[ key ];
 			} else {
 				sameKeys[ key ] = name[ key ];
 			}
 		}
 
-		oldData.call( this, elem, sameKeys );
+		origData.call( this, elem, sameKeys );
 
 		return name;
 	}
 
 	// If the name is transformed, look for the un-transformed name in the data object
-	if ( name && typeof name === "string" && name !== camelCase( name ) ) {
-		curData = jQuery.hasData( elem ) && oldData.call( this, elem );
+	if ( !disabledPatches[ "data-camel-case" ] &&
+		name && typeof name === "string" && name !== camelCase( name ) ) {
+
+		curData = jQuery.hasData( elem ) && origData.call( this, elem );
 		if ( curData && name in curData ) {
-			migrateWarn( "jQuery.data() always sets/gets camelCased names: " + name );
+			migrateWarn( "data-camel-case",
+				"jQuery.data() always sets/gets camelCased names: " + name );
 			if ( arguments.length > 2 ) {
 				curData[ name ] = value;
 			}
 			return curData[ name ];
 		}
 	}
 
-	return oldData.apply( this, arguments );
+	return origData.apply( this, arguments );
 };