wikiparser-node 0.3.1 → 0.4.0

package/src/gallery.js

@@ -1,28 +1,28 @@
 'use strict';
 
-const {text} = require('../util/string'),
-	/** @type {Parser} */ Parser = require('..'),
+const Parser = require('..'),
 	Token = require('.'),
-	GalleryImageToken = require('./link/galleryImage');
+	GalleryImageToken = require('./link/galleryImage'),
+	HiddenToken = require('./atom/hidden');
 
 /**
  * gallery标签
- * @classdesc `{childNodes: (string|FileToken)[]]}`
+ * @classdesc `{childNodes: ...(GalleryImageToken|HiddenToken|AstText)}`
  */
 class GalleryToken extends Token {
 	type = 'ext-inner';
 	name = 'gallery';
 
 	/**
-	 * @param {string} inner
+	 * @param {string} inner 标签内部wikitext
 	 * @param {accum} accum
 	 */
 	constructor(inner, config = Parser.getConfig(), accum = []) {
-		super(undefined, config, true, accum, {String: ':', GalleryImageToken: ':'});
+		super(undefined, config, true, accum, {AstText: ':', GalleryImageToken: ':'});
 		for (const line of inner?.split('\n') ?? []) {
-			const matches = /^([^|]+)(?:\|(.*))?/.exec(line);
+			const matches = /^([^|]+)(?:\|(.*))?/u.exec(line);
 			if (!matches) {
-				this.appendChild(line);
+				this.appendChild(line.trim() ? new HiddenToken(line, undefined, config, [], {AstText: ':'}) : line);
 				continue;
 			}
 			const [, file, alt] = matches;
@@ -32,34 +32,46 @@ class GalleryToken extends Token {
 			} catch {
 				title = this.normalizeTitle(file, 6, true);
 			}
-			if (!title.valid) {
-				this.appendChild(line);
-			} else {
+			if (title.valid) {
 				this.appendChild(new GalleryImageToken(file, alt, title, config, accum));
+			} else {
+				this.appendChild(new HiddenToken(line, undefined, config, [], {AstText: ':'}));
 			}
 		}
 	}
 
+	/** @override */
 	cloneNode() {
-		const cloned = this.cloneChildren(),
+		const cloned = this.cloneChildNodes(),
 			token = Parser.run(() => new GalleryToken(undefined, this.getAttribute('config')));
 		token.append(...cloned);
 		return token;
 	}
 
-	toString() {
-		return super.toString('\n');
+	/**
+	 * @override
+	 * @param {string} selector
+	 */
+	toString(selector) {
+		return super.toString(selector, '\n');
 	}
 
+	/** @override */
 	getGaps() {
 		return 1;
 	}
 
+	/** @override */
 	text() {
-		return text(this.children, '\n');
+		return super.text('\n').replaceAll(/\n\s*\n/gu, '\n');
 	}
 
-	/** @param {string} file */
+	/**
+	 * 插入图片
+	 * @param {string} file 图片文件名
+	 * @param {number} i 插入位置
+	 * @throws `SyntaxError` 非法的文件名
+	 */
 	insertImage(file, i = this.childNodes.length) {
 		let title;
 		try {

package/src/heading.js

@@ -2,7 +2,7 @@
 
 const fixedToken = require('../mixin/fixedToken'),
 	sol = require('../mixin/sol'),
-	/** @type {Parser} */ Parser = require('..'),
+	Parser = require('..'),
 	Token = require('.');
 
 /**
@@ -12,9 +12,14 @@ const fixedToken = require('../mixin/fixedToken'),
 class HeadingToken extends fixedToken(sol(Token)) {
 	type = 'heading';
 
+	/** 内部wikitext */
+	get innerText() {
+		return this.firstElementChild.text();
+	}
+
 	/**
-	 * @param {number} level
-	 * @param {string[]} input
+	 * @param {number} level 标题层级
+	 * @param {string[]} input 标题文字
 	 * @param {accum} accum
 	 */
 	constructor(level, input, config = Parser.getConfig(), accum = []) {
@@ -23,38 +28,48 @@ class HeadingToken extends fixedToken(sol(Token)) {
 		const token = new Token(input[0], config, true, accum);
 		token.type = 'heading-title';
 		token.setAttribute('name', this.name).setAttribute('stage', 2);
-		const SyntaxToken = require('./syntax'),
-			trail = new SyntaxToken(input[1], /^[^\S\n]*$/, 'heading-trail', config, accum, {
-				'Stage-1': ':', '!ExtToken': '',
-			});
+		const SyntaxToken = require('./syntax');
+		const trail = new SyntaxToken(input[1], /^[^\S\n]*$/u, 'heading-trail', config, accum, {
+			'Stage-1': ':', '!ExtToken': '',
+		});
 		this.append(token, trail);
 	}
 
+	/** @override */
 	cloneNode() {
-		const [title, trail] = this.cloneChildren(),
+		const [title, trail] = this.cloneChildNodes(),
 			token = Parser.run(() => new HeadingToken(Number(this.name), [], this.getAttribute('config')));
 		token.firstElementChild.safeReplaceWith(title);
 		token.lastElementChild.safeReplaceWith(trail);
 		return token;
 	}
 
-	/** @this {HeadingToken & {prependNewLine(): ''|'\n', appendNewLine(): ''|'\n'}} */
-	toString() {
+	/**
+	 * @override
+	 * @this {{prependNewLine(): ''|'\n', appendNewLine(): ''|'\n'} & HeadingToken}
+	 * @param {string} selector
+	 */
+	toString(selector) {
 		const equals = '='.repeat(Number(this.name));
-		return `${this.prependNewLine()}${equals}${
-			this.firstElementChild.toString()
-		}${equals}${this.lastElementChild.toString()}${this.appendNewLine()}`;
+		return selector && this.matches(selector)
+			? ''
+			: `${this.prependNewLine()}${equals}${
+				this.firstElementChild.toString(selector)
+			}${equals}${this.lastElementChild.toString(selector)}${this.appendNewLine()}`;
 	}
 
+	/** @override */
 	getPadding() {
 		return super.getPadding() + Number(this.name);
 	}
 
+	/** @override */
 	getGaps() {
 		return Number(this.name);
 	}
 
 	/**
+	 * @override
 	 * @this {HeadingToken & {prependNewLine(): ''|'\n', appendNewLine(): ''|'\n'}}
 	 * @returns {string}
 	 */
@@ -63,7 +78,10 @@ class HeadingToken extends fixedToken(sol(Token)) {
 		return `${this.prependNewLine()}${equals}${this.firstElementChild.text()}${equals}${this.appendNewLine()}`;
 	}
 
-	/** @param {number} n */
+	/**
+	 * 设置标题层级
+	 * @param {number} n 标题层级
+	 */
 	setLevel(n) {
 		if (typeof n !== 'number') {
 			this.typeError('setLevel', 'Number');
@@ -72,6 +90,7 @@ class HeadingToken extends fixedToken(sol(Token)) {
 		this.setAttribute('name', String(n)).firstElementChild.setAttribute('name', this.name);
 	}
 
+	/** 移除标题后的不可见内容 */
 	removeTrail() {
 		this.lastElementChild.replaceChildren();
 	}

package/src/html.js

@@ -3,7 +3,7 @@
 const {noWrap} = require('../util/string'),
 	fixedToken = require('../mixin/fixedToken'),
 	attributeParent = require('../mixin/attributeParent'),
-	/** @type {Parser} */ Parser = require('..'),
+	Parser = require('..'),
 	Token = require('.');
 
 /**
@@ -12,57 +12,108 @@ const {noWrap} = require('../util/string'),
  */
 class HtmlToken extends attributeParent(fixedToken(Token)) {
 	type = 'html';
-	closing;
-	selfClosing;
+	#closing;
+	#selfClosing;
 	#tag;
 
+	/** getter */
+	get closing() {
+		return this.#closing;
+	}
+
+	/** @throws `Error` 自闭合标签或空标签 */
+	set closing(value) {
+		if (!value) {
+			this.#closing = false;
+			return;
+		} else if (this.#selfClosing) {
+			throw new Error(`这是一个自闭合标签！`);
+		}
+		const {html: [,, tags]} = this.getAttribute('config');
+		if (tags.includes(this.name)) {
+			throw new Error(`这是一个空标签！`);
+		}
+		this.#closing = true;
+	}
+
+	/** getter */
+	get selfClosing() {
+		return this.#selfClosing;
+	}
+
+	/** @throws `Error` 闭合标签或无效自闭合标签 */
+	set selfClosing(value) {
+		if (!value) {
+			this.#selfClosing = false;
+			return;
+		} else if (this.#closing) {
+			throw new Error('这是一个闭合标签！');
+		}
+		const {html: [tags]} = this.getAttribute('config');
+		if (tags.includes(this.name)) {
+			throw new Error(`<${this.name}>标签自闭合无效！`);
+		}
+		this.#selfClosing = true;
+	}
+
 	/**
-	 * @param {string} name
-	 * @param {AttributeToken} attr
-	 * @param {boolean} closing
-	 * @param {boolean} selfClosing
+	 * @param {string} name 标签名
+	 * @param {AttributeToken} attr 标签属性
+	 * @param {boolean} closing 是否闭合
+	 * @param {boolean} selfClosing 是否自封闭
 	 * @param {accum} accum
 	 */
 	constructor(name, attr, closing, selfClosing, config = Parser.getConfig(), accum = []) {
 		super(undefined, config, true, accum);
 		this.appendChild(attr);
 		this.setAttribute('name', name.toLowerCase());
-		this.closing = closing;
-		this.selfClosing = selfClosing;
+		this.#closing = closing;
+		this.#selfClosing = selfClosing;
 		this.#tag = name;
 	}
 
+	/** @override */
 	cloneNode() {
-		const [attr] = this.cloneChildren(),
+		const [attr] = this.cloneChildNodes(),
 			config = this.getAttribute('config');
-		return Parser.run(() => new HtmlToken(this.#tag, attr, this.closing, this.selfClosing, config));
+		return Parser.run(() => new HtmlToken(this.#tag, attr, this.#closing, this.#selfClosing, config));
 	}
 
 	/**
+	 * @override
 	 * @template {string} T
-	 * @param {T} key
+	 * @param {T} key 属性键
 	 * @returns {TokenAttribute<T>}
 	 */
 	getAttribute(key) {
-		if (key === 'tag') {
-			return this.#tag;
-		}
-		return super.getAttribute(key);
+		return key === 'tag' ? this.#tag : super.getAttribute(key);
 	}
 
-	toString() {
-		return `<${this.closing ? '/' : ''}${this.#tag}${super.toString()}${this.selfClosing ? '/' : ''}>`;
+	/**
+	 * @override
+	 * @param {string} selector
+	 */
+	toString(selector) {
+		return selector && this.matches(selector)
+			? ''
+			: `<${this.#closing ? '/' : ''}${this.#tag}${super.toString(selector)}${this.#selfClosing ? '/' : ''}>`;
 	}
 
+	/** @override */
 	getPadding() {
-		return this.#tag.length + (this.closing ? 2 : 1);
+		return this.#tag.length + (this.#closing ? 2 : 1);
 	}
 
+	/** @override */
 	text() {
-		return `<${this.closing ? '/' : ''}${this.#tag}${super.text()}${this.selfClosing ? '/' : ''}>`;
+		return `<${this.#closing ? '/' : ''}${this.#tag}${super.text()}${this.#selfClosing ? '/' : ''}>`;
 	}
 
-	/** @param {string} tag */
+	/**
+	 * 更换标签名
+	 * @param {string} tag 标签名
+	 * @throws `RangeError` 非法的HTML标签
+	 */
 	replaceTag(tag) {
 		const name = tag.toLowerCase();
 		if (!this.getAttribute('config').html.flat().includes(name)) {
@@ -71,21 +122,27 @@ class HtmlToken extends attributeParent(fixedToken(Token)) {
 		this.setAttribute('name', name).#tag = tag;
 	}
 
-	/** @complexity `n` */
+	/**
+	 * 搜索匹配的标签
+	 * @complexity `n`
+	 * @throws `SyntaxError` 同时闭合和自封闭的标签
+	 * @throws `SyntaxError` 无效自封闭标签
+	 * @throws `SyntaxError` 未闭合的标签
+	 */
 	findMatchingTag() {
 		const {html} = this.getAttribute('config'),
-			{name, parentElement, closing, selfClosing} = this,
-			string = noWrap(this.toString());
+			{name, parentNode, closing, selfClosing} = this,
+			string = noWrap(String(this));
 		if (closing && selfClosing) {
 			throw new SyntaxError(`同时闭合和自封闭的标签：${string}`);
 		} else if (html[2].includes(name) || selfClosing && html[1].includes(name)) { // 自封闭标签
 			return this;
 		} else if (selfClosing && html[0].includes(name)) {
 			throw new SyntaxError(`无效自封闭标签：${string}`);
-		} else if (!parentElement) {
-			return;
+		} else if (!parentNode) {
+			return undefined;
 		}
-		const {children} = parentElement,
+		const {children} = parentNode,
 			i = children.indexOf(this),
 			selector = `html#${name}`,
 			siblings = closing
@@ -105,32 +162,37 @@ class HtmlToken extends attributeParent(fixedToken(Token)) {
 		throw new SyntaxError(`未${closing ? '匹配的闭合' : '闭合的'}标签：${string}`);
 	}
 
+	/** 局部闭合 */
 	#localMatch() {
-		this.selfClosing = false;
+		this.#selfClosing = false;
 		const root = Parser.parse(`</${this.name}>`, false, 3, this.getAttribute('config'));
 		this.after(root.firstChild);
 	}
 
-	/** @complexity `n` */
+	/**
+	 * 修复无效自封闭标签
+	 * @complexity `n`
+	 * @throws `Error` 无法修复无效自封闭标签
+	 */
 	fix() {
 		const config = this.getAttribute('config'),
-			{parentElement, selfClosing, name, firstElementChild} = this;
-		if (!parentElement || !selfClosing || !config.html[0].includes(name)) {
+			{parentNode, name, firstElementChild} = this;
+		if (!parentNode || !this.#selfClosing || !config.html[0].includes(name)) {
 			return;
 		} else if (firstElementChild.text().trim()) {
 			this.#localMatch();
 			return;
 		}
-		const {children} = parentElement,
+		const {children} = parentNode,
 			i = children.indexOf(this),
 			/** @type {HtmlToken[]} */
 			prevSiblings = children.slice(0, i).filter(child => child.matches(`html#${name}`)),
 			imbalance = prevSiblings.reduce((acc, {closing}) => acc + (closing ? 1 : -1), 0);
 		if (imbalance < 0) {
-			this.selfClosing = false;
-			this.closing = true;
+			this.#selfClosing = false;
+			this.#closing = true;
 		} else {
-			Parser.warn('无法修复无效自封闭标签', noWrap(this.toString()));
+			Parser.warn('无法修复无效自封闭标签', noWrap(String(this)));
 			throw new Error(`无法修复无效自封闭标签：前文共有 ${imbalance} 个未匹配的闭合标签`);
 		}
 	}

package/src/imageParameter.js

@@ -1,41 +1,39 @@
 'use strict';
 
 const {text, noWrap, extUrlChar} = require('../util/string'),
-	Title = require('../lib/title'),
-	/** @type {Parser} */ Parser = require('..'),
-	Token = require('.');
+	Parser = require('..'),
+	Token = require('.'),
+	AstText = require('../lib/text');
 
 /**
  * 图片参数
- * @classdesc `{childNodes: ...(string|Token)}`
+ * @classdesc `{childNodes: ...(AstText|Token)}`
  */
 class ImageParameterToken extends Token {
-	type = 'image-parameter';
-	#syntax = '';
-
-	static #noLink = Symbol('no-link');
+	static noLink = Symbol('no-link'); // 这个Symbol需要公开
 
 	/**
+	 * 检查图片参数是否合法
 	 * @template {string} T
-	 * @param {T} key
-	 * @param {string} value
+	 * @param {T} key 参数名
+	 * @param {string} value 参数值
 	 * @returns {T extends 'link' ? string|Symbol : boolean}
 	 */
-	static #validate(key, value, config = Parser.getConfig()) {
-		value = value.replace(/\0\d+t\x7f/g, '').trim();
+	static #validate(key, value, config = Parser.getConfig(), halfParsed = false) {
+		value = value.replaceAll(/\0\d+t\x7F/gu, '').trim();
 		if (key === 'width') {
-			return /^\d*(?:x\d*)?$/.test(value);
+			return /^\d*(?:x\d*)?$/u.test(value);
 		} else if (['alt', 'class', 'manualthumb', 'frameless', 'framed', 'thumbnail'].includes(key)) {
 			return true;
 		} else if (key === 'link') {
 			if (!value) {
-				return this.#noLink;
+				return this.noLink;
 			}
-			const regex = RegExp(`(?:${config.protocol}|//)${extUrlChar}(?=\0\\d+t\x7f|$)`, 'iu');
+			const regex = new RegExp(`(?:${config.protocol}|//)${extUrlChar}(?=\0\\d+t\x7F|$)`, 'iu');
 			if (regex.test(value)) {
 				return value;
 			}
-			if (/^\[\[.+\]\]$/.test(value)) {
+			if (value.startsWith('[[') && value.endsWith(']]')) {
 				value = value.slice(2, -2);
 			}
 			if (value.includes('%')) {
@@ -43,24 +41,39 @@ class ImageParameterToken extends Token {
 					value = decodeURIComponent(value);
 				} catch {}
 			}
-			const {title, fragment, valid} = new Title(value, 0, config);
-			return valid && `${title}${fragment && '#'}${fragment}`;
+			const title = Parser.normalizeTitle(value, 0, false, config, halfParsed);
+			return title.valid && String(title);
 		}
 		return !isNaN(value);
 	}
 
+	type = 'image-parameter';
+	#syntax = '';
+
+	/** getValue()的getter */
+	get value() {
+		return this.getValue();
+	}
+
+	set value(value) {
+		this.setValue(value);
+	}
+
+	/** 图片链接 */
 	get link() {
-		if (this.name === 'link') {
-			return ImageParameterToken.#validate('link', this.getValue(), this.getAttribute('config'));
-		}
-		return undefined;
+		return this.name === 'link'
+			? ImageParameterToken.#validate('link', this.getValue(), this.getAttribute('config'))
+			: undefined;
 	}
+
 	set link(value) {
 		if (this.name === 'link') {
-			value = value === ImageParameterToken.#noLink ? '' : value;
+			value = value === ImageParameterToken.noLink ? '' : value;
 			this.setValue(value);
 		}
 	}
+
+	/** 图片大小 */
 	get size() {
 		if (this.name === 'width') {
 			const /** @type {string} */ size = this.getValue().trim();
@@ -68,30 +81,37 @@ class ImageParameterToken extends Token {
 				const [width, height = ''] = size.split('x');
 				return {width, height};
 			}
-			const token = Parser.parse(size, false, 2, this.getAttribute('config')),
-				{childNodes} = token,
-				i = childNodes.findIndex(child => typeof child === 'string' && child.includes('x'));
+			const /** @type {{childNodes: AstText[]}} */ token = Parser.parse(size, false, 2, this.getAttribute('config')),
+				i = token.childNodes.findIndex(({type, data}) => type === 'text' && data.includes('x')),
+				str = token.childNodes[i];
 			if (i === -1) {
 				return {width: size, height: ''};
 			}
-			token.splitText(i, childNodes[i].indexOf('x'));
-			token.splitText(i + 1, 1);
+			str.splitText(str.data.indexOf('x'));
+			str.nextSibling.splitText(1);
+			// eslint-disable-next-line unicorn/consistent-destructuring
 			return {width: text(token.childNodes.slice(0, i + 1)), height: text(token.childNodes.slice(i + 2))};
 		}
 		return undefined;
 	}
+
+	/** 图片宽度 */
 	get width() {
 		return this.size?.width;
 	}
+
 	set width(width) {
 		if (this.name === 'width') {
 			const {height} = this;
 			this.setValue(`${String(width || '')}${height && 'x'}${height}`);
 		}
 	}
+
+	/** 图片高度 */
 	get height() {
 		return this.size?.height;
 	}
+
 	set height(height) {
 		height = String(height || '');
 		if (this.name === 'width') {
@@ -100,20 +120,18 @@ class ImageParameterToken extends Token {
 	}
 
 	/**
-	 * @param {string} str
+	 * @param {string} str 图片参数
 	 * @param {accum} accum
 	 */
 	constructor(str, config = Parser.getConfig(), accum = []) {
 		const regexes = Object.entries(config.img).map(
 				/** @returns {[string, string, RegExp]} */
-				([syntax, param]) => [syntax, param, RegExp(`^(\\s*)${syntax.replace('$1', '(.*)')}(\\s*)$`)],
+				([syntax, param]) => [syntax, param, new RegExp(`^(\\s*)${syntax.replace('$1', '(.*)')}(\\s*)$`, 'u')],
 			),
 			param = regexes.find(([,, regex]) => regex.test(str));
 		if (param) {
 			const mt = param[2].exec(str);
-			if (mt.length === 4 && !ImageParameterToken.#validate(param[1], mt[2], config)) {
-				// pass
-			} else {
+			if (mt.length !== 4 || ImageParameterToken.#validate(param[1], mt[2], config, true)) {
 				if (mt.length === 3) {
 					super(undefined, config, true, accum);
 					this.#syntax = str;
@@ -129,8 +147,9 @@ class ImageParameterToken extends Token {
 		this.setAttribute('name', 'caption').setAttribute('stage', 7);
 	}
 
+	/** @override */
 	cloneNode() {
-		const cloned = this.cloneChildren(),
+		const cloned = this.cloneChildNodes(),
 			config = this.getAttribute('config'),
 			token = Parser.run(() => new ImageParameterToken(this.#syntax.replace('$1', ''), config));
 		token.replaceChildren(...cloned);
@@ -138,47 +157,52 @@ class ImageParameterToken extends Token {
 	}
 
 	/**
+	 * @override
 	 * @template {string} T
-	 * @param {T} key
+	 * @param {T} key 属性键
 	 * @returns {TokenAttribute<T>}
 	 */
 	getAttribute(key) {
-		if (key === 'syntax') {
-			return this.#syntax;
-		}
-		return super.getAttribute(key);
+		return key === 'syntax' ? this.#syntax : super.getAttribute(key);
 	}
 
+	/** @override */
 	isPlain() {
 		return true;
 	}
 
+	/** 是否是不可变参数 */
 	#isVoid() {
 		return this.#syntax && !this.#syntax.includes('$1');
 	}
 
-	toString() {
-		if (!this.#syntax) {
-			return super.toString();
-		}
-		return this.#syntax.replace('$1', super.toString());
+	/**
+	 * @override
+	 * @param {string} selector
+	 */
+	toString(selector) {
+		return this.#syntax && !(selector && this.matches(selector))
+			? this.#syntax.replace('$1', super.toString(selector))
+			: super.toString(selector);
 	}
 
+	/** @override */
 	getPadding() {
 		return Math.max(0, this.#syntax.indexOf('$1'));
 	}
 
+	/** @override */
 	text() {
-		if (!this.#syntax) {
-			return super.text().trim();
-		}
-		return this.#syntax.replace('$1', super.text()).trim();
+		return this.#syntax ? this.#syntax.replace('$1', super.text()).trim() : super.text().trim();
 	}
 
 	/**
-	 * @template {string|Token} T
-	 * @param {T} token
+	 * @override
+	 * @template {Token} T
+	 * @param {T} token 待插入的子节点
+	 * @param {number} i 插入位置
 	 * @complexity `n`
+	 * @throws `Error` 不接受自定义输入的图片参数
 	 */
 	insertAt(token, i = this.childNodes.length) {
 		if (!Parser.running && this.#isVoid()) {
@@ -187,14 +211,19 @@ class ImageParameterToken extends Token {
 		return super.insertAt(token, i);
 	}
 
-	/** @complexity `n` */
+	/**
+	 * 获取参数值
+	 * @complexity `n`
+	 */
 	getValue() {
 		return this.#isVoid() || super.text();
 	}
 
 	/**
-	 * @param {string|boolean} value
+	 * 设置参数值
+	 * @param {string|boolean} value 参数值
 	 * @complexity `n`
+	 * @throws	SyntaxError` 非法的参数值
 	 */
 	setValue(value) {
 		if (this.#isVoid()) {
@@ -212,7 +241,7 @@ class ImageParameterToken extends Token {
 			}]]`, this.getAttribute('include'), 6, this.getAttribute('config')),
 			{childNodes: {length}, firstElementChild} = root,
 			param = firstElementChild?.lastElementChild;
-		if (length !== 1 || !firstElementChild?.matches('file#File:F')
+		if (length !== 1 || !firstElementChild?.matches('file#File\\:F')
 			|| firstElementChild.childNodes.length !== 2 || param.name !== this.name
 		) {
 			throw new SyntaxError(`非法的 ${this.name} 参数：${noWrap(value)}`);