wikiplus-highlight 2.21.0 → 2.22.5

package/matchtags.js

@@ -7,16 +7,17 @@
 (() => {
 	'use strict';
 
-	const {Pos, cmpPos} = CodeMirror;
+	const {Pos, cmpPos, Init} = CodeMirror;
 
-	const tagStart = /<(\/?)([A-Z_a-z]\w*)/g,
+	const tagStart = /<(\/?)([_a-z]\w*)/giu,
 		voidTags = ['br', 'wbr', 'hr', 'img'],
 		maxScanLines = 1000;
 
+	/** @ignore */
 	class Iter {
 		/**
 		 * @param {CodeMirror.Editor} cm
-		 * @param {CodeMirror.Position} pos
+		 * @param {CodeMirror.Position} pos 当前位置
 		 */
 		constructor(cm, pos) {
 			const {line, ch} = pos;
@@ -28,21 +29,25 @@
 			this.max = Math.min(line + maxScanLines - 1, cm.lastLine());
 		}
 
+		/** 是否是标签 */
 		isTag() {
 			const type = this.cm.getTokenTypeAt(Pos(this.line, this.ch));
-			return /\b(?:mw-(?:html|ext)tag|tag\b)/.test(type);
+			return /\b(?:mw-(?:html|ext)tag|tag\b)/u.test(type);
 		}
 
-		/** @param {number} ch */
+		/**
+		 * 判断是否是括号
+		 * @param {number} ch 列号
+		 */
 		bracketAt(ch) {
 			const type = this.cm.getTokenTypeAt(Pos(this.line, ch + 1));
-			return /\b(?:mw-(?:html|ext)tag-)?bracket\b/.test(type);
+			return /\b(?:mw-(?:html|ext)tag-)?bracket\b/u.test(type);
 		}
 
 		/** Jump to the start of the next line */
 		nextLine() {
 			if (this.line >= this.max) {
-				return;
+				return false;
 			}
 			this.ch = 0;
 			this.text = this.cm.getLine(++this.line);
@@ -52,7 +57,7 @@
 		/** Jump to the end of the previous line */
 		prevLine() {
 			if (this.line <= this.min) {
-				return;
+				return false;
 			}
 			this.text = this.cm.getLine(--this.line);
 			this.ch = this.text.length;
@@ -64,7 +69,7 @@
 			for (;;) {
 				const gt = this.text.indexOf('>', this.ch);
 				if (gt === -1) {
-					return;
+					return undefined;
 				}
 				this.ch = gt + 1;
 				if (!this.bracketAt(gt)) {
@@ -79,7 +84,7 @@
 			for (;;) {
 				const lt = this.ch ? this.text.lastIndexOf('<', this.ch - 1) : -1;
 				if (lt === -1) {
-					return;
+					return undefined;
 				}
 				if (!this.bracketAt(lt)) {
 					this.ch = lt;
@@ -103,7 +108,7 @@
 					if (this.nextLine()) {
 						continue;
 					} else {
-						return;
+						return undefined;
 					}
 				}
 				if (!this.bracketAt(found.index)) {
@@ -123,7 +128,7 @@
 					if (this.prevLine()) {
 						continue;
 					} else {
-						return;
+						return undefined;
 					}
 				}
 				if (!this.bracketAt(gt)) {
@@ -131,14 +136,16 @@
 					continue;
 				}
 				const lastSlash = this.text.lastIndexOf('/', gt);
-				const selfClose = lastSlash > -1 && !/\S/.test(this.text.slice(lastSlash + 1, gt));
+				const selfClose = lastSlash > -1 && !/\S/u.test(this.text.slice(lastSlash + 1, gt));
 				this.ch = gt + 1;
 				return selfClose ? 'selfClose' : 'regular';
 			}
 		}
 
+		// eslint-disable-next-line jsdoc/require-returns-check
 		/**
-		 * @param {string} tag
+		 * 搜索匹配的闭合标签
+		 * @param {string} tag 标签名
 		 * @returns {CodeMirror.MatchingTag}
 		 */
 		findMatchingClose(tag) {
@@ -146,13 +153,13 @@
 			for (;;) {
 				const next = this.toNextTag();
 				if (!next) {
-					return;
+					return undefined;
 				}
 				const start = this.ch - next[0].length,
 					end = this.toTagEnd(),
 					tagName = next[2].toLowerCase();
 				if (!end) {
-					return;
+					return undefined;
 				}
 				if (end === 'selfClose' || voidTags.includes(tagName)) {
 					continue;
@@ -174,8 +181,10 @@
 			}
 		}
 
+		// eslint-disable-next-line jsdoc/require-returns-check
 		/**
-		 * @param {string|undefined} tag
+		 * 搜索匹配的开启标签
+		 * @param {string|undefined} tag 标签名
 		 * @returns {CodeMirror.MatchingTag}
 		 */
 		findMatchingOpen(tag) {
@@ -183,12 +192,12 @@
 			for (;;) {
 				const prev = this.toPrevTag();
 				if (!prev) {
-					return;
+					return undefined;
 				}
-				const end = this.ch,
+				const {ch: end} = this,
 					start = this.toTagStart();
 				if (!start) {
-					return;
+					return undefined;
 				}
 				const tagName = start[2].toLowerCase();
 				if (prev === 'selfClose' || voidTags.includes(tagName)) {
@@ -205,6 +214,7 @@
 						}
 					}
 					if (i < 0 && (!tag || tag === tagName)) {
+						// eslint-disable-next-line unicorn/consistent-destructuring
 						return {tag: tagName, from: Pos(this.line, this.ch), to: Pos(this.line, end)};
 					}
 				}
@@ -214,17 +224,22 @@
 
 	CodeMirror.defineExtension(
 		'findMatchingTag',
-		/** @type {function(this: CodeMirror.Editor, CodeMirror.Position): CodeMirror.MatchingTagPair} */
+
+		/**
+		 * @this {CodeMirror.Editor}
+		 * @param {CodeMirror.Position} pos 当前位置
+		 * @returns {CodeMirror.MatchingTagPair}
+		 */
 		function(pos) {
 			let iter = new Iter(this, pos);
 			if (!iter.isTag()) {
-				return;
+				return undefined;
 			}
 			const end = iter.toTagEnd(),
 				to = end && Pos(iter.line, iter.ch);
 			const start = end && iter.toTagStart();
 			if (!start || cmpPos(iter, pos) > 0) {
-				return;
+				return undefined;
 			}
 			const tag = start[2].toLowerCase(),
 				here = {from: Pos(iter.line, iter.ch), to, tag};
@@ -242,29 +257,36 @@
 
 	CodeMirror.defineExtension(
 		'findEnclosingTag',
-		/** @type {function(this: CodeMirror.Editor, CodeMirror.Position, string): CodeMirror.MatchingTagPair} */
+
+		/**
+		 * @this {CodeMirror.Editor}
+		 * @param {CodeMirror.Position} pos
+		 * @param {string} tag
+		 * @returns {CodeMirror.MatchingTagPair}
+		 */
 		function(pos, tag) {
-			const iter = new Iter(this, pos);
-			const open = iter.findMatchingOpen(tag);
+			const iter = new Iter(this, pos),
+				open = iter.findMatchingOpen(tag);
 			if (!open) {
-				return;
+				return undefined;
 			}
-			const forward = new Iter(this, pos);
-			const close = forward.findMatchingClose(open.tag);
+			const forward = new Iter(this, pos),
+				close = forward.findMatchingClose(open.tag);
 			if (close) {
 				return {open, close};
 			}
+			return undefined;
 		},
 	);
 
 	/** Used by addon/edit/closetag.js */
-	CodeMirror.scanForClosingTag = function(cm, pos, name) {
+	CodeMirror.scanForClosingTag = (cm, pos, tagName) => {
 		const iter = new Iter(cm, pos);
-		return iter.findMatchingClose(name);
+		return iter.findMatchingClose(tagName);
 	};
 
 	CodeMirror.defineOption('matchTags', false, (cm, val, old) => {
-		if (old && old !== CodeMirror.Init) {
+		if (old && old !== Init) {
 			cm.off('cursorActivity', doMatchTags);
 			clear(cm);
 		}
@@ -274,8 +296,11 @@
 		}
 	});
 
-	/** @param {CodeMirror.EditorWithMatchingTags} cm */
-	function clear(cm) {
+	/**
+	 * 清除高亮
+	 * @param {CodeMirror.EditorWithMatchingTags} cm
+	 */
+	const clear = cm => {
 		if (cm.state.tagHit) {
 			cm.state.tagHit.clear();
 		}
@@ -284,10 +309,13 @@
 		}
 		cm.state.tagHit = null;
 		cm.state.tagOther = null;
-	}
+	};
 
-	/** @param {CodeMirror.EditorWithMatchingTags} cm */
-	function doMatchTags(cm) {
+	/**
+	 * 搜索并高亮匹配的标签
+	 * @param {CodeMirror.EditorWithMatchingTags} cm
+	 */
+	const doMatchTags = cm => {
 		cm.operation(() => {
 			clear(cm);
 			if (cm.somethingSelected()) {
@@ -310,7 +338,7 @@
 				cm.state.tagOther = cm.markText(other.from, other.to, {className: 'cm-matchingtag'});
 			}
 		});
-	}
+	};
 
 	mw.loader.addStyleTag(
 		'.cm-matchingtag{background-color:#c9ffc8}'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wikiplus-highlight",
-  "version": "2.21.0",
+  "version": "2.22.5",
   "description": "A plugin for the MediaWiki front-end add-on \"Wikiplus\"",
   "keywords": [
     "mediawiki",
@@ -24,6 +24,10 @@
   },
   "devDependencies": {
     "eslint": "^8.8.0",
+    "eslint-plugin-promise": "^6.1.1",
+    "eslint-plugin-es-x": "^5.4.0",
+    "eslint-plugin-regexp": "^1.11.0",
+    "eslint-plugin-jsdoc": "^1.0.0",
     "http-server": "^14.1.0",
     "types-mediawiki": "^1.2.0",
     "uglify-js": "^3.15.5"

package/search.js

@@ -6,7 +6,10 @@
 (() => {
 	'use strict';
 
-	/** @param {string} key */
+	/**
+	 * I18N消息
+	 * @param {string} key 消息键
+	 */
 	const msg = key => mw.msg(`wphl-${key}`);
 
 	// Prepare elements
@@ -21,15 +24,20 @@
 		$searchBtn = $('<span>', {class: 'Wikiplus-Btn', html: msg('addon-search')});
 
 	const escapeRegExp = mw.util.escapeRegExp || mw.RegExp.escape;
-	const /** @type {CodeMirror.Mode<undefined>} */ overlay = {token: () => {}};
+	const /** @type {CodeMirror.Mode<undefined>} */ overlay = {token: /** @override */ () => {}};
 
 	/**
 	 * 根据搜索字符串生成高亮
-	 * @param {string|RegExp} str
+	 * @param {string|RegExp} str 搜索字符串
 	 */
 	const token = str => {
-		const initial = typeof str === 'string' ? RegExp(`[^${escapeRegExp(str[0])}]`, 'i') : null;
-		return /** @param {CodeMirror.StringStream} stream */ stream => {
+		const initial = typeof str === 'string' ? new RegExp(`[^${escapeRegExp(str[0])}]`, 'iu') : null;
+
+		/**
+		 * @override
+		 * @param {CodeMirror.StringStream} stream
+		 */
+		return stream => {
 			if (stream.match(str, true, true)) {
 				return 'search';
 			}
@@ -37,6 +45,7 @@
 			if (initial) {
 				stream.eatWhile(initial);
 			}
+			return undefined;
 		};
 	};
 
@@ -50,7 +59,7 @@
 	/**
 	 * keyboard event handler of `$search`
 	 * @param {CodeMirror.Editor} cm
-	 * @param {boolean} dir
+	 * @param {boolean} dir 搜索方向
 	 */
 	const findNext = (cm, dir) => {
 		let /** @type {string|RegExp} */ ptn = $search.val();
@@ -58,10 +67,10 @@
 			return;
 		}
 
-		if (typeof ptn === 'string' && /^\/.+\/i?$/.test(ptn)) {
+		if (typeof ptn === 'string' && /^\/.+\/i?$/u.test(ptn)) {
 			ptn = ptn.endsWith('i')
-				? RegExp(ptn.slice(1, -2), 'i')
-				: RegExp(ptn.slice(1, -1));
+				? new RegExp(ptn.slice(1, -2), 'iu')
+				: new RegExp(ptn.slice(1, -1), 'u');
 		}
 		if (ptn !== lastPtn) {
 			cm.removeOverlay(overlay);
@@ -76,7 +85,7 @@
 				cursor = cm.getSearchCursor(ptn, {line: 0, ch: 0}, {caseFold: true});
 			} else {
 				const lastLine = cm.lastLine(),
-					lastCh = cm.getLine(lastLine).length;
+					{length: lastCh} = cm.getLine(lastLine);
 				cursor = cm.getSearchCursor(ptn, {line: lastLine, ch: lastCh}, {caseFold: true});
 			}
 			result = dir ? cursor.findNext() : cursor.findPrevious();
@@ -109,10 +118,10 @@
 		lastPtn = '';
 	};
 
-	CodeMirror.commands.findForward = doc => {
+	CodeMirror.commands.findForward = /** 向后搜索 */ doc => {
 		findNext(doc, true);
 	};
-	CodeMirror.commands.findBackward = doc => {
+	CodeMirror.commands.findBackward = /** 向前搜索 */ doc => {
 		findNext(doc, false);
 	};
 
@@ -144,9 +153,10 @@
 				reset(cm);
 			}
 		});
-		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'},
+		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'},
 		);
 	});