wikiparser-node 0.8.1-m → 0.9.0

package/src/extLink.js

@@ -1,6 +1,7 @@
 'use strict';
 
 const Parser = require('..'),
+	{noWrap, normalizeSpace} = require('../util/string'),
 	Token = require('.'),
 	MagicLinkToken = require('./magicLink');
 
@@ -12,37 +13,78 @@ class ExtLinkToken extends Token {
 	type = 'ext-link';
 	#space;
 
+	/**
+	 * 协议
+	 * @this {{firstChild: MagicLinkToken}}
+	 */
+	get protocol() {
+		return this.firstChild.protocol;
+	}
+
+	/** @this {{firstChild: MagicLinkToken}} */
+	set protocol(value) {
+		this.firstChild.protocol = value;
+	}
+
+	/**
+	 * 和内链保持一致
+	 * @this {{firstChild: MagicLinkToken}}
+	 */
+	get link() {
+		return this.firstChild.link;
+	}
+
+	set link(url) {
+		this.setTarget(url);
+	}
+
+	/** 链接显示文字 */
+	get innerText() {
+		return this.length > 1
+			? this.lastChild.text()
+			: `[${this.getRootNode().querySelectorAll('ext-link[childElementCount=1]').indexOf(this) + 1}]`;
+	}
+
 	/**
 	 * @param {string} url 网址
 	 * @param {string} space 空白字符
 	 * @param {string} text 链接文字
 	 * @param {accum} accum
 	 */
-	constructor(url, space, text, config = Parser.getConfig(), accum = []) {
+	constructor(url, space = '', text = '', config = Parser.getConfig(), accum = []) {
 		super(undefined, config, true, accum, {
+			MagicLinkToken: 0, Token: 1,
 		});
 		this.insertAt(new MagicLinkToken(url, true, config, accum));
 		this.#space = space;
 		if (text) {
 			const inner = new Token(text, config, true, accum, {
+				'Stage-7': ':', ConverterToken: ':',
 			});
 			inner.type = 'ext-link-text';
 			this.insertAt(inner.setAttribute('stage', Parser.MAX_STAGE - 1));
 		}
+		this.getAttribute('protectChildren')(0);
 	}
 
 	/**
 	 * @override
+	 * @param {string} selector
 	 */
 	toString(selector) {
-		if (this.length === 1) {
+		if (selector && this.matches(selector)) {
+			return '';
+		} else if (this.length === 1) {
 			return `[${super.toString(selector)}${this.#space}]`;
 		}
+		this.#correct();
+		normalizeSpace(this.lastChild);
 		return `[${super.toString(selector, this.#space)}]`;
 	}
 
 	/** @override */
 	text() {
+		normalizeSpace(this.childNodes[1]);
 		return `[${super.text(' ')}]`;
 	}
 
@@ -53,8 +95,86 @@ class ExtLinkToken extends Token {
 
 	/** @override */
 	getGaps() {
+		this.#correct();
 		return this.#space.length;
 	}
+
+	/** @override */
+	print() {
+		return super.print(
+			this.length > 1 ? {pre: '[', sep: this.#space, post: ']'} : {pre: '[', post: `${this.#space}]`},
+		);
+	}
+
+	/** @override */
+	cloneNode() {
+		const [url, text] = this.cloneChildNodes();
+		return Parser.run(() => {
+			const token = new ExtLinkToken(undefined, '', '', this.getAttribute('config'));
+			token.firstChild.safeReplaceWith(url);
+			if (text) {
+				token.insertAt(text);
+			}
+			return token;
+		});
+	}
+
+	/** 修正空白字符 */
+	#correct() {
+		if (!this.#space && this.length > 1
+			// 都替换成`<`肯定不对，但无妨
+			&& /^[^[\]<>"{\0-\x1F\x7F\p{Zs}\uFFFD]/u.test(this.lastChild.text().replace(/&[lg]t;/u, '<'))
+		) {
+			this.#space = ' ';
+		}
+	}
+
+	/**
+	 * 获取网址
+	 * @this {{firstChild: MagicLinkToken}}
+	 */
+	getUrl() {
+		return this.firstChild.getUrl();
+	}
+
+	/**
+	 * 设置链接目标
+	 * @param {string|URL} url 网址
+	 * @throws `SyntaxError` 非法的外链目标
+	 */
+	setTarget(url) {
+		url = String(url);
+		const root = Parser.parse(`[${url}]`, this.getAttribute('include'), 8, this.getAttribute('config')),
+			{length, firstChild: extLink} = root;
+		if (length !== 1 || extLink.type !== 'ext-link' || extLink.length !== 1) {
+			throw new SyntaxError(`非法的外链目标：${url}`);
+		}
+		const {firstChild} = extLink;
+		extLink.destroy(true);
+		this.firstChild.safeReplaceWith(firstChild);
+	}
+
+	/**
+	 * 设置链接显示文字
+	 * @param {string} text 链接显示文字
+	 * @throws `SyntaxError` 非法的链接显示文字
+	 */
+	setLinkText(text) {
+		text = String(text);
+		const root = Parser.parse(`[//url ${text}]`, this.getAttribute('include'), 8, this.getAttribute('config')),
+			{length, firstChild: extLink} = root;
+		if (length !== 1 || extLink.type !== 'ext-link' || extLink.length !== 2) {
+			throw new SyntaxError(`非法的外链文字：${noWrap(text)}`);
+		}
+		const {lastChild} = extLink;
+		if (this.length === 1) {
+			this.insertAt(lastChild);
+		} else {
+			this.lastChild.safeReplaceWith(lastChild);
+		}
+		this.#space ||= ' ';
+	}
 }
 
+Parser.classes.ExtLinkToken = __filename;
 module.exports = ExtLinkToken;

package/src/gallery.js

@@ -13,24 +13,25 @@ class GalleryToken extends Token {
 	type = 'ext-inner';
 	name = 'gallery';
 
+	/** 所有图片 */
+	get images() {
+		return this.childNodes.filter(({type}) => type === 'gallery-image');
+	}
+
 	/**
 	 * @param {string} inner 标签内部wikitext
 	 * @param {accum} accum
 	 */
 	constructor(inner, config = Parser.getConfig(), accum = []) {
 		super(undefined, config, true, accum, {
+			AstText: ':', GalleryImageToken: ':', HiddenToken: ':',
 		});
-		const /** @type {ParserConfig} */ newConfig = {...config, img: {...config.img}};
-		for (const [k, v] of Object.entries(config.img)) {
-			if (v === 'width') {
-				delete newConfig.img[k];
-			}
-		}
 		for (const line of inner?.split('\n') ?? []) {
 			const matches = /^([^|]+)(?:\|(.*))?/u.exec(line);
 			if (!matches) {
 				super.insertAt(line.trim()
-					? new HiddenToken(line, undefined, newConfig, [], {
+					? new HiddenToken(line, undefined, config, [], {
+						AstText: ':',
 					})
 					: line);
 				continue;
@@ -38,9 +39,10 @@ class GalleryToken extends Token {
 			const [, file, alt] = matches,
 				title = this.normalizeTitle(file, 6, true, true);
 			if (title.valid) {
-				super.insertAt(new GalleryImageToken(file, alt, title, newConfig, accum));
+				super.insertAt(new GalleryImageToken(file, alt, config, accum));
 			} else {
-				super.insertAt(new HiddenToken(line, undefined, newConfig, [], {
+				super.insertAt(new HiddenToken(line, undefined, config, [], {
+					AstText: ':',
 				}));
 			}
 		}
@@ -48,6 +50,7 @@ class GalleryToken extends Token {
 
 	/**
 	 * @override
+	 * @param {string} selector
 	 */
 	toString(selector) {
 		return super.toString(selector, '\n');
@@ -63,11 +66,16 @@ class GalleryToken extends Token {
 		return 1;
 	}
 
+	/** @override */
+	print() {
+		return super.print({sep: '\n'});
+	}
+
 	/**
 	 * @override
 	 * @param {number} start 起始位置
 	 */
-	lint(start = 0) {
+	lint(start = this.getAbsoluteIndex()) {
 		const {top, left} = this.getRootNode().posFromIndex(start),
 			/** @type {LintError[]} */ errors = [];
 		for (let i = 0, startIndex = start; i < this.length; i++) {
@@ -79,7 +87,7 @@ class GalleryToken extends Token {
 				startCol = i ? 0 : left;
 			if (child.type === 'hidden' && trimmed && !/^<!--.*-->$/u.test(trimmed)) {
 				errors.push({
-					message: '图库中的无效内容',
+					message: Parser.msg('invalid content in <$1>', 'gallery'),
 					severity: 'error',
 					startIndex,
 					endIndex: startIndex + length,
@@ -96,6 +104,46 @@ class GalleryToken extends Token {
 		}
 		return errors;
 	}
+
+	/** @override */
+	cloneNode() {
+		const cloned = this.cloneChildNodes();
+		return Parser.run(() => {
+			const token = new GalleryToken(undefined, this.getAttribute('config'));
+			token.append(...cloned);
+			return token;
+		});
+	}
+
+	/**
+	 * 插入图片
+	 * @param {string} file 图片文件名
+	 * @param {number} i 插入位置
+	 * @throws `SyntaxError` 非法的文件名
+	 */
+	insertImage(file, i = this.length) {
+		const title = this.normalizeTitle(file, 6, true, true);
+		if (title.valid) {
+			const token = Parser.run(() => new GalleryImageToken(file, undefined, this.getAttribute('config')));
+			return this.insertAt(token, i);
+		}
+		throw new SyntaxError(`非法的文件名：${file}`);
+	}
+
+	/**
+	 * @override
+	 * @template {string|Token} T
+	 * @param {T} token 待插入的节点
+	 * @param {number} i 插入位置
+	 * @throws `RangeError` 插入不可见内容
+	 */
+	insertAt(token, i = 0) {
+		if (typeof token === 'string' && token.trim() || token instanceof HiddenToken) {
+			throw new RangeError('请勿向图库中插入不可见内容！');
+		}
+		return super.insertAt(token, i);
+	}
 }
 
+Parser.classes.GalleryToken = __filename;
 module.exports = GalleryToken;

package/src/hasNowiki/index.js

@@ -24,9 +24,21 @@ class HasNowikiToken extends Token {
 			},
 		);
 		super(wikitext, config, true, accum, {
+			AstText: ':', NoincludeToken: ':',
 		});
 		this.type = type;
 	}
+
+	/** @override */
+	cloneNode() {
+		const cloned = this.cloneChildNodes();
+		return Parser.run(() => {
+			const token = new HasNowikiToken(undefined, this.type, this.getAttribute('config'));
+			token.append(...cloned);
+			return token;
+		});
+	}
 }
 
+Parser.classes.HasNowikiToken = __filename;
 module.exports = HasNowikiToken;

package/src/hasNowiki/pre.js

@@ -17,12 +17,24 @@ class PreToken extends HasNowikiToken {
 	constructor(wikitext, config = Parser.getConfig(), accum = []) {
 		super(wikitext, 'ext-inner', config, accum);
 		this.setAttribute('stage', Parser.MAX_STAGE - 1);
+		this.setAttribute('acceptable', {AstText: ':', NoincludeToken: ':', ConverterToken: ':'});
 	}
 
 	/** @override */
 	isPlain() {
 		return true;
 	}
+
+	/** @override */
+	cloneNode() {
+		const cloned = this.cloneChildNodes();
+		return Parser.run(() => {
+			const token = new PreToken(undefined, this.getAttribute('config'));
+			token.append(...cloned);
+			return token;
+		});
+	}
 }
 
+Parser.classes.PreToken = __filename;
 module.exports = PreToken;

package/src/heading.js

@@ -1,6 +1,8 @@
 'use strict';
 
 const {generateForSelf} = require('../util/lint'),
+	fixedToken = require('../mixin/fixedToken'),
+	sol = require('../mixin/sol'),
 	Parser = require('..'),
 	Token = require('.'),
 	SyntaxToken = require('./syntax');
@@ -9,9 +11,14 @@ const {generateForSelf} = require('../util/lint'),
  * 章节标题
  * @classdesc `{childNodes: [Token, SyntaxToken]}`
  */
-class HeadingToken extends Token {
+class HeadingToken extends fixedToken(sol(Token)) {
 	type = 'heading';
 
+	/** 内部wikitext */
+	get innerText() {
+		return this.firstChild.text();
+	}
+
 	/**
 	 * @param {number} level 标题层级
 	 * @param {string[]} input 标题文字
@@ -22,28 +29,37 @@ class HeadingToken extends Token {
 		this.setAttribute('name', String(level));
 		const token = new Token(input[0], config, true, accum);
 		token.type = 'heading-title';
+		token.setAttribute('name', this.name);
 		token.setAttribute('stage', 2);
 		const trail = new SyntaxToken(input[1], /^[^\S\n]*$/u, 'heading-trail', config, accum, {
+			'Stage-1': ':', '!ExtToken': '',
 		});
 		this.append(token, trail);
 	}
 
 	/**
 	 * @override
+	 * @this {{prependNewLine(): ''|'\n'} & HeadingToken}
+	 * @param {string} selector
 	 * @returns {string}
 	 */
 	toString(selector) {
 		const equals = '='.repeat(Number(this.name));
-		return `${equals}${this.firstChild.toString()}${equals}${this.lastChild.toString()}`;
+		return selector && this.matches(selector)
+			? ''
+			: `${this.prependNewLine()}${equals}${
+				this.firstChild.toString(selector)
+			}${equals}${this.lastChild.toString(selector)}`;
 	}
 
 	/**
 	 * @override
+	 * @this {HeadingToken & {prependNewLine(): ''|'\n'}}
 	 * @returns {string}
 	 */
 	text() {
 		const equals = '='.repeat(Number(this.name));
-		return `${equals}${this.firstChild.text()}${equals}`;
+		return `${this.prependNewLine()}${equals}${this.firstChild.text()}${equals}`;
 	}
 
 	/** @override */
@@ -56,11 +72,17 @@ class HeadingToken extends Token {
 		return Number(this.name);
 	}
 
+	/** @override */
+	print() {
+		const equals = '='.repeat(Number(this.name));
+		return super.print({pre: equals, sep: equals});
+	}
+
 	/**
 	 * @override
 	 * @param {number} start 起始位置
 	 */
-	lint(start = 0) {
+	lint(start = this.getAbsoluteIndex()) {
 		const errors = super.lint(start),
 			innerText = String(this.firstChild);
 		let refError;
@@ -70,14 +92,43 @@ class HeadingToken extends Token {
 		}
 		if (innerText[0] === '=' || innerText.endsWith('=')) {
 			refError ||= generateForSelf(this, {start}, '');
-			errors.push({...refError, message: '段落标题中不平衡的"="'});
+			errors.push({...refError, message: Parser.msg('unbalanced "=" in a section header')});
 		}
 		if (this.closest('html-attrs, table-attrs')) {
 			refError ||= generateForSelf(this, {start}, '');
-			errors.push({...refError, message: 'HTML标签属性中的段落标题'});
+			errors.push({...refError, message: Parser.msg('section header in a HTML tag')});
 		}
 		return errors;
 	}
+
+	/** @override */
+	cloneNode() {
+		const [title, trail] = this.cloneChildNodes();
+		return Parser.run(() => {
+			const token = new HeadingToken(Number(this.name), [], this.getAttribute('config'));
+			token.firsthild.safeReplaceWith(title);
+			token.lastChild.safeReplaceWith(trail);
+			return token;
+		});
+	}
+
+	/**
+	 * 设置标题层级
+	 * @param {number} n 标题层级
+	 */
+	setLevel(n) {
+		if (!Number.isInteger(n)) {
+			this.typeError('setLevel', 'Number');
+		}
+		n = Math.min(Math.max(n, 1), 6);
+		this.setAttribute('name', String(n)).firstChild.setAttribute('name', this.name);
+	}
+
+	/** 移除标题后的不可见内容 */
+	removeTrail() {
+		this.lastChild.replaceChildren();
+	}
 }
 
+Parser.classes.HeadingToken = __filename;
 module.exports = HeadingToken;

package/src/html.js

@@ -1,14 +1,19 @@
 'use strict';
 
 const {generateForSelf} = require('../util/lint'),
+	{noWrap} = require('../util/string'),
+	fixedToken = require('../mixin/fixedToken'),
+	attributeParent = require('../mixin/attributeParent'),
 	Parser = require('..'),
 	Token = require('.');
 
+const magicWords = new Set(['if', 'ifeq', 'ifexpr', 'ifexist', 'iferror', 'switch']);
+
 /**
  * HTML标签
  * @classdesc `{childNodes: [AttributesToken]}`
  */
-class HtmlToken extends Token {
+class HtmlToken extends attributeParent(fixedToken(Token)) {
 	type = 'html';
 	#closing;
 	#selfClosing;
@@ -19,6 +24,41 @@ class HtmlToken extends Token {
 		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 {AttributesToken} attr 标签属性
@@ -37,9 +77,12 @@ class HtmlToken extends Token {
 
 	/**
 	 * @override
+	 * @param {string} selector
 	 */
 	toString(selector) {
-		return `<${this.#closing ? '/' : ''}${this.#tag}${super.toString()}${this.#selfClosing ? '/' : ''}>`;
+		return selector && this.matches(selector)
+			? ''
+			: `<${this.#closing ? '/' : ''}${this.#tag}${super.toString(selector)}${this.#selfClosing ? '/' : ''}>`;
 	}
 
 	/** @override */
@@ -54,11 +97,19 @@ class HtmlToken extends Token {
 		return this.#tag.length + (this.#closing ? 2 : 1);
 	}
 
+	/** @override */
+	print() {
+		return super.print({
+			pre: `&lt;${this.#closing ? '/' : ''}${this.#tag}`,
+			post: `${this.#selfClosing ? '/' : ''}&gt;`,
+		});
+	}
+
 	/**
 	 * @override
 	 * @param {number} start 起始位置
 	 */
-	lint(start = 0) {
+	lint(start = this.getAbsoluteIndex()) {
 		const errors = super.lint(start);
 		let wikitext, /** @type {LintError} */ refError;
 		if (this.name === 'h1' && !this.#closing) {
@@ -70,20 +121,24 @@ class HtmlToken extends Token {
 			wikitext ||= String(this.getRootNode());
 			refError ||= generateForSelf(this, {start}, '');
 			const excerpt = wikitext.slice(Math.max(0, start - 25), start + 25);
-			errors.push({...refError, message: '表格属性中的HTML标签', excerpt});
+			errors.push({...refError, message: Parser.msg('HTML tag in table attributes'), excerpt});
 		}
 		try {
 			this.findMatchingTag();
 		} catch ({message: errorMsg}) {
 			wikitext ||= String(this.getRootNode());
 			refError ||= generateForSelf(this, {start}, '');
-			const [message] = errorMsg.split('：'),
-				error = {...refError, message, severity: message === '未闭合的标签' ? 'warning' : 'error'};
-			if (message === '未闭合的标签') {
+			const [msg] = errorMsg.split(':'),
+				error = {...refError, message: Parser.msg(msg)};
+			if (msg === 'unclosed tag') {
+				error.severity = 'warning';
 				error.excerpt = wikitext.slice(start, start + 50);
-			} else if (message === '未匹配的闭合标签') {
+			} else if (msg === 'unmatched closing tag') {
 				const end = start + String(this).length;
 				error.excerpt = wikitext.slice(Math.max(0, end - 50), end);
+				if (magicWords.has(this.closest('magic-word')?.name)) {
+					error.severity = 'warning';
+				}
 			}
 			errors.push(error);
 		}
@@ -100,13 +155,13 @@ class HtmlToken extends Token {
 	findMatchingTag() {
 		const {html} = this.getAttribute('config'),
 			{name: tagName, parentNode} = this,
-			string = String(this);
+			string = noWrap(String(this));
 		if (this.#closing && (this.#selfClosing || html[2].includes(tagName))) {
-			throw new SyntaxError(`同时闭合和自封闭的标签：${string}`);
+			throw new SyntaxError(`tag that is both closing and self-closing: ${string}`);
 		} else if (html[2].includes(tagName) || this.#selfClosing && html[1].includes(tagName)) { // 自封闭标签
 			return this;
 		} else if (this.#selfClosing && html[0].includes(tagName)) {
-			throw new SyntaxError(`无效自封闭标签：${string}`);
+			throw new SyntaxError(`invalid self-closing tag: ${string}`);
 		} else if (!parentNode) {
 			return undefined;
 		}
@@ -126,8 +181,74 @@ class HtmlToken extends Token {
 				return token;
 			}
 		}
-		throw new SyntaxError(`未${this.#closing ? '匹配的闭合' : '闭合的'}标签：${string}`);
+		throw new SyntaxError(`${this.#closing ? 'unmatched closing' : 'unclosed'} tag: ${string}`);
+	}
+
+	/** @override */
+	cloneNode() {
+		const [attr] = this.cloneChildNodes(),
+			config = this.getAttribute('config');
+		return Parser.run(() => new HtmlToken(this.#tag, attr, this.#closing, this.#selfClosing, config));
+	}
+
+	/**
+	 * @override
+	 * @template {string} T
+	 * @param {T} key 属性键
+	 * @returns {TokenAttribute<T>}
+	 */
+	getAttribute(key) {
+		return key === 'tag' ? this.#tag : super.getAttribute(key);
+	}
+
+	/**
+	 * 更换标签名
+	 * @param {string} tag 标签名
+	 * @throws `RangeError` 非法的HTML标签
+	 */
+	replaceTag(tag) {
+		const name = tag.toLowerCase();
+		if (!this.getAttribute('config').html.flat().includes(name)) {
+			throw new RangeError(`非法的HTML标签：${tag}`);
+		}
+		this.setAttribute('name', name).#tag = tag;
+	}
+
+	/** 局部闭合 */
+	#localMatch() {
+		this.#selfClosing = false;
+		const root = Parser.parse(`</${this.name}>`, false, 3, this.getAttribute('config'));
+		this.after(root.firstChild);
+	}
+
+	/**
+	 * 修复无效自封闭标签
+	 * @complexity `n`
+	 * @throws `Error` 无法修复无效自封闭标签
+	 */
+	fix() {
+		const config = this.getAttribute('config'),
+			{parentNode, name: tagName, firstChild} = this;
+		if (!parentNode || !this.#selfClosing || !config.html[0].includes(tagName)) {
+			return;
+		} else if (firstChild.text().trim()) {
+			this.#localMatch();
+			return;
+		}
+		const {childNodes} = parentNode,
+			i = childNodes.indexOf(this),
+			/** @type {HtmlToken[]} */
+			prevSiblings = childNodes.slice(0, i).filter(({type, name}) => type === 'html' && name === tagName),
+			imbalance = prevSiblings.reduce((acc, {closing}) => acc + (closing ? 1 : -1), 0);
+		if (imbalance < 0) {
+			this.#selfClosing = false;
+			this.#closing = true;
+		} else {
+			Parser.warn('无法修复无效自封闭标签', noWrap(String(this)));
+			throw new Error(`无法修复无效自封闭标签：前文共有 ${imbalance} 个未匹配的闭合标签`);
+		}
 	}
 }
 
+Parser.classes.HtmlToken = __filename;
 module.exports = HtmlToken;