User:Novem Linguae/Scripts/DraftCleaner.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:Novem Linguae/Scripts/DraftCleaner.

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.

/* THIS SCRIPT IS STILL IN BETA AND IS BUGGY ABOUT 25% OF THE TIME. Be sure to check the diff that pops up before submitting.

- Adds "Run DraftCleaner" link to the left sidebar

- Top uses:
	- remove extra line breaks
	- in the first sentence, bold the title
	- convert curly quotes to regular quotes
	- put <ref>s after periods
	- clean external links out of the main article area (turn them into references)
	- add ==References== section

- More detailed list of uses:
	- converts [inline external links] to <ref>s
	- reduces more than 2 enters in a row, to 2 enters
	- removes spaces in front of <ref>s
	- get rid of any level 2 heading that contains the article's title
	- bolds the first occurrence of the article title
	- removes bold from headings
	- converts =TitleHeading= to ==H2Heading==
	- replaces Covid-19 with COVID-19
	- removes enter characters between <ref>s
	- trims whitespace at beginning and end
	- remove self wikilinks to the article title
	- convert ==Reference== to ==References==
	- swap ref period with period ref
	- turn bare URLs into references
	- fix errant spaces at beginning of lines, which makes a blockquote looking thing
	- add references section if missing
	- delete whitespace at the end of lines
	- convert smart quotes to regular quotes
	- convert double spaces to single spaces
	- remove blank heading
	- in refs, turn short links into long links, so you can see the ___domain
	- change year range dash to ndash
	- if in draftspace, and draft in categories, disable the categories
	- delete <br>. in drafts, these are usually poorly placed
	- fix empty references section
	- right align images
	- remove whitespace if that is the only character on a line
	- correct capitalization of see also, references, further reading, external links
	- if article has headings but no lead, remove first heading
	- replace unicode bullets with asterisks

This page was assembled from 3 files using my publish.php script. I have an offline test suite with around 100 unit tests for the DraftCleaner and StringFilter classes.
*/

async function getWikicode(title) {
	if ( ! mw.config.get('wgCurRevisionId') ) return ''; // if page is deleted, return blank
	var wikicode = '';
	title = encodeURIComponent(title);
	await $.ajax({
		url: 'https://en.wikipedia.org/w/api.php?action=parse&page='+title+'&prop=wikitext&formatversion=2&format=json',
		success: function (result) {
			wikicode = result['parse']['wikitext'];
		},
		dataType: "json",
	});
	return wikicode;
}

// borrowed from [[Wikipedia:User scripts/Guide#Edit a page and other common actions]]
function editPage(articleName, wikicode, summary) {
	let debugInfo = $.ajax({
		url: mw.util.wikiScript('api'),
		type: 'POST',
		dataType: 'json',
		data: {
			format: 'json',
			action: 'edit',
			title: articleName,
			text: wikicode, // will replace entire page content
			summary: summary,
			token: mw.user.tokens.get('csrfToken')
		},
		async: false
	});
}

function goToShowChangesScreen(titleWithNamespaceAndUnderscores, wikicode, editSummary) {
	let titleEncoded = encodeURIComponent(titleWithNamespaceAndUnderscores);
	let wgServer = mw.config.get('wgServer');
	let wgScriptPath = mw.config.get('wgScriptPath');
	let baseURL = wgServer + wgScriptPath + '/';
	// https://stackoverflow.com/a/12464290/3480193
	$(`<form action="${baseURL}index.php?title=${titleEncoded}&action=submit" method="POST"/>`)
		.append($('<input type="hidden" name="wpTextbox1">').val(wikicode))
		.append($('<input type="hidden" name="wpSummary">').val(editSummary))
		.append($('<input type="hidden" name="mode">').val('preview'))
		.append($('<input type="hidden" name="wpDiff">').val('Show changes'))
		.append($('<input type="hidden" name="wpUltimateParam">').val('1'))
		.appendTo($(document.body)) //it has to be added somewhere into the <body>
		.submit();
}

/** returns the pagename, including the namespace name, but with spaces replaced by underscores */
function getArticleName() {
	return mw.config.get('wgPageName');
}

function showMessage(messageText) {
	$('#DraftCleaner').hide();
	$('#DraftCleanerNoClick').empty();
	$('#DraftCleanerNoClick').prepend(messageText);
	$('#DraftCleanerNoClick').show();
}

function showClickableButton() {
	$('#DraftCleanerNoClick').hide();
	$('#DraftCleaner').show();
}

/** refresh AND clear cache */
function hardRefresh() {
	// window.___location.reload(true) is deprecated. use this instead
	window.___location.href = window.___location.href;
}

// don't run when not viewing articles
let action = mw.config.get('wgAction');
if ( action != 'view' ) return;

// don't run when viewing diffs
let isDiff = mw.config.get('wgDiffNewId');
if ( isDiff ) return;

// Only run in mainspace, draftspace, and sandboxes
let titleWithNamespaceAndUnderscores = getArticleName();
let namespaceNumber = mw.config.get('wgNamespaceNumber');
let sandbox = titleWithNamespaceAndUnderscores.match(/sandbox/i);
//if ( ! [0, 118].includes(namespaceNumber) && ! sandbox ) return;

let menuID = window.draftCleanerPutInToolsMenu ? 'p-tb' : 'p-navigation';

// Add DraftCleaner to left sidebar
// Using two <li>s. One of the two is kept hidden at all times. This avoids having to delete #DraftCleanerLink, which would also delete the event listener.
$(`#${menuID} ul`).append(`
	<li id="DraftCleaner">
		<a id="DraftCleanerLink">Run DraftCleaner</a>
	</li>
	
	<li id="DraftCleanerNoClick" style="display:none">
		
	</li>
`);

$('#DraftCleanerLink').on('click', async function() {
	// prevent running the script while script is already in progress
	showMessage('Editing. Please wait.');
	
	// get page wikicode
	let titleWithNamespaceAndSpaces = titleWithNamespaceAndUnderscores.replace(/_/g, ' ');
	let originalWikicode = await getWikicode(titleWithNamespaceAndUnderscores);
	let wikicode = originalWikicode;

	let dc = new DraftCleaner();
	wikicode = dc.cleanDraft(wikicode, namespaceNumber, titleWithNamespaceAndSpaces);

	// if changes to be made
	if ( wikicode != originalWikicode ) {
		let summary = 'clean up ([[User:Novem Linguae/Scripts/DraftCleaner.js|DraftCleaner]])';
		// editPage(titleWithNamespaceAndUnderscores, wikicode);
		// hardRefresh();
		await goToShowChangesScreen(titleWithNamespaceAndUnderscores, wikicode, summary);
	// else display "no changes needed", then reset
	} else {
		showMessage('No changes needed.');
		
		setTimeout(function (){
			showClickableButton();
		}, 2000);
	}
});