User:Erutuon/scripts/footnoteCleanup.js

Code that you insert on this page could contain malicious content capable of compromising your account. If you import a script from another page with "importScript", "mw.loader.load", "iusc", or "lusc", take note that this causes you to dynamically load a remote script, which could be changed by others. Editors are responsible for all edits and actions they perform, including by scripts. User scripts are not centrally supported and may malfunction or become inoperable due to software changes. A guide to help you find broken scripts is available. If you are unsure whether code you are adding to this page is safe, you can ask at the appropriate village pump.
This code will be executed when previewing this page.

Documentation for this user script can be added at User:Erutuon/scripts/footnoteCleanup.

Note: After saving, you have to bypass your browser's cache to see the changes. Google Chrome, Firefox, Microsoft Edge and Safari: Hold down the ⇧ Shift key and click the Reload toolbar button. For details and instructions about other browsers, see Wikipedia:Bypass your cache.

var namespaceNumber = mw.config.values.wgNamespaceNumber;

if ( namespaceNumber === 0 )
{
	$("#editform").prepend('<div id="footnote-cleanup"><a href="javascript:cleanupFootnotes()">clean up footnotes</a></div>');
}
		
function escape(text, regexString, escapeTable, i)
{
	var regex = new RegEx(regexString, "g");
	text = text.replace(
		regex,
		function(match)
		{
			escapeTable[i] = match;
			replacement = "%%" + i + "%%";
			i += 1;
			return replacement;
		}
	);
	return text;
}

function cleanupFootnotes()
{
	var textbox = $("#wpTextbox1");
	
	if ( textbox )
	{
		var oldContents = textbox.val();
		var contents = oldContents;
		
		// Escape ref tags.
		var escaped = [];
		var i = 0;
		contents = escape(
			contents,
			"<ref[^>]*>[^<]+<\/ref>",
			escaped,
			i
		);
		
		if ( i > 0 )
		{
			mw.notify(i + " refs found.");
		}
		
		var count = 0;
		var replacements = [];
		contents = contents.replace(
			/((?:%%\d+%%)+)([\.\,\;\:\)]{1,3})/g,
			function(match, capture1, capture2)
			{
				count += 1;
				var replacement = capture2 + capture1;
				replacements.push(replacement);
				return replacement;
			}
		);
		
		mw.notify(i + " corrections made: " + replacements.join());
		
		contents = contents.replace(
			/%%(\d+)%%/g,
			function(wholematch, number) {
				number = Number(number);
				return escaped[number];
			}
		);
		
		var isUnchanged = ( oldContents === contents );
		
		if ( isUnchanged )
		{
			mw.notify("No misplaced footnotes were found.");
		}
		
		textbox.val(contents);
		$("#wpSummary").val(function(index, summary)
			{
				mw.notify(summary);
				
				var addition = "made sure refs are after punctuation with [[User:Erutuon/footnoteCleanup.js|JavaScript]]";
				
				afterSectionName = summary.match(/^\/\*[^\*]+\*\/\s+(.+)/);
				
				if ( afterSectionName && afterSectionName[1].length > 1 )
				{
					addition = "; " + addition;
				}
				
				if ( !isUnchanged )
				{
					return summary + addition;
				}
			}
		);
	}
}