wikiparser-node 0.5.0 → 0.6.1

package/lib/element.js

@@ -2,7 +2,6 @@
 
 const fs = require('fs'),
 	path = require('path'),
-	{externalUse} = require('../util/debug'),
 	{toCase, noWrap, print} = require('../util/string'),
 	{nth} = require('./ranges'),
 	parseSelector = require('../parser/selector'),
@@ -30,6 +29,7 @@ class AstElement extends AstNode {
 	 * @param {string|undefined} equal 属性规则运算符，`equal`存在时`val`和`i`也一定存在
 	 * @param {string|undefined} val 属性值
 	 * @param {string|undefined} i 是否对大小写不敏感
+	 * @throws `RangeError` 复杂属性
 	 */
 	#matchesAttr = (key, equal, val, i) => {
 		if (!equal) {
@@ -38,14 +38,17 @@ class AstElement extends AstNode {
 			return equal === '!=';
 		}
 		val = toCase(val, i);
+		let thisVal = this.getAttribute(key);
+		if (thisVal instanceof RegExp) {
+			thisVal = thisVal.source;
+		}
 		if (equal === '~=') {
-			let /** @type {Iterable<string>} */ thisVals = this[key];
-			if (typeof thisVals === 'string') {
-				thisVals = thisVals.split(/\s/u);
-			}
+			const thisVals = typeof thisVal === 'string' ? thisVal.split(/\s/u) : thisVal;
 			return Boolean(thisVals?.[Symbol.iterator]) && [...thisVals].some(v => toCase(v, i) === val);
+		} else if (typeof thisVal !== 'string') {
+			throw new RangeError(`复杂属性 ${key} 不能用于选择器！`);
 		}
-		const thisVal = toCase(this.getAttribute(key), i);
+		thisVal = toCase(thisVal, i);
 		switch (equal) {
 			case '|=':
 				return thisVal === val || thisVal.startsWith(`${val}-`);
@@ -62,6 +65,11 @@ class AstElement extends AstNode {
 		}
 	};
 
+	/** 子节点总数 */
+	get length() {
+		return this.childNodes.length;
+	}
+
 	/**
 	 * 全部非文本子节点
 	 * @complexity `n`
@@ -71,14 +79,6 @@ class AstElement extends AstNode {
 		return children;
 	}
 
-	/**
-	 * 非文本子节点总数
-	 * @complexity `n`
-	 */
-	get childElementCount() {
-		return this.children.length;
-	}
-
 	/**
 	 * 首位非文本子节点
 	 * @returns {this}
@@ -89,10 +89,18 @@ class AstElement extends AstNode {
 
 	/**
 	 * 末位非文本子节点
-	 * @returns {this}
+	 * @complexity `n`
 	 */
 	get lastElementChild() {
-		return this.childNodes.findLast(({type}) => type !== 'text');
+		return this.children.at(-1);
+	}
+
+	/**
+	 * 非文本子节点总数
+	 * @complexity `n`
+	 */
+	get childElementCount() {
+		return this.children.length;
 	}
 
 	/** 父节点 */
@@ -183,71 +191,6 @@ class AstElement extends AstNode {
 		return key === 'matchesAttr' ? this.#matchesAttr : super.getAttribute(key);
 	}
 
-	/**
-	 * @override
-	 * @template {string} T
-	 * @param {T} key 属性键
-	 * @param {TokenAttribute<T>} value 属性值
-	 * @throws `RangeError` 禁止手动指定的属性
-	 */
-	setAttribute(key, value) {
-		if (key === 'name' && externalUse('setAttribute')) {
-			throw new RangeError(`禁止手动指定 ${key} 属性！`);
-		}
-		return super.setAttribute(key, value);
-	}
-
-	/**
-	 * 在末尾批量插入子节点
-	 * @param {...this} elements 插入节点
-	 * @complexity `n`
-	 */
-	append(...elements) {
-		for (const element of elements) {
-			this.appendChild(element);
-		}
-	}
-
-	/**
-	 * 在开头批量插入子节点
-	 * @param {...this} elements 插入节点
-	 * @complexity `n`
-	 */
-	prepend(...elements) {
-		for (let i = 0; i < elements.length; i++) {
-			this.insertAt(elements[i], i);
-		}
-	}
-
-	/**
-	 * 批量替换子节点
-	 * @param {...this} elements 新的子节点
-	 * @complexity `n`
-	 */
-	replaceChildren(...elements) {
-		for (let i = this.childNodes.length - 1; i >= 0; i--) {
-			this.removeAt(i);
-		}
-		this.append(...elements);
-	}
-
-	/**
-	 * 修改文本子节点
-	 * @param {string} str 新文本
-	 * @param {number} i 子节点位置
-	 * @throws `RangeError` 对应位置的子节点不是文本节点
-	 */
-	setText(str, i = 0) {
-		this.getAttribute('verifyChild')(i);
-		const /** @type {AstText} */ oldText = this.childNodes.at(i),
-			{type, data, constructor: {name}} = oldText;
-		if (type === 'text') {
-			oldText.replaceData(str);
-			return data;
-		}
-		throw new RangeError(`第 ${i} 个子节点是 ${name}！`);
-	}
-
 	/** 是否受保护。保护条件来自Token，这里仅提前用于:required和:optional伪选择器。 */
 	#isProtected() {
 		const /** @type {{parentNode: AstElement & {constructor: {fixed: boolean}}}} */ {parentNode} = this;
@@ -366,17 +309,17 @@ class AstElement extends AstNode {
 	 * @returns {boolean}
 	 * @complexity `n`
 	 */
-	matches(selector = '') {
-		if (typeof selector === 'string') {
-			return Parser.run(() => {
-				const stack = parseSelector(selector),
-					/** @type {Set<string>} */
-					pseudos = new Set(stack.flat(2).filter(step => typeof step === 'string' && step[0] === ':'));
-				if (pseudos.size > 0) {
-					Parser.warn('检测到伪选择器，请确认是否需要将":"转义成"\\:"。', pseudos);
-				}
-				return stack.some(condition => this.matches(condition));
-			});
+	matches(selector) {
+		if (selector === undefined) {
+			return true;
+		} else if (typeof selector === 'string') {
+			const stack = parseSelector(selector),
+				/** @type {Set<string>} */
+				pseudos = new Set(stack.flat(2).filter(step => typeof step === 'string' && step[0] === ':'));
+			if (pseudos.size > 0) {
+				Parser.warn('检测到伪选择器，请确认是否需要将":"转义成"\\:"。', pseudos);
+			}
+			return Parser.run(() => stack.some(condition => this.matches(condition)));
 		} else if (!Parser.running) {
 			this.typeError('matches', 'String');
 		}
@@ -406,59 +349,11 @@ class AstElement extends AstNode {
 		return false;
 	}
 
-	/**
-	 * 还原为wikitext
-	 * @param {string} selector
-	 * @param {string} separator 子节点间的连接符
-	 */
-	toString(selector, separator = '') {
-		return selector && this.matches(selector)
-			? ''
-			: this.childNodes.map(child => child.toString(selector)).join(separator);
-	}
-
-	/** 获取所有祖先节点 */
-	getAncestors() {
-		const /** @type {this[]} */ ancestors = [];
-		let {parentNode} = this;
-		while (parentNode) {
-			ancestors.push(parentNode);
-			({parentNode} = parentNode);
-		}
-		return ancestors;
-	}
-
-	/**
-	 * 比较和另一个节点的相对位置
-	 * @param {this} other 待比较的节点
-	 * @complexity `n`
-	 * @throws `Error` 不在同一个语法树
-	 */
-	compareDocumentPosition(other) {
-		if (!(other instanceof AstElement)) {
-			this.typeError('compareDocumentPosition', 'AstElement');
-		} else if (this === other) {
-			return 0;
-		} else if (this.contains(other)) {
-			return -1;
-		} else if (other.contains(this)) {
-			return 1;
-		} else if (this.getRootNode() !== other.getRootNode()) {
-			throw new Error('不在同一个语法树！');
-		}
-		const aAncestors = [...this.getAncestors().reverse(), this],
-			bAncestors = [...other.getAncestors().reverse(), other],
-			depth = aAncestors.findIndex((ancestor, i) => bAncestors[i] !== ancestor),
-			commonAncestor = aAncestors[depth - 1],
-			{childNodes} = commonAncestor;
-		return childNodes.indexOf(aAncestors[depth]) - childNodes.indexOf(bAncestors[depth]);
-	}
-
 	/**
 	 * 最近的祖先节点
 	 * @param {string} selector
 	 */
-	closest(selector = '') {
+	closest(selector) {
 		let {parentNode} = this;
 		while (parentNode) {
 			if (parentNode.matches(selector)) {
@@ -475,7 +370,7 @@ class AstElement extends AstNode {
 	 * @returns {this|undefined}
 	 * @complexity `n`
 	 */
-	querySelector(selector = '') {
+	querySelector(selector) {
 		for (const child of this.children) {
 			if (child.matches(selector)) {
 				return child;
@@ -493,7 +388,7 @@ class AstElement extends AstNode {
 	 * @param {string} selector
 	 * @complexity `n`
 	 */
-	querySelectorAll(selector = '') {
+	querySelectorAll(selector) {
 		const /** @type {this[]} */ descendants = [];
 		for (const child of this.children) {
 			if (child.matches(selector)) {
@@ -534,16 +429,94 @@ class AstElement extends AstNode {
 		return String(this).split('\n', n + 1).at(-1);
 	}
 
-	static lintIgnoredHidden = new Set(['noinclude', 'double-underscore', 'hidden']);
-	static lintIgnoredSyntax = new Set(['magic-word-name', 'heading-trail', 'table-syntax']);
-	static lintIgnoredExt = new Set(['nowiki', 'pre', 'syntaxhighlight', 'source', 'math', 'timeline']);
+	/**
+	 * 在开头批量插入子节点
+	 * @param {...this} elements 插入节点
+	 * @complexity `n`
+	 */
+	prepend(...elements) {
+		for (let i = 0; i < elements.length; i++) {
+			this.insertAt(elements[i], i);
+		}
+	}
+
+	/**
+	 * 在末尾批量插入子节点
+	 * @param {...this} elements 插入节点
+	 * @complexity `n`
+	 */
+	append(...elements) {
+		for (const element of elements) {
+			this.insertAt(element);
+		}
+	}
+
+	/**
+	 * 批量替换子节点
+	 * @param {...this} elements 新的子节点
+	 * @complexity `n`
+	 */
+	replaceChildren(...elements) {
+		for (let i = this.childNodes.length - 1; i >= 0; i--) {
+			this.removeAt(i);
+		}
+		this.append(...elements);
+	}
+
+	/**
+	 * 修改文本子节点
+	 * @param {string} str 新文本
+	 * @param {number} i 子节点位置
+	 * @throws `RangeError` 对应位置的子节点不是文本节点
+	 */
+	setText(str, i = 0) {
+		this.getAttribute('verifyChild')(i);
+		const /** @type {AstText} */ oldText = this.childNodes.at(i),
+			{type, data, constructor: {name}} = oldText;
+		if (type === 'text') {
+			oldText.replaceData(str);
+			return data;
+		}
+		throw new RangeError(`第 ${i} 个子节点是 ${name}！`);
+	}
+
+	/**
+	 * 还原为wikitext
+	 * @param {string} selector
+	 * @param {string} separator 子节点间的连接符
+	 * @returns {string}
+	 */
+	toString(selector, separator = '') {
+		return selector && this.matches(selector)
+			? ''
+			: this.childNodes.map(child => child.toString(selector)).join(separator);
+	}
+
+	static lintIgnoredExt = new Set([
+		'nowiki',
+		'pre',
+		'charinsert',
+		'score',
+		'syntaxhighlight',
+		'source',
+		'math',
+		'chem',
+		'ce',
+		'graph',
+		'mapframe',
+		'maplink',
+		'quiz',
+		'templatedata',
+		'timeline',
+	]);
 
 	/**
 	 * Linter
 	 * @param {number} start 起始位置
 	 */
 	lint(start = 0) {
-		if (AstElement.lintIgnoredHidden.has(this.type) || AstElement.lintIgnoredSyntax.has(this.type)
+		const SyntaxToken = require('../src/syntax');
+		if (this instanceof SyntaxToken || this.constructor.hidden
 			|| this.type === 'ext-inner' && AstElement.lintIgnoredExt.has(this.name)
 		) {
 			return [];
@@ -563,15 +536,15 @@ class AstElement extends AstNode {
 	 * @returns {string}
 	 */
 	print(opt = {}) {
-		return this.childNodes.length === 0
-			? ''
-			: `<span class="wpb-${opt.class ?? this.type}">${print(this.childNodes, opt)}</span>`;
+		return String(this)
+			? `<span class="wpb-${opt.class ?? this.type}">${print(this.childNodes, opt)}</span>`
+			: '';
 	}
 
 	/**
 	 * 保存为JSON
 	 * @param {string} file 文件名
-	 * @returns {Record<string, any>}
+	 * @returns {Record<string, *>}
 	 */
 	json(file) {
 		const {childNodes, ...prop} = this,
@@ -594,7 +567,7 @@ class AstElement extends AstNode {
 	 * @returns {void}
 	 */
 	echo(depth = 0) {
-		if (typeof depth !== 'number') {
+		if (!Number.isInteger(depth) || depth < 0) {
 			this.typeError('print', 'Number');
 		}
 		const indent = '  '.repeat(depth),