wikiparser-node 0.3.0 → 0.4.0

package/src/nowiki/index.js

@@ -1,33 +1,40 @@
 'use strict';
 
 const fixedToken = require('../../mixin/fixedToken'),
-	/** @type {Parser} */ Parser = require('../..'),
-	Token = require('..');
+	Parser = require('../..'),
+	Token = require('..'),
+	AstText = require('../../lib/text');
 
 /**
  * 纯文字Token，不会被解析
- * @classdesc `{childNodes: [string]}`
+ * @classdesc `{childNodes: [AstText]}`
  */
 class NowikiToken extends fixedToken(Token) {
 	type = 'ext-inner';
 
 	/**
-	 * @param {string} wikitext
+	 * @param {string} wikitext wikitext
 	 * @param {accum} accum
 	 */
 	constructor(wikitext, config = Parser.getConfig(), accum = []) {
 		super(wikitext, config, true, accum);
 	}
 
-	/** @this {NowikiToken & {firstChild: string}} */
+	/**
+	 * @override
+	 * @this {NowikiToken & {firstChild: AstText, constructor: typeof NowikiToken}}
+	 */
 	cloneNode() {
-		const /** @type {typeof NowikiToken} */ Constructor = this.constructor,
-			token = Parser.run(() => new Constructor(this.firstChild, this.getAttribute('config')));
-		token.type = this.type;
+		const {constructor, firstChild: {data}, type} = this,
+			token = Parser.run(() => new constructor(data, this.getAttribute('config')));
+		token.type = type;
 		return token;
 	}
 
-	/** @param {string} str */
+	/**
+	 * @override
+	 * @param {string} str 新文本
+	 */
 	setText(str) {
 		return super.setText(str, 0);
 	}

package/src/nowiki/list.js

@@ -1,12 +1,12 @@
 'use strict';
 
 const sol = require('../../mixin/sol'),
-	/** @type {Parser} */ Parser = require('../..'),
+	Parser = require('../..'),
 	DdToken = require('./dd');
 
 /**
  * ;:*#
- * @classdesc `{childNodes: [string]}`
+ * @classdesc `{childNodes: [AstText]}`
  */
 class ListToken extends sol(DdToken) {
 	type = 'list';

package/src/nowiki/noinclude.js

@@ -1,19 +1,23 @@
 'use strict';
 
 const hidden = require('../../mixin/hidden'),
-	/** @type {Parser} */ Parser = require('../..'),
+	Parser = require('../..'),
 	NowikiToken = require('.');
 
 /**
  * `<noinclude>`和`</noinclude>`，不可进行任何更改
- * @classdesc `{childNodes: [string]}`
+ * @classdesc `{childNodes: [AstText]}`
  */
 class NoincludeToken extends hidden(NowikiToken) {
 	type = 'noinclude';
 
-	/** @param {string} str */
+	/**
+	 * @override
+	 * @param {string} str 新文本
+	 * @throws `Error` 不可更改
+	 */
 	setText(str) {
-		if (/^<\/?(?:(?:no|only)include|includeonly)(?:\s.*)?\/?>$/is.test(this.toString())) {
+		if (/^<\/?(?:(?:no|only)include|includeonly)(?:\s.*)?\/?>$/isu.test(String(this))) {
 			throw new Error(`${this.constructor.name} 不可更改文字内容！`);
 		}
 		return super.setText(str);

package/src/nowiki/quote.js

@@ -1,17 +1,17 @@
 'use strict';
 
-const /** @type {Parser} */ Parser = require('../..'),
+const Parser = require('../..'),
 	NowikiToken = require('.');
 
 /**
  * `<hr>`
- * @classdesc `{childNodes: [string]}`
+ * @classdesc `{childNodes: [AstText]}`
  */
 class QuoteToken extends NowikiToken {
 	type = 'quote';
 
 	/**
-	 * @param {number} n
+	 * @param {number} n 字符串长度
 	 * @param {accum} accum
 	 */
 	constructor(n, config = Parser.getConfig(), accum = []) {
@@ -19,12 +19,16 @@ class QuoteToken extends NowikiToken {
 		this.setAttribute('name', String(n));
 	}
 
-	/** @param {string} str */
+	/**
+	 * @override
+	 * @param {string} str 新文本
+	 * @throws `RangeError` 错误的单引号语法
+	 */
 	setText(str) {
-		if (!["''", "'''", "'''''"].includes(str)) {
-			throw new RangeError(`${this.constructor.name} 的内部文本只能为连续 2/3/5 个"'"！`);
+		if (str === "''" || str === "'''" || str === "'''''") {
+			return super.setText(str);
 		}
-		return super.setText(str);
+		throw new RangeError(`${this.constructor.name} 的内部文本只能为连续 2/3/5 个"'"！`);
 	}
 }
 

package/src/onlyinclude.js

@@ -1,40 +1,52 @@
 'use strict';
 
-const /** @type {Parser} */ Parser = require('..'),
+const Parser = require('..'),
 	Token = require('.');
 
 /**
  * 嵌入时的`<onlyinclude>`
- * @classdesc `{childNodes: ...string|Token}`
+ * @classdesc `{childNodes: ...AstText|Token}`
  */
 class OnlyincludeToken extends Token {
 	type = 'onlyinclude';
 
+	/** 内部wikitext */
+	get innerText() {
+		return this.text();
+	}
+
 	/**
-	 * @param {string} inner
+	 * @param {string} inner 标签内部wikitext
 	 * @param {accum} accum
 	 */
 	constructor(inner, config = Parser.getConfig(), accum = []) {
 		super(inner, config, true, accum);
 	}
 
+	/** @override */
 	cloneNode() {
-		const cloned = this.cloneChildren(),
+		const cloned = this.cloneChildNodes(),
 			token = Parser.run(() => new OnlyincludeToken(undefined, this.getAttribute('config')));
 		token.append(...cloned);
 		return token;
 	}
 
-	toString() {
-		return `<onlyinclude>${super.toString()}</onlyinclude>`;
+	/**
+	 * @override
+	 * @param {string} selector
+	 */
+	toString(selector) {
+		return selector && this.matches(selector) ? '' : `<onlyinclude>${super.toString(selector)}</onlyinclude>`;
 	}
 
+	/** @override */
 	getPadding() {
 		return 13;
 	}
 
+	/** @override */
 	isPlain() {
-		return this.constructor === OnlyincludeToken;
+		return true;
 	}
 }
 

package/src/parameter.js

@@ -2,7 +2,7 @@
 
 const {noWrap} = require('../util/string'),
 	fixedToken = require('../mixin/fixedToken'),
-	/** @type {Parser} */ Parser = require('..'),
+	Parser = require('..'),
 	Token = require('.');
 
 /**
@@ -11,18 +11,30 @@ const {noWrap} = require('../util/string'),
  */
 class ParameterToken extends fixedToken(Token) {
 	type = 'parameter';
-	anon;
+
+	/** 是否是匿名参数 */
+	get anon() {
+		return this.firstElementChild.childNodes.length === 0;
+	}
+
+	/** getValue()的getter */
+	get value() {
+		return this.getValue();
+	}
+
+	set value(value) {
+		this.setValue(value);
+	}
 
 	/**
-	 * @param {string|number} key
-	 * @param {string} value
+	 * @param {string|number} key 参数名
+	 * @param {string} value 参数值
 	 * @param {accum} accum
 	 */
 	constructor(key, value, config = Parser.getConfig(), accum = []) {
 		super(undefined, config, true, accum);
-		this.anon = typeof key === 'number';
-		const AtomToken = require('./atom'),
-			keyToken = new AtomToken(this.anon ? undefined : key, 'parameter-key', config, accum, {
+		const AtomToken = require('./atom');
+		const keyToken = new AtomToken(typeof key === 'number' ? undefined : key, 'parameter-key', config, accum, {
 				'Stage-2': ':', '!HeadingToken': '',
 			}),
 			token = new Token(value, config, true, accum);
@@ -30,8 +42,9 @@ class ParameterToken extends fixedToken(Token) {
 		this.append(keyToken, token.setAttribute('stage', 2));
 	}
 
+	/** @override */
 	cloneNode() {
-		const [key, value] = this.cloneChildren(),
+		const [key, value] = this.cloneChildNodes(),
 			config = this.getAttribute('config');
 		return Parser.run(() => {
 			const token = new ParameterToken(this.anon ? Number(this.name) : undefined, undefined, config);
@@ -41,6 +54,7 @@ class ParameterToken extends fixedToken(Token) {
 		});
 	}
 
+	/** @override */
 	afterBuild() {
 		if (!this.anon) {
 			const name = this.firstElementChild.text().trim(),
@@ -51,19 +65,14 @@ class ParameterToken extends fixedToken(Token) {
 				parentNode.getArgs(name, false, false).add(this);
 			}
 		}
-		const that = this;
-		/**
-		 * 在AstEventData中记录`oldKey`和`newKey`
-		 * @type {AstListener}
-		 */
-		const parameterListener = ({prevTarget}, data) => {
-			if (!that.anon) { // 匿名参数不管怎么变动还是匿名
-				const {firstElementChild} = that;
+		const /** @type {AstListener} */ parameterListener = ({prevTarget}, data) => {
+			if (!this.anon) { // 匿名参数不管怎么变动还是匿名
+				const {firstElementChild, name} = this;
 				if (prevTarget === firstElementChild) {
 					const newKey = firstElementChild.text().trim();
-					data.oldKey = that.name;
+					data.oldKey = name;
 					data.newKey = newKey;
-					that.setAttribute('name', newKey);
+					this.setAttribute('name', newKey);
 				}
 			}
 		};
@@ -71,22 +80,33 @@ class ParameterToken extends fixedToken(Token) {
 		return this;
 	}
 
-	/** @returns {string} */
-	toString() {
-		return this.anon ? this.lastElementChild.toString() : super.toString('=');
+	/**
+	 * @override
+	 * @param {string} selector
+	 * @returns {string}
+	 */
+	toString(selector) {
+		return this.anon && !(selector && this.matches(selector))
+			? this.lastElementChild.toString(selector)
+			: super.toString(selector, '=');
 	}
 
+	/** @override */
 	getGaps() {
 		return this.anon ? 0 : 1;
 	}
 
-	/** @returns {string} */
+	/**
+	 * @override
+	 * @returns {string}
+	 */
 	text() {
 		return this.anon ? this.lastElementChild.text() : super.text('=');
 	}
 
 	/**
-	 * @param {ParameterToken} token
+	 * @override
+	 * @param {ParameterToken} token 待替换的节点
 	 * @complexity `n`
 	 */
 	safeReplaceWith(token) {
@@ -94,15 +114,20 @@ class ParameterToken extends fixedToken(Token) {
 		return this.replaceWith(token);
 	}
 
+	/** 获取参数值 */
 	getValue() {
 		const value = this.lastElementChild.text();
 		return this.anon && this.parentNode?.matches('template, magic-word#invoke') ? value : value.trim();
 	}
 
-	/** @param {string} value */
+	/**
+	 * 设置参数值
+	 * @param {string} value 参数值
+	 * @throws `SyntaxError` 非法的模板参数
+	 */
 	setValue(value) {
 		value = String(value);
-		const templateLike = this.parentElement?.matches('template, magic-word#invoke'),
+		const templateLike = this.parentNode?.matches('template, magic-word#invoke'),
 			wikitext = `{{${templateLike ? ':T|' : 'lc:'}${this.anon ? '' : '1='}${value}}}`,
 			root = Parser.parse(wikitext, this.getAttribute('include'), 2, this.getAttribute('config')),
 			{childNodes: {length}, firstElementChild} = root,
@@ -113,15 +138,20 @@ class ParameterToken extends fixedToken(Token) {
 		) {
 			throw new SyntaxError(`非法的模板参数：${noWrap(value)}`);
 		}
-		const newValue = lastElementChild.lastChild;
-		root.destroy();
-		firstElementChild.destroy();
-		lastElementChild.destroy();
-		this.lastElementChild.safeReplaceWith(newValue);
+		const {lastChild} = lastElementChild;
+		lastElementChild.destroy(true);
+		this.lastElementChild.safeReplaceWith(lastChild);
 	}
 
-	/** @param {string} key */
-	rename(key, force = false) {
+	/**
+	 * 修改参数名
+	 * @param {string} key 新参数名
+	 * @param {boolean} force 是否无视冲突命名
+	 * @throws `Error` 仅用于模板参数
+	 * @throws `SyntaxError` 非法的模板参数名
+	 * @throws `RangeError` 更名造成重复参数
+	 */
+	rename(key, force) {
 		if (typeof key !== 'string') {
 			this.typeError('rename', 'String');
 		}
@@ -138,8 +168,7 @@ class ParameterToken extends fixedToken(Token) {
 			throw new SyntaxError(`非法的模板参数名：${key}`);
 		}
 		const {lastElementChild} = firstElementChild,
-			{name} = lastElementChild,
-			keyToken = lastElementChild.firstChild;
+			{name, firstChild} = lastElementChild;
 		if (this.name === name) {
 			Parser.warn('未改变实际参数名', name);
 		} else if (parentNode.hasArg(name)) {
@@ -149,10 +178,8 @@ class ParameterToken extends fixedToken(Token) {
 				throw new RangeError(`参数更名造成重复参数：${name}`);
 			}
 		}
-		root.destroy();
-		firstElementChild.destroy();
-		lastElementChild.destroy();
-		this.firstElementChild.safeReplaceWith(keyToken);
+		lastElementChild.destroy(true);
+		this.firstElementChild.safeReplaceWith(firstChild);
 	}
 }
 

package/src/syntax.js

@@ -2,30 +2,36 @@
 
 const {undo} = require('../util/debug'),
 	{text} = require('../util/string'),
-	/** @type {Parser} */ Parser = require('..'),
+	Parser = require('..'),
 	Token = require('.');
 
 /**
  * 满足特定语法格式的plain Token
- * @classdesc `{childNodes: (string|Token)[]}`
+ * @classdesc `{childNodes: (AstText|Token)[]}`
  */
 class SyntaxToken extends Token {
 	#pattern;
 
 	/**
-	 * @param {?string} wikitext
-	 * @param {RegExp} pattern
+	 * @param {string} wikitext 语法wikitext
+	 * @param {RegExp} pattern 语法正则
+	 * @param {string} type Token.type
 	 * @param {accum} accum
-	 * @param {acceptable} acceptable
+	 * @param {acceptable} acceptable 可接受的子节点设置
+	 * @throws `RangeError` 含有g修饰符的语法正则
 	 */
 	constructor(wikitext, pattern, type = 'plain', config = Parser.getConfig(), accum = [], acceptable = null) {
+		if (pattern.global) {
+			throw new RangeError(`SyntaxToken 的语法正则不能含有 g 修饰符：${pattern}`);
+		}
 		super(wikitext, config, true, accum, acceptable);
 		this.type = type;
 		this.#pattern = pattern;
 	}
 
+	/** @override */
 	cloneNode() {
-		const cloned = this.cloneChildren(),
+		const cloned = this.cloneChildNodes(),
 			config = this.getAttribute('config'),
 			acceptable = this.getAttribute('acceptable');
 		return Parser.run(() => {
@@ -35,33 +41,33 @@ class SyntaxToken extends Token {
 		});
 	}
 
+	/** @override */
 	afterBuild() {
-		const that = this,
-			/** @type {AstListener} */ syntaxListener = (e, data) => {
-				const pattern = that.#pattern;
-				if (!Parser.running && !pattern.test(that.text())) {
-					undo(e, data);
-					throw new Error(`不可修改 ${that.constructor.name} 的语法：/${pattern.source}/${pattern.flags}`);
-				}
-			};
+		const /** @type {AstListener} */ syntaxListener = (e, data) => {
+			const pattern = this.#pattern;
+			if (!Parser.running && !pattern.test(this.text())) {
+				undo(e, data);
+				Parser.error(`不可修改 ${this.constructor.name} 的语法！`, pattern);
+				throw new Error(`不可修改 ${this.constructor.name} 的语法！`);
+			}
+		};
 		this.addEventListener(['remove', 'insert', 'replace', 'text'], syntaxListener);
 		return this;
 	}
 
 	/**
+	 * @override
 	 * @template {string} T
-	 * @param {T} key
+	 * @param {T} key 属性键
 	 * @returns {TokenAttribute<T>}
 	 */
 	getAttribute(key) {
-		if (key === 'pattern') {
-			return this.#pattern;
-		}
-		return super.getAttribute(key);
+		return key === 'pattern' ? this.#pattern : super.getAttribute(key);
 	}
 
 	/**
-	 * @param {...string|Token} elements
+	 * @override
+	 * @param {...Token} elements 待替换的子节点
 	 * @complexity `n`
 	 */
 	replaceChildren(...elements) {