wikiparser-node 0.4.0 → 0.6.1

package/src/table/td.js

@@ -1,7 +1,8 @@
 'use strict';
 
 const fixedToken = require('../../mixin/fixedToken'),
-	{externalUse, typeError} = require('../../util/debug'),
+	{typeError} = require('../../util/debug'),
+	{isPlainObject} = require('../../util/base'),
 	Parser = require('../..'),
 	Token = require('..'),
 	TrToken = require('./tr');
@@ -49,12 +50,12 @@ class TdToken extends fixedToken(TrToken) {
 
 	/** 内部wikitext */
 	get innerText() {
-		return this.lastElementChild.text();
+		return this.lastChild.text();
 	}
 
 	/** 是否位于行首 */
 	isIndependent() {
-		return this.firstElementChild.text()[0] === '\n';
+		return this.firstChild.text()[0] === '\n';
 	}
 
 	/**
@@ -63,7 +64,7 @@ class TdToken extends fixedToken(TrToken) {
 	 * @complexity `n`
 	 */
 	getSyntax() {
-		const syntax = this.firstElementChild.text(),
+		const syntax = this.firstChild.text(),
 			esc = syntax.includes('{{'),
 			char = syntax.at(-1);
 		let subtype = 'td';
@@ -75,14 +76,14 @@ class TdToken extends fixedToken(TrToken) {
 		if (this.isIndependent()) {
 			return {subtype, escape: esc, correction: false};
 		}
-		const {previousElementSibling} = this;
-		if (previousElementSibling?.type !== 'td') {
+		const {previousSibling} = this;
+		if (previousSibling?.type !== 'td') {
 			return {subtype, escape: esc, correction: true};
 		}
-		const result = previousElementSibling.getSyntax();
+		const result = previousSibling.getSyntax();
 		result.escape ||= esc;
-		result.correction = previousElementSibling.lastElementChild
-			.toString('comment, ext, include, noinclude, arg, template, magic-word, html')
+		result.correction = previousSibling.lastChild
+			.toString('comment, ext, include, noinclude, arg, template, magic-word')
 			.includes('\n');
 		if (subtype === 'th' && result.subtype !== 'th') {
 			result.subtype = 'th';
@@ -91,10 +92,6 @@ class TdToken extends fixedToken(TrToken) {
 		return result;
 	}
 
-	getRowCount = undefined;
-	getNthCol = undefined;
-	insertTableCell = undefined;
-
 	/**
 	 * @param {string} syntax 单元格语法
 	 * @param {string} inner 内部wikitext
@@ -114,9 +111,50 @@ class TdToken extends fixedToken(TrToken) {
 		// eslint-disable-next-line no-unsafe-optional-chaining
 		const innerToken = new Token(inner?.slice(innerSyntax?.index + this.#innerSyntax.length), config, true, accum);
 		innerToken.type = 'td-inner';
+		this.insertAt(innerToken.setAttribute('stage', 4));
 		this.setAttribute('acceptable', {SyntaxToken: 0, AttributeToken: 1, Token: 2})
-			.seal(['getRowCount', 'getNthCol', 'insertTableCell'], true)
-			.appendChild(innerToken.setAttribute('stage', 4));
+			.seal(['getRowCount', 'getNthCol', 'insertTableCell'], true);
+	}
+
+	/** @override */
+	afterBuild() {
+		if (this.#innerSyntax.includes('\0')) {
+			this.#innerSyntax = this.getAttribute('buildFromStr')(this.#innerSyntax).map(String).join('');
+		}
+		return this;
+	}
+
+	/**
+	 * @override
+	 * @param {string} selector
+	 * @returns {string}
+	 * @complexity `n`
+	 */
+	toString(selector) {
+		this.#correct();
+		const {childNodes: [syntax, attr, inner]} = this;
+		return selector && this.matches(selector)
+			? ''
+			: `${syntax.toString(selector)}${attr.toString(selector)}${this.#innerSyntax}${inner.toString(selector)}`;
+	}
+
+	/**
+	 * @override
+	 * @param {number} i 子节点位置
+	 */
+	getGaps(i = 0) {
+		i = i < 0 ? i + this.childNodes.length : i;
+		if (i === 1) {
+			this.#correct();
+			return this.#innerSyntax.length;
+		}
+		return 0;
+	}
+
+	/** @override */
+	print() {
+		const {childNodes: [syntax, attr, inner]} = this;
+		return `<span class="wpb-td">${syntax.print()}${attr.print()}${this.#innerSyntax}${inner.print()}</span>`;
 	}
 
 	/** @override */
@@ -135,7 +173,7 @@ class TdToken extends fixedToken(TrToken) {
 	 * @throws `RangeError` 非法的单元格类型
 	 */
 	static create(inner, subtype = 'td', attr = {}, include = false, config = Parser.getConfig()) {
-		if (typeof inner !== 'string' && (!(inner instanceof Token) || !inner.isPlain()) || typeof attr !== 'object') {
+		if (typeof inner !== 'string' && inner?.constructor !== Token || !isPlainObject(attr)) {
 			typeError(this, 'create', 'String', 'Token', 'Object');
 		} else if (subtype !== 'td' && subtype !== 'th' && subtype !== 'caption') {
 			throw new RangeError('单元格的子类型只能为 "td"、"th" 或 "caption"！');
@@ -144,7 +182,7 @@ class TdToken extends fixedToken(TrToken) {
 		}
 		const token = Parser.run(() => new TdToken('\n|', undefined, config));
 		token.setSyntax(subtype);
-		token.lastElementChild.safeReplaceWith(inner);
+		token.lastChild.safeReplaceWith(inner);
 		for (const [k, v] of Object.entries(attr)) {
 			token.setAttr(k, v);
 		}
@@ -167,24 +205,13 @@ class TdToken extends fixedToken(TrToken) {
 	 * @param {T} key 属性键
 	 * @param {TokenAttribute<T>} value 属性值
 	 * @returns {this}
-	 * @throws `RangeError` 仅用于代码调试
 	 */
 	setAttribute(key, value) {
-		if (key !== 'innerSyntax') {
-			return super.setAttribute(key, value);
-		} else if (!Parser.debugging && externalUse('setAttribute')) {
-			throw new RangeError(`使用 ${this.constructor.name}.setAttribute 方法设置私有属性 #${key} 仅用于代码调试！`);
+		if (key === 'innerSyntax') {
+			this.#innerSyntax = String(value);
+			return this;
 		}
-		this.#innerSyntax = String(value);
-		return this;
-	}
-
-	/** @override */
-	afterBuild() {
-		if (this.#innerSyntax.includes('\0')) {
-			this.#innerSyntax = this.getAttribute('buildFromStr')(this.#innerSyntax).map(String).join('');
-		}
-		return this;
+		return super.setAttribute(key, value);
 	}
 
 	/**
@@ -201,7 +228,7 @@ class TdToken extends fixedToken(TrToken) {
 	 * @complexity `n`
 	 */
 	#correct() {
-		if (String(this.children[1])) {
+		if (String(this.childNodes[1])) {
 			this.#innerSyntax ||= '|';
 		}
 		const {subtype, escape, correction} = this.getSyntax();
@@ -221,33 +248,6 @@ class TdToken extends fixedToken(TrToken) {
 		}
 	}
 
-	/**
-	 * @override
-	 * @param {string} selector
-	 * @returns {string}
-	 * @complexity `n`
-	 */
-	toString(selector) {
-		this.#correct();
-		const {children: [syntax, attr, inner]} = this;
-		return selector && this.matches(selector)
-			? ''
-			: `${syntax.toString(selector)}${attr.toString(selector)}${this.#innerSyntax}${inner.toString(selector)}`;
-	}
-
-	/**
-	 * @override
-	 * @param {number} i 子节点位置
-	 */
-	getGaps(i = 0) {
-		i = i < 0 ? i + this.childNodes.length : i;
-		if (i !== 1) {
-			return 0;
-		}
-		this.#correct();
-		return this.#innerSyntax.length;
-	}
-
 	/**
 	 * @override
 	 * @returns {string}
@@ -255,7 +255,7 @@ class TdToken extends fixedToken(TrToken) {
 	 */
 	text() {
 		this.#correct();
-		const {children: [syntax, attr, inner]} = this;
+		const {childNodes: [syntax, attr, inner]} = this;
 		return `${syntax.text()}${attr.text()}${this.#innerSyntax}${inner.text()}`;
 	}
 
@@ -286,7 +286,7 @@ class TdToken extends fixedToken(TrToken) {
 			value = value === 1 ? false : String(value);
 		}
 		const /** @type {boolean} */ result = super.setAttr(key, value);
-		if (!String(this.children[1])) {
+		if (!String(this.childNodes[1])) {
 			this.#innerSyntax = '';
 		}
 		return result;
@@ -295,7 +295,7 @@ class TdToken extends fixedToken(TrToken) {
 	/** @override */
 	escape() {
 		super.escape();
-		if (String(this.children[1])) {
+		if (String(this.childNodes[1])) {
 			this.#innerSyntax ||= '{{!}}';
 		}
 		if (this.#innerSyntax === '|') {

package/src/table/tr.js

@@ -1,11 +1,11 @@
 'use strict';
 
-const attributeParent = require('../../mixin/attributeParent'),
+const {generateForChild} = require('../../util/lint'),
+	attributeParent = require('../../mixin/attributeParent'),
 	Parser = require('../..'),
 	AstText = require('../../lib/text'),
 	Token = require('..'),
-	SyntaxToken = require('../syntax'),
-	AttributeToken = require('../attribute');
+	SyntaxToken = require('../syntax');
 
 const openingPattern = /^\n[^\S\n]*(?:\|-+|\{\{\s*!\s*\}\}-+|\{\{\s*!-\s*\}\}-*)$/u;
 
@@ -14,11 +14,10 @@ const openingPattern = /^\n[^\S\n]*(?:\|-+|\{\{\s*!\s*\}\}-+|\{\{\s*!-\s*\}\}-*)
  * @param {SyntaxToken} syntax 表格语法节点
  */
 const escapeTable = syntax => {
-	const wikitext = syntax.childNodes.map(
+	const templates = {'{|': '(!', '|}': '!)', '||': '!!', '|': '!'},
+		wikitext = syntax.childNodes.map(
 			child => child.type === 'text'
-				? String(child).replaceAll('{|', '{{(!}}').replaceAll('|}', '{{!)}}')
-					.replaceAll('||', '{{!!}}')
-					.replaceAll('|', '{{!}}')
+				? String(child).replaceAll(/\{\||\|\}|\|{2}|\|/gu, p => `{{${templates[p]}}}`)
 				: String(child),
 		).join(''),
 		token = Parser.parse(wikitext, syntax.getAttribute('include'), 2, syntax.getAttribute('config'));
@@ -40,6 +39,7 @@ class TrToken extends attributeParent(Token, 1) {
 	 */
 	constructor(syntax, attr = '', config = Parser.getConfig(), accum = [], pattern = openingPattern) {
 		super(undefined, config, true, accum, {Token: 2, SyntaxToken: 0, AttributeToken: 1, TdToken: '2:'});
+		const AttributeToken = require('../attribute');
 		this.append(
 			new SyntaxToken(syntax, pattern, 'table-syntax', config, accum, {
 				'Stage-1': ':', '!ExtToken': '', TranscludeToken: ':',
@@ -49,6 +49,23 @@ class TrToken extends attributeParent(Token, 1) {
 		this.getAttribute('protectChildren')(0, 1);
 	}
 
+	/**
+	 * @override
+	 * @param {number} start 起始位置
+	 */
+	lint(start = 0) {
+		const errors = super.lint(start),
+			inter = this.childNodes.find(({type}) => type === 'table-inter'),
+			str = String(inter).trim();
+		if (inter && str && !/^<!--.*-->$/su.test(str)) {
+			const error = generateForChild(inter, this.getRootNode().posFromIndex(start), '将被移出表格的内容');
+			error.startLine++;
+			error.startCol = 0;
+			errors.push(error);
+		}
+		return errors;
+	}
+
 	/**
 	 * @override
 	 * @this {TrToken & {constructor: typeof TrToken}}
@@ -57,12 +74,12 @@ class TrToken extends attributeParent(Token, 1) {
 		const [syntax, attr, inner, ...cloned] = this.cloneChildNodes();
 		return Parser.run(() => {
 			const token = new this.constructor(undefined, undefined, this.getAttribute('config'));
-			token.firstElementChild.safeReplaceWith(syntax);
-			token.children[1].safeReplaceWith(attr);
+			token.firstChild.safeReplaceWith(syntax);
+			token.childNodes[1].safeReplaceWith(attr);
 			if (token.type === 'td') { // TdToken
-				token.children[2].safeReplaceWith(inner);
+				token.childNodes[2].safeReplaceWith(inner);
 			} else if (inner !== undefined) {
-				token.appendChild(inner);
+				token.insertAt(inner);
 			}
 			token.append(...cloned);
 			return token;
@@ -71,13 +88,13 @@ class TrToken extends attributeParent(Token, 1) {
 
 	/** 修复简单的表格语法错误 */
 	#correct() {
-		const {children: [,, child]} = this;
-		if (child?.isPlain()) {
-			const /** @type {{firstChild: AstText}} */ {firstChild: {type, data}} = child;
-			if (type !== 'text') {
+		const {childNodes: [,, child]} = this;
+		if (child?.constructor === Token) {
+			const /** @type {{firstChild: AstText}} */ {firstChild} = child;
+			if (firstChild.type !== 'text') {
 				child.prepend('\n');
-			} else if (data[0] !== '\n') {
-				child.setText(`\n${data}`);
+			} else if (firstChild.data[0] !== '\n') {
+				firstChild.insertData(0, '\n');
 			}
 		}
 	}
@@ -103,7 +120,7 @@ class TrToken extends attributeParent(Token, 1) {
 	 * @complexity `n`
 	 */
 	escape() {
-		for (const child of this.children) {
+		for (const child of this.childNodes) {
 			if (child instanceof SyntaxToken) {
 				escapeTable(child);
 			} else if (child instanceof TrToken) {
@@ -118,10 +135,10 @@ class TrToken extends attributeParent(Token, 1) {
 	 * @param {boolean} esc 是否需要转义
 	 */
 	setSyntax(syntax, esc) {
-		const {firstElementChild} = this;
-		firstElementChild.replaceChildren(syntax);
+		const {firstChild} = this;
+		firstChild.replaceChildren(syntax);
 		if (esc) {
-			escapeTable(firstElementChild);
+			escapeTable(firstChild);
 		}
 	}
 
@@ -134,9 +151,9 @@ class TrToken extends attributeParent(Token, 1) {
 		const TdToken = require('./td');
 		const child = this.childNodes.at(i);
 		if (child instanceof TdToken && child.isIndependent()) {
-			const {nextElementSibling} = child;
-			if (nextElementSibling?.type === 'td') {
-				nextElementSibling.independence();
+			const {nextSibling} = child;
+			if (nextSibling?.type === 'td') {
+				nextSibling.independence();
 			}
 		}
 		return super.removeAt(i);
@@ -169,14 +186,14 @@ class TrToken extends attributeParent(Token, 1) {
 	 */
 	getRowCount() {
 		const TdToken = require('./td');
-		return Number(this.children.some(
-			child => child instanceof TdToken && child.isIndependent() && child.firstElementChild.text().at(-1) !== '+',
+		return Number(this.childNodes.some(
+			child => child instanceof TdToken && child.isIndependent() && child.firstChild.text().at(-1) !== '+',
 		));
 	}
 
 	/**
 	 * 获取相邻行
-	 * @param {(children: Token[], index: number) => Token[]} subset 筛选兄弟节点的方法
+	 * @param {(childNodes: Token[], index: number) => Token[]} subset 筛选兄弟节点的方法
 	 * @complexity `n`
 	 */
 	#getSiblingRow(subset) {
@@ -184,9 +201,9 @@ class TrToken extends attributeParent(Token, 1) {
 		if (!parentNode) {
 			return undefined;
 		}
-		const {children} = parentNode,
-			index = children.indexOf(this);
-		for (const child of subset(children, index)) {
+		const {childNodes} = parentNode,
+			index = childNodes.indexOf(this);
+		for (const child of subset(childNodes, index)) {
 			if (child instanceof TrToken && child.getRowCount()) {
 				return child;
 			}
@@ -199,7 +216,7 @@ class TrToken extends attributeParent(Token, 1) {
 	 * @complexity `n`
 	 */
 	getNextRow() {
-		return this.#getSiblingRow((children, index) => children.slice(index + 1));
+		return this.#getSiblingRow((childNodes, index) => childNodes.slice(index + 1));
 	}
 
 	/**
@@ -207,7 +224,7 @@ class TrToken extends attributeParent(Token, 1) {
 	 * @complexity `n`
 	 */
 	getPreviousRow() {
-		return this.#getSiblingRow((children, index) => children.slice(0, index).reverse());
+		return this.#getSiblingRow((childNodes, index) => childNodes.slice(0, index).reverse());
 	}
 
 	/**
@@ -218,7 +235,7 @@ class TrToken extends attributeParent(Token, 1) {
 		const TdToken = require('./td');
 		let count = 0,
 			last = 0;
-		for (const child of this.children) {
+		for (const child of this.childNodes) {
 			if (child instanceof TdToken) {
 				last = child.isIndependent() ? Number(child.subtype !== 'caption') : last;
 				count += last;
@@ -236,7 +253,7 @@ class TrToken extends attributeParent(Token, 1) {
 	 * @throws `RangeError` 不存在对应单元格
 	 */
 	getNthCol(n, insert) {
-		if (typeof n !== 'number') {
+		if (!Number.isInteger(n)) {
 			this.typeError('getNthCol', 'Number');
 		}
 		const nCols = this.getColCount();
@@ -246,7 +263,7 @@ class TrToken extends attributeParent(Token, 1) {
 		}
 		const TdToken = require('./td');
 		let last = 0;
-		for (const child of this.children.slice(2)) {
+		for (const child of this.childNodes.slice(2)) {
 			if (child instanceof TdToken) {
 				if (child.isIndependent()) {
 					last = Number(child.subtype !== 'caption');

package/src/tagPair/ext.js

@@ -1,6 +1,7 @@
 'use strict';
 
-const attributeParent = require('../../mixin/attributeParent'),
+const path = require('path'),
+	attributeParent = require('../../mixin/attributeParent'),
 	Parser = require('../..'),
 	TagPairToken = require('.');
 
@@ -10,11 +11,7 @@ const attributeParent = require('../../mixin/attributeParent'),
  */
 class ExtToken extends attributeParent(TagPairToken) {
 	type = 'ext';
-
-	/** @override */
-	get closed() {
-		return super.closed;
-	}
+	closed = true;
 
 	/**
 	 * @param {string} name 标签名
@@ -25,51 +22,74 @@ class ExtToken extends attributeParent(TagPairToken) {
 	 */
 	constructor(name, attr = '', inner = '', closed = undefined, config = Parser.getConfig(), accum = []) {
 		attr = !attr || attr.trimStart() !== attr ? attr : ` ${attr}`;
-		const AttributeToken = require('../attribute');
+		const Token = require('..'),
+			AttributeToken = require('../attribute');
 		const lcName = name.toLowerCase(),
 			attrToken = new AttributeToken(attr, 'ext-attr', lcName, config, accum),
 			newConfig = structuredClone(config),
 			ext = new Set(newConfig.ext);
-		let /** @type {acceptable} */ acceptable, /** @type {Token} */ innerToken;
+		let /** @type {Token} */ innerToken;
+		ext.delete(lcName);
+		newConfig.ext = [...ext];
 		switch (lcName) {
-			case 'choose':
-			case 'option':
-			case 'ref':
-			case 'poem':
-			case 'indicator':
 			case 'tab':
+				ext.delete('tabs');
+				newConfig.ext = [...ext];
+				// fall through
+			case 'indicator':
+			case 'poem':
+			case 'ref':
+			case 'option':
+			case 'combooption':
 			case 'tabs':
-			case 'pre':
-			case 'combobox':
-			case 'combooption': {
-				ext.delete(lcName);
-				newConfig.ext = [
-					...ext,
-					...lcName === 'choose' ? ['option'] : [],
-					...lcName === 'combobox' ? ['combooption'] : [],
-				];
-				const Token = require('..');
-				acceptable = {AttributeToken: 0, Token: 1};
+			case 'poll':
+			case 'seo':
 				innerToken = new Token(inner, newConfig, true, accum);
 				break;
-			}
 			case 'gallery': {
-				ext.delete(lcName);
-				newConfig.ext = [...ext];
 				const GalleryToken = require('../gallery');
-				acceptable = {AttributeToken: 0, GalleryToken: 1};
 				innerToken = new GalleryToken(inner, newConfig, accum);
 				break;
 			}
+			case 'pre': {
+				const PreToken = require('../hasNowiki/pre');
+				innerToken = new PreToken(inner, newConfig, accum);
+				break;
+			}
+			case 'charinsert': {
+				const CharinsertToken = require('../charinsert');
+				innerToken = new CharinsertToken(inner, newConfig, accum);
+				break;
+			}
+			case 'references':
+			case 'choose':
+			case 'combobox': {
+				const NestedToken = require('../nested'),
+					/** @type {typeof NestedToken} */ NestedExtToken = require(path.join('..', 'nested', lcName));
+				innerToken = new NestedExtToken(inner, newConfig, accum);
+				break;
+			}
+			case 'imagemap': {
+				const ImagemapToken = require('../imagemap');
+				innerToken = new ImagemapToken(inner, config, accum);
+				break;
+			}
+			case 'dynamicpagelist': {
+				const ParamTagToken = require('../paramTag');
+				innerToken = new ParamTagToken(inner, newConfig, accum);
+				break;
+			}
+			case 'inputbox': {
+				const InputboxToken = require('../paramTag/inputbox');
+				innerToken = new InputboxToken(inner, newConfig, accum);
+				break;
+			}
 
 			/*
 			 * 更多定制扩展的代码示例：
 			 * ```
 			 * case 'extensionName': {
-			 * 	ext.delete(lcName);
-			 * 	newConfig.ext = [...ext];
 			 * 	const ExtensionToken = require('../extension');
-			 * 	acceptable = {AttributeToken: 0, ExtensionToken: 1};
 			 * 	innerToken = new ExtensionToken(inner, newConfig, accum);
 			 * 	break;
 			 * }
@@ -77,27 +97,24 @@ class ExtToken extends attributeParent(TagPairToken) {
 			 */
 			default: {
 				const NowikiToken = require('../nowiki');
-				acceptable = {AttributeToken: 0, NowikiToken: 1};
 				innerToken = new NowikiToken(inner, config);
 			}
 		}
-		innerToken.type = 'ext-inner';
-		innerToken.setAttribute('name', lcName);
-		if (lcName === 'pre') {
-			innerToken.setAttribute('stage', Parser.MAX_STAGE - 1);
-		}
-		super(name, attrToken, innerToken, closed, config, accum, acceptable);
+		innerToken.setAttribute('name', lcName).type = 'ext-inner';
+		super(name, attrToken, innerToken, closed, config, accum);
 	}
 
 	/** @override */
 	cloneNode() {
-		const inner = this.lastElementChild.cloneNode(),
+		const inner = this.lastChild.cloneNode(),
 			tags = this.getAttribute('tags'),
 			config = this.getAttribute('config'),
-			attr = String(this.firstElementChild),
-			token = Parser.run(() => new ExtToken(tags[0], attr, '', this.selfClosing ? undefined : tags[1], config));
-		token.lastElementChild.safeReplaceWith(inner);
-		return token;
+			attr = String(this.firstChild);
+		return Parser.run(() => {
+			const token = new ExtToken(tags[0], attr, '', this.selfClosing ? undefined : tags[1], config);
+			token.lastChild.safeReplaceWith(inner);
+			return token;
+		});
 	}
 }
 

package/src/tagPair/include.js

@@ -1,6 +1,7 @@
 'use strict';
 
 const hidden = require('../../mixin/hidden'),
+	{generateForSelf} = require('../../util/lint'),
 	Parser = require('../..'),
 	TagPairToken = require('.');
 
@@ -19,7 +20,16 @@ class IncludeToken extends hidden(TagPairToken) {
 	 * @param {accum} accum
 	 */
 	constructor(name, attr = '', inner = undefined, closed = undefined, config = Parser.getConfig(), accum = []) {
-		super(name, attr, inner ?? '', inner === undefined ? closed : closed ?? '', config, accum, {AstText: [0, 1]});
+		super(name, attr, inner ?? '', inner === undefined ? closed : closed ?? '', config, accum);
+	}
+
+	/**
+	 * @override
+	 * @param {number} start 起始位置
+	 * @returns {LintError[]}
+	 */
+	lint(start = 0) {
+		return this.closed ? [] : [generateForSelf(this, this.getRootNode().posFromIndex(start), '未闭合的标签')];
 	}
 
 	/** @override */