Add `insertAfterTemplates` to Morebits.wikitext.page, respect MOS:ORDER when tagging, update hatnotes #1022

Amorymeltzer · 2020-07-06T15:06:47Z

As noted on WT:TW, Twinkle isn't great about MOS:ORDER when tagging things. Accordingly, this:

1st commit adds a function to Morebits.wikitext.page to insert a string after a provided template regex. This is basically copied from the handling in tag. Takes either a string or an array and allows for custom flags.
2nd commit uses that in xfd/protect/prod/csd/tag, with tag getting the extra benefit of finally learning about protection tags ({{pp}}, {{pp-move}}, etc.). A new hidden preference, hatnoteRegex, is added to store the "various hatnotes templates` regex in a unified location.
3rd commit expands thats regex with most hatnotes from Template:Hatnote templates with more than a hundred or so transclusions.

There are some more notes in the individual commits. The main annoyance is that AfD has a comment before the actual template, so having to support that as well is a drag. Maybe the option to specify a flag for the regex for insertAfterTemplates is unnecessary?

siddharthvp

Looks pretty neat. It would be great if you can include some unit tests too, as you go about testing this. Would make any future changes much easier to verify.

siddharthvp · 2020-07-08T12:18:39Z

twinkle.js

@@ -126,6 +126,9 @@ Twinkle.defaultConfig = {
 	// Hidden preferences
 	autolevelStaleDays: 3, // Huggle is 3, CBNG is 2
 	revertMaxRevisions: 50, // intentionally limited
+	// various hatnote templates, used when tagging
+	// (csd/xfd/tag/prod/protect) to ensure MOS:ORDER
+	hatnoteRegex: 'short description|hatnote|main|correct title|dablink|distinguish|for|further|selfref|year dab|similar names|highway detail hatnote|broader|about(?:-distinguish| other people)?|other\\s?(?:hurricane(?: use)?s|people|persons|places|ships|uses(?: of)?)|redirect(?:-(?:distinguish|synonym|multi))?|see\\s?(?:wiktionary|also(?: if exists)?)',


This is not a user preference at all. What we're missing is a way to share data/code between modules. It would be better to define this as Twinkle.hatnoteRegex in twinkle.js file at the bottom under a header called something like:

/** * Data and code shared between multiple modules, * but not generic enough to be in morebits. */

Such a section will also come handy for a lot of other stuff too.

Exactly right. I wrote it that way at first, but shied away from it because there simply wasn't anything else there. I thought having it in defaultConfig might make it more obvious that "this is a thing to change," but, yes, it'd be better to just do it normally.

Also a good place for #969

siddharthvp · 2020-07-08T12:22:01Z

morebits.js

+
+		// Regex is extra complicated to allow for templates with
+		// parameters and to handle whitespace properly
+		return this.text.replace(


Suggested change

return this.text.replace(

return this.text = this.text.replace(

At the least, this should modify this.text. I'm not sure whether it'd better to return the modified text or just this (which would make the method chainable). Presently, the other Morebits.wikitext methods don't return anything so changing them all to return this is what would make sense IMO, so that it can be used like text = wikipage.insertAfterTemplates(...).getText().

No, that makes sense, and chaining would be ideal. I can toss in some return this-es to the others, IIRC most of the uses are simple.

Unused on enwiki, so added here.

siddharthvp · 2020-07-08T12:33:56Z

morebits.js

+		// .length is only a property of strings and arrays so we
+		// shouldn't need to check type
+		if (!regex || !regex.length) {
+			return tag + this.text;


It's better to throw when the input is clearly invalid, so that the client can know they're doing something wrong.

Fair, although I'm mixed on how much of an error/invalid we should actually consider these. I guess it can just be handled on the "client" side, but this seemed nicer. You're probably right about giving them the option of wanting to know.

Would you think both lack of tag and lack of regex` should throw, or just one?

Went with both

I suppose technically we could check the flags, something like /^[gimsuy]$/

morebits.js

Amorymeltzer · 2020-07-08T18:38:11Z

It would be great if you can include some unit tests too

I'll get around to #946/#944/#911 soon, hopefully.

Toss `return this` at the end of the methods. Uses of `removeLink` and `commentOutImage` were pretty simple and amenable to chaining; `removeTemplate` and `addToImageComment` are currently unused by Twinkle.

Takes the structure of the regex from the `tag` module, and uses it in `Morebits.wikitext.page.prototype.insertAfterTemplates` to properly find complex templates in the page wikitext, then insert a given string after them. The regex is identical to what has been used in `tag`: - The regex for a series of templates is provided as either a string or as an array, from which each item will be pipe-separate. This is what in `tag` is the CSD, PROD, and "various hatnote templates" section. - An optional regex flag can be provided; default is `\i`. - There's an optional `preRegex` for stuff that comes *before* the templates proper (i.e., before `{{`). This is mainly because enWiki's AfD has an annoying hidden html comment before the `/dated` transclusion. We could add `postRegex` in the future, although that's likely overengineering

Uses `Morebits.wikitext.page.insertAfterTemplates` with a customized regex string in the hidden preference string `hatnoteRegex`. `tag` adds on the deletion templates (CSD/PROD/XfD), and finally learns about protection templates.

Barely been updated in a decade; `the` was deleted (https://en.wikipedia.org/wiki/Wikipedia:Templates_for_discussion/Log/2011_January_17#Template:The) in 2011!!! Includes most templates from https://en.wikipedia.org/w/index.php?title=Template:Hatnote_templates with more than ~100, 150 transclusions. A few commonish redirects included as well.

Was part of wikimedia-gadgets#1022 for `insertAfterTemplates`, but wasn't present for `removeLink`, `commentOutImage`, `addToImageComment`, and `removeTemplate`.

Amorymeltzer added Feature request Module: tag Module: speedy Module: morebits The morebits.js library Module: protect Module: xfd Module: prod Module: twinkle The twinkle.js global gadget file labels Jul 6, 2020

siddharthvp reviewed Jul 8, 2020

View reviewed changes

Amorymeltzer force-pushed the mosorder branch from 2ddcc97 to edc63ca Compare July 8, 2020 18:36

Amorymeltzer marked this pull request as ready for review July 9, 2020 10:23

Amorymeltzer force-pushed the mosorder branch from edc63ca to 2552257 Compare July 12, 2020 21:39

Amorymeltzer added this to the July 2020 update milestone Jul 12, 2020

Amorymeltzer added 4 commits July 14, 2020 07:02

morebits: Allow chaining of Morebits.wikitext.page methods

062cc99

Toss `return this` at the end of the methods. Uses of `removeLink` and `commentOutImage` were pretty simple and amenable to chaining; `removeTemplate` and `addToImageComment` are currently unused by Twinkle.

Amorymeltzer force-pushed the mosorder branch from 2552257 to 92f9642 Compare July 14, 2020 11:04

Amorymeltzer merged commit 40592a4 into wikimedia-gadgets:master Jul 14, 2020

Amorymeltzer deleted the mosorder branch July 14, 2020 11:05

Amorymeltzer mentioned this pull request Jul 21, 2020

tag: Stuck in "Adding supported tags inside existing {{multiple issues}} tag" #1058

Closed

Amorymeltzer mentioned this pull request Dec 12, 2020

mb.wikitext.page: Throw for unprovided options, allow no regex flags on insertAfterTemplates #1237

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add `insertAfterTemplates` to Morebits.wikitext.page, respect MOS:ORDER when tagging, update hatnotes #1022

Add `insertAfterTemplates` to Morebits.wikitext.page, respect MOS:ORDER when tagging, update hatnotes #1022

Amorymeltzer commented Jul 6, 2020

siddharthvp left a comment

siddharthvp Jul 8, 2020

Amorymeltzer Jul 8, 2020

Amorymeltzer Jul 8, 2020

siddharthvp Jul 8, 2020 •

edited

Amorymeltzer Jul 8, 2020

Amorymeltzer Jul 8, 2020

siddharthvp Jul 8, 2020

Amorymeltzer Jul 8, 2020 •

edited

Amorymeltzer Jul 12, 2020

Amorymeltzer Jul 13, 2020

Amorymeltzer commented Jul 8, 2020

	return this.text.replace(
	return this.text = this.text.replace(

Add insertAfterTemplates to Morebits.wikitext.page, respect MOS:ORDER when tagging, update hatnotes #1022

Add insertAfterTemplates to Morebits.wikitext.page, respect MOS:ORDER when tagging, update hatnotes #1022

Conversation

Amorymeltzer commented Jul 6, 2020

siddharthvp left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

siddharthvp Jul 8, 2020 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Amorymeltzer Jul 8, 2020 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Amorymeltzer commented Jul 8, 2020

Add `insertAfterTemplates` to Morebits.wikitext.page, respect MOS:ORDER when tagging, update hatnotes #1022

Add `insertAfterTemplates` to Morebits.wikitext.page, respect MOS:ORDER when tagging, update hatnotes #1022

siddharthvp Jul 8, 2020 •

edited

Amorymeltzer Jul 8, 2020 •

edited