User:Erutuon/scripts/footnoteCleanup.js

/* <nowiki>

Moves refs and citation needed tags after punctuation.

*/

var namespaceNumber = mw.config.values.wgNamespaceNumber;

// Add a link just above the edit box, if you're in the main namespace.
if ( namespaceNumber === 0 )
{
	$("#editform").prepend('<div id="footnote-cleanup"><a href="javascript:cleanupFootnotes()">clean up footnotes</a></div>');
}

function cleanupFootnotes()
{
	var textbox = $("#wpTextbox1");
	
	if ( textbox )
	{
		var oldContents = textbox.val();
		var contents = oldContents;
		
		var escaped = [];
		var i = 0;
		
		var replacements = [];
		var count = 0;
		
		var escape = function(text, regexString)
		{
			var regex = new RegExp(regexString, "g");
			text = text.replace(
				regex,
				function(match)
				{
					escaped[i] = match;
					replacement = "%%" + i + "%%";
					i += 1;
					return replacement;
				}
			);
			return text;
		};
		
		var fixPunctuationPlacement = function(text)
		{
			return text.replace(
				/((?:%%\d+%%)+)([\.\,\;\:]{1,3})/g,
				function(match, capture1, capture2)
				{
					count += 1;
					var replacement = capture2 + capture1;
					replacements.push(replacement);
					return replacement;
				}
			);
		};
		
		/*	Escape various things:
			ref tags				*/
		contents = escape(
			contents,
			"<ref[^>]*>[^<]+<\\/ref>"
		);
		
		// citation needed
		contents = escape(
			contents,
			"\\{\\{(?:[Cc]itation needed|[Cc]n|[Ff]act|[Cc]b|[Cc]tn|[Rr]ef\\?)\\|[^\}]+\\}\\}"
		);
		
		contents = fixPunctuationPlacement(contents);
		
		// footnote templates
		/*	Handles up to one level of nested templates.
			Any more, and there may be problems.			*/
		contents = escape(
			contents,
			"\\{\\{(?:sfn|efn|rfn)(?:[^\\}]+?(?:\\{\\{[^\\}]+\\}\\})?)+\\}\\}"
		);
		
		if ( i > 0 )
		{
			mw.notify(i + " refs found.");
		}
		
		contents = fixPunctuationPlacement(contents);
		
		if ( count > 0 ) {
			mw.notify(count + " correction" + ( ( count > 1 && "s" ) || "" ) + " made: " + replacements.join());
		}
		
		/*	Unescape the various things escaped above.
			This has to be done twice, since escaping was done twice.	*/
		contents = contents.replace(
			/%%(\d+)%%/g,
			function(wholematch, number) {
				number = Number(number);
				return escaped[number];
			}
		);
		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 or tagging templates were found.");
		}
		
		textbox.val(contents);
		$("#wpSummary").val(function(index, 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 && ( !afterSectionName || !afterSectionName[1].includes(addition) ) )
				{
					return summary + addition;
				}
			}
		);
	}
}

// </nowiki>