wikiplus-highlight 2.8.1 → 2.13.1

package/matchtags.js

@@ -39,7 +39,7 @@
 			return /\b(?:mw-(?:html|ext)tag-)?bracket\b/.test(type);
 		}
 
-		// Jump to the start of the next line
+		/** Jump to the start of the next line */
 		nextLine() {
 			if (this.line >= this.max) {
 				return;
@@ -49,7 +49,7 @@
 			return true;
 		}
 
-		// Jump to the end of the previous line
+		/** Jump to the end of the previous line */
 		prevLine() {
 			if (this.line <= this.min) {
 				return;
@@ -59,7 +59,7 @@
 			return true;
 		}
 
-		// Jump to the letter after a '>' towards the line end
+		/** Jump to the letter after a '>' towards the line end */
 		toTagEnd() {
 			for (;;) {
 				const gt = this.text.indexOf('>', this.ch);
@@ -74,7 +74,7 @@
 			}
 		}
 
-		// Jump to a '<' towards the line start
+		/** Jump to a '<' towards the line start */
 		toTagStart() {
 			for (;;) {
 				const lt = this.ch ? this.text.lastIndexOf('<', this.ch - 1) : -1;
@@ -94,7 +94,7 @@
 			}
 		}
 
-		// Jump to the start of the last line, or the letter after a ${tagStart}
+		/** Jump to the start of the last line, or the letter after a ${tagStart} */
 		toNextTag() {
 			for (;;) {
 				tagStart.lastIndex = this.ch;
@@ -115,7 +115,7 @@
 			}
 		}
 
-		// Jump to the end of the first line, or a non-bracket '>', or the letter after a tag bracket '>'
+		/** Jump to the end of the first line, or a non-bracket '>', or the letter after a tag bracket '>' */
 		toPrevTag() {
 			for (;;) {
 				const gt = this.ch ? this.text.lastIndexOf('>', this.ch - 1) : -1;
@@ -137,7 +137,10 @@
 			}
 		}
 
-		/** @param {string} tag */
+		/**
+		 * @param {string} tag
+		 * @returns {CodeMirror.MatchingTag}
+		 */
 		findMatchingClose(tag) {
 			const /** @type {string[]} */ stack = [];
 			for (;;) {
@@ -175,7 +178,10 @@
 			}
 		}
 
-		/** @param {string} tag */
+		/**
+		 * @param {string|undefined} tag
+		 * @returns {CodeMirror.MatchingTag}
+		 */
 		findMatchingOpen(tag) {
 			const /** @type {string[]} */ stack = [];
 			for (;;) {
@@ -214,36 +220,37 @@
 		}
 	}
 
-	CodeMirror.defineExtension('findMatchingTag', /** @param {CodeMirror.Position} pos */ function(pos) {
-		let iter = new Iter(this, pos);
-		if (!iter.isTag()) {
-			return;
-		}
-		const end = iter.toTagEnd(),
-			to = end && Pos(iter.line, iter.ch);
-		const start = end && iter.toTagStart();
-		if (!start || cmpPos(iter, pos) > 0) {
-			return;
-		}
-		const tag = start[2].toLowerCase(),
-			here = {from: Pos(iter.line, iter.ch), to, tag};
-		if (end === 'selfClose' || voidTags.includes(tag)) {
-			return {open: here, close: null, at: 'self'};
-		}
+	CodeMirror.defineExtension(
+		'findMatchingTag',
+		/** @type {function(this: CodeMirror.Editor, CodeMirror.Position): CodeMirror.MatchingTagPair} */
+		function(pos) {
+			let iter = new Iter(this, pos);
+			if (!iter.isTag()) {
+				return;
+			}
+			const end = iter.toTagEnd(),
+				to = end && Pos(iter.line, iter.ch);
+			const start = end && iter.toTagStart();
+			if (!start || cmpPos(iter, pos) > 0) {
+				return;
+			}
+			const tag = start[2].toLowerCase(),
+				here = {from: Pos(iter.line, iter.ch), to, tag};
+			if (end === 'selfClose' || voidTags.includes(tag)) {
+				return {open: here, close: null, at: 'self'};
+			}
 
-		if (start[1]) { // closing tag
-			return {open: iter.findMatchingOpen(tag), close: here, at: 'close'};
-		} // opening tag
-		iter = new Iter(this, to);
-		return {open: here, close: iter.findMatchingClose(tag), at: 'open'};
-	});
+			if (start[1]) { // closing tag
+				return {open: iter.findMatchingOpen(tag), close: here, at: 'close'};
+			} // opening tag
+			iter = new Iter(this, to);
+			return {open: here, close: iter.findMatchingClose(tag), at: 'open'};
+		},
+	);
 
 	CodeMirror.defineExtension(
 		'findEnclosingTag',
-		/**
-		 * @param {CodeMirror.Position} pos
-		 * @param {string} tag
-		 */
+		/** @type {function(this: CodeMirror.Editor, CodeMirror.Position, string): CodeMirror.MatchingTagPair} */
 		function(pos, tag) {
 			const iter = new Iter(this, pos);
 			const open = iter.findMatchingOpen(tag);
@@ -258,12 +265,7 @@
 		},
 	);
 
-	/**
-	 * Used by addon/edit/closetag.js
-	 * @param {CodeMirror.Editor} cm
-	 * @param {CodeMirror.Position} pos
-	 * @param {string} name
-	 */
+	// Used by addon/edit/closetag.js
 	CodeMirror.scanForClosingTag = function(cm, pos, name) {
 		const iter = new Iter(cm, pos);
 		return iter.findMatchingClose(name);
@@ -280,7 +282,7 @@
 		}
 	});
 
-	/** @param {CodeMirror.Editor} cm */
+	/** @param {CodeMirror.EditorWithMatchingTags} cm */
 	function clear(cm) {
 		if (cm.state.tagHit) {
 			cm.state.tagHit.clear();
@@ -292,22 +294,14 @@
 		cm.state.tagOther = null;
 	}
 
-	/** @param {CodeMirror.Editor} cm */
+	/** @param {CodeMirror.EditorWithMatchingTags} cm */
 	function doMatchTags(cm) {
 		cm.operation(() => {
 			clear(cm);
 			if (cm.somethingSelected()) {
 				return;
 			}
-
-			/**
-			 * @typedef {object} matchingTag
-			 * @property {string} at
-			 * @property {CodeMirror.MarkerRange} open
-			 * @property {CodeMirror.MarkerRange} close
-			 */
-
-			const /** @type {matchingTag}} */ match = cm.findMatchingTag(cm.getCursor());
+			const match = cm.findMatchingTag(cm.getCursor());
 			if (!match) {
 				return;
 			}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wikiplus-highlight",
-  "version": "2.8.1",
+  "version": "2.13.1",
   "description": "A plugin for the MediaWiki front-end add-on \"Wikiplus\"",
   "main": "main.js",
   "scripts": {
@@ -23,6 +23,7 @@
   "homepage": "https://github.com/bhsd-harry/Wikiplus-highlight#readme",
   "devDependencies": {
     "eslint": "^8.8.0",
+    "types-mediawiki": "^1.2.0",
     "uglify-js": "^3.15.5"
   }
 }

package/search.js

@@ -6,10 +6,7 @@
 (() => {
 	'use strict';
 
-	/**
-	 * @param {string} key
-	 * @returns {string}
-	 */
+	/** @param {string} key */
 	const msg = key => mw.msg(`wphl-${key}`);
 
 	// Prepare elements
@@ -46,24 +43,21 @@
 			text: msg('addon-search'),
 		});
 
-	const /** @type {(str: string) => string} */ escapeRegExp = mw.util.escapeRegExp || mw.RegExp.escape;
-	const /** @type {{token: (stream: CodeMirror.StringStream) => string}} */ overlay = {token: () => {}};
+	const escapeRegExp = mw.util.escapeRegExp || mw.RegExp.escape;
+	const /** @type {CodeMirror.Mode<undefined>} */ overlay = {token: () => {}};
 
 	/**
 	 * 根据搜索字符串生成高亮
 	 * @param {string|RegExp} str
 	 */
 	const token = str => {
-		let /** @type {RegExp} */ initial;
-		if (typeof str === 'string') {
-			initial = RegExp(`[^${escapeRegExp(str[0])}]`, 'i');
-		}
+		const initial = typeof str === 'string' ? RegExp(`[^${escapeRegExp(str[0])}]`, 'i') : null;
 		return /** @param {CodeMirror.StringStream} stream */ stream => {
 			if (stream.match(str, true, true)) {
 				return 'search';
 			}
 			stream.next();
-			if (typeof str === 'string') {
+			if (initial) {
 				stream.eatWhile(initial);
 			}
 		};
@@ -74,17 +68,9 @@
 		$search.css('background-color', '').off('input', onInput);
 	};
 
-	/**
-	 * @typedef {object} SearchCursor
-	 * @property {() => boolean} findNext
-	 * @property {() => boolean} findPrevious
-	 * @property {() => CodeMirror.Position} from
-	 * @property {() => CodeMirror.Position} to
-	 */
-
 	// keyboard event handler of $search
 	let /** @type {string|RegExp} */ lastPtn,
-		/** @type {SearchCursor} */ cursor;
+		/** @type {CodeMirror.SearchCursor} */ cursor;
 	/**
 	 * @param {CodeMirror.Editor} cm
 	 * @param {boolean} dir
@@ -95,7 +81,7 @@
 			return;
 		}
 
-		if (/^\/.+\/i?$/.test(ptn)) {
+		if (typeof ptn === 'string' && /^\/.+\/i?$/.test(ptn)) {
 			ptn = ptn.endsWith('i')
 				? RegExp(ptn.slice(1, -2), 'i')
 				: RegExp(ptn.slice(1, -1));
@@ -107,8 +93,7 @@
 			lastPtn = ptn;
 			cursor = cm.getSearchCursor(ptn, cm.getCursor(), {caseFold: true});
 		}
-		const method = dir ? 'findNext' : 'findPrevious';
-		let result = cursor[method]();
+		let result = dir ? cursor.findNext() : cursor.findPreviouse();
 		if (!result) {
 			if (dir) {
 				cursor = cm.getSearchCursor(ptn, {line: 0, ch: 0}, {caseFold: true});
@@ -117,7 +102,7 @@
 					lastCh = cm.getLine(lastLine).length;
 				cursor = cm.getSearchCursor(ptn, {line: lastLine, ch: lastCh}, {caseFold: true});
 			}
-			result = cursor[method]();
+			result = dir ? cursor.findNext() : cursor.findPreviouse();
 		}
 		if (result) {
 			const from = cursor.from(),
@@ -147,16 +132,14 @@
 		lastPtn = '';
 	};
 
-	/** @param {CodeMirror.Editor} doc */
 	CodeMirror.commands.findForward = doc => {
 		findNext(doc, true);
 	};
-	/** @param {CodeMirror.Editor} doc */
 	CodeMirror.commands.findBackward = doc => {
 		findNext(doc, false);
 	};
 
-	const /** @type {{name: string}} */ {name} = $.client.profile(),
+	const {name} = $.client.profile(),
 		focus = name === 'safari'
 			? /** @param {CodeMirror.Editor} cm */ cm => {
 				cm.focus();
@@ -193,14 +176,10 @@
 				reset(cm);
 			}
 		});
-		cm.addKeyMap({
-			'Ctrl-F': findNew,
-			'Cmd-F': findNew,
-			'Ctrl-G': 'findForward',
-			'Cmd-G': 'findForward',
-			'Shift-Ctrl-G': 'findBackward',
-			'Shift-Cmd-G': 'findBackward',
-		});
+		cm.addKeyMap(CodeMirror.keyMap.default === CodeMirror.keyMap.pcDefault
+			? {'Ctrl-F': findNew, 'Ctrl-G': 'findForward', 'Shift-Ctrl-G': 'findBackward'}
+			: {'Cmd-F': findNew, 'Cmd-G': 'findForward', 'Shift-Cmd-G': 'findBackward'},
+		);
 	});
 
 	mw.loader.addStyleTag(