wikiparser-node 0.3.1 → 0.5.0

package/src/nowiki/dd.js

@@ -1,41 +1,56 @@
 'use strict';
 
-const /** @type {Parser} */ Parser = require('../..'),
+const Parser = require('../..'),
 	NowikiToken = require('.');
 
 /**
  * :
- * @classdesc `{childNodes: [string]}`
+ * @classdesc `{childNodes: [AstText]}`
  */
 class DdToken extends NowikiToken {
 	type = 'dd';
-	dt = false;
-	ul = false;
-	ol = false;
-	indent = 0;
-
-	/** @param {string} str */
-	#update(str) {
-		this.setAttribute('ul', str.includes('*')).setAttribute('ol', str.includes('#'))
-			.setAttribute('dt', str.includes(';')).setAttribute('indent', str.split(':').length - 1);
+
+	/** 是否包含<dt> */
+	get dt() {
+		return String(this).includes(';');
 	}
 
-	/**
-	 * @param {string} str
-	 * @param {accum} accum
-	 */
-	constructor(str, config = Parser.getConfig(), accum = []) {
-		super(str, config, accum);
-		this.seal(['dt', 'ul', 'ol', 'indent']).#update(str);
+	/** 是否包含<ul> */
+	get ul() {
+		return String(this).includes('*');
+	}
+
+	/** 是否包含<ol> */
+	get ol() {
+		return String(this).includes('#');
+	}
+
+	/** 缩进数 */
+	get indent() {
+		return String(this).split(':').length - 1;
+	}
+
+	set indent(indent) {
+		if (this.type === 'dd') {
+			if (typeof indent !== 'number') {
+				this.typeError('set indent', 'Number');
+			} else if (!Number.isInteger(indent) || indent < 0) {
+				throw new RangeError(`indent 应为自然数！${indent}`);
+			}
+			this.setText(':'.repeat(indent));
+		}
 	}
 
-	/** @param {string} str */
+	/**
+	 * @override
+	 * @param {string} str 新文本
+	 * @throws `RangeError` 错误的列表语法
+	 */
 	setText(str) {
 		const src = this.type === 'dd' ? ':' : ';:*#';
-		if (RegExp(`[^${src}]`).test(str)) {
-			throw new RangeError(`${this.constructor.name} 仅能包含${src.split('').map(c => `"${c}"`).join('、')}！`);
+		if (new RegExp(`[^${src}]`, 'u').test(str)) {
+			throw new RangeError(`${this.constructor.name} 仅能包含${[...src].map(c => `"${c}"`).join('、')}！`);
 		}
-		this.#update(str);
 		return super.setText(str);
 	}
 }

package/src/nowiki/doubleUnderscore.js

@@ -1,18 +1,18 @@
 'use strict';
 
 const hidden = require('../../mixin/hidden'),
-	/** @type {Parser} */ Parser = require('../..'),
+	Parser = require('../..'),
 	NowikiToken = require('.');
 
 /**
  * 状态开关
- * @classdesc `{childNodes: [string]}`
+ * @classdesc `{childNodes: [AstText]}`
  */
 class DoubleUnderscoreToken extends hidden(NowikiToken) {
 	type = 'double-underscore';
 
 	/**
-	 * @param {string} word
+	 * @param {string} word 状态开关名
 	 * @param {accum} accum
 	 */
 	constructor(word, config = Parser.getConfig(), accum = []) {
@@ -20,19 +20,33 @@ class DoubleUnderscoreToken extends hidden(NowikiToken) {
 		this.setAttribute('name', word.toLowerCase());
 	}
 
+	/** @override */
 	cloneNode() {
-		return Parser.run(() => new DoubleUnderscoreToken(this.firstChild, this.getAttribute('config')));
+		return Parser.run(() => new DoubleUnderscoreToken(String(this.firstChild), this.getAttribute('config')));
 	}
 
-	/** @this {DoubleUnderscoreToken & {firstChild: string}} */
-	toString() {
-		return `__${this.firstChild}__`;
+	/**
+	 * @override
+	 * @param {string} selector
+	 */
+	toString(selector) {
+		return selector && this.matches(selector) ? '' : `__${String(this.firstChild)}__`;
 	}
 
+	/** @override */
 	getPadding() {
 		return 2;
 	}
 
+	/** @override */
+	print() {
+		return super.print({pre: '__', post: '__'});
+	}
+
+	/**
+	 * @override
+	 * @throws `Error` 禁止修改
+	 */
 	setText() {
 		throw new Error(`禁止修改 ${this.constructor.name}！`);
 	}

package/src/nowiki/hr.js

@@ -1,32 +1,36 @@
 'use strict';
 
 const sol = require('../../mixin/sol'),
-	/** @type {Parser} */ Parser = require('../..'),
+	Parser = require('../..'),
 	NowikiToken = require('.');
 
 /**
  * `<hr>`
- * @classdesc `{childNodes: [string]}`
+ * @classdesc `{childNodes: [AstText]}`
  */
 class HrToken extends sol(NowikiToken) {
 	type = 'hr';
 
 	/**
-	 * @param {number} n
+	 * @param {number} n 字符串长度
 	 * @param {accum} accum
 	 */
 	constructor(n, config = Parser.getConfig(), accum = []) {
 		super('-'.repeat(n), config, accum);
 	}
 
-	/** @this {HrToken & {firstChild: string}} */
+	/** @override */
 	cloneNode() {
-		return Parser.run(() => new HrToken(this.firstChild.length, this.getAttribute('config')));
+		return Parser.run(() => new HrToken(String(this).length, this.getAttribute('config')));
 	}
 
-	/** @param {string} str */
+	/**
+	 * @override
+	 * @param {string} str 新文本
+	 * @throws `RangeError` 错误的\<hr\>语法
+	 */
 	setText(str) {
-		if (!/^-{4,}$/.test(str)) {
+		if (str.length < 4 || /[^-]/u.test(str)) {
 			throw new RangeError('<hr>总是写作不少于4个的连续"-"！');
 		}
 		return super.setText(str);

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,19 @@
 'use strict';
 
-const /** @type {Parser} */ Parser = require('../..'),
+const {generateForSelf} = require('../../util/lint'),
+	Parser = require('../..'),
+	AstText = require('../../lib/text'),
 	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 +21,41 @@ class QuoteToken extends NowikiToken {
 		this.setAttribute('name', String(n));
 	}
 
-	/** @param {string} str */
+	/**
+	 * @override
+	 * @this {AstText}
+	 * @param {number} start 起始位置
+	 */
+	lint(start = 0) {
+		const {previousSibling, nextSibling} = this,
+			message = `孤立的"'"`,
+			/** @type {LintError[]} */ errors = [];
+		let /** @type {LintError} */ refError;
+		if (previousSibling?.type === 'text' && previousSibling.data.at(-1) === "'") {
+			refError = generateForSelf(this, this.getRootNode().posFromIndex(start), '');
+			const {startLine, startCol} = refError,
+				[{length}] = previousSibling.data.match(/(?<!')'+$/u);
+			errors.push({message, startLine, startCol: startCol - length, endLine: startLine, endCol: startCol});
+		}
+		if (nextSibling?.type === 'text' && nextSibling.data[0] === "'") {
+			refError ||= generateForSelf(this, this.getRootNode().posFromIndex(start), '');
+			const {endLine, endCol} = refError,
+				[{length}] = nextSibling.data.match(/^'+/u);
+			errors.push({message, startLine: endLine, startCol: endCol, endLine, endCol: endCol + length});
+		}
+		return errors;
+	}
+
+	/**
+	 * @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,57 @@
 '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 */
+	print() {
+		return super.print({pre: '&lt;onlyinclude&gt;', post: '&lt;/onlyinclude&gt;'});
+	}
+
+	/** @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.firstChild.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,20 +42,22 @@ 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);
-			token.firstElementChild.safeReplaceWith(key);
-			token.lastElementChild.safeReplaceWith(value);
+			token.firstChild.safeReplaceWith(key);
+			token.lastChild.safeReplaceWith(value);
 			return token.afterBuild();
 		});
 	}
 
+	/** @override */
 	afterBuild() {
 		if (!this.anon) {
-			const name = this.firstElementChild.text().trim(),
+			const name = this.firstChild.text().trim(),
 				{parentNode} = this;
 			this.setAttribute('name', name);
 			if (parentNode && parentNode instanceof require('./transclude')) {
@@ -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;
-				if (prevTarget === firstElementChild) {
-					const newKey = firstElementChild.text().trim();
-					data.oldKey = that.name;
+		const /** @type {AstListener} */ parameterListener = ({prevTarget}, data) => {
+			if (!this.anon) { // 匿名参数不管怎么变动还是匿名
+				const {firstChild, name} = this;
+				if (prevTarget === firstChild) {
+					const newKey = firstChild.text().trim();
+					data.oldKey = name;
 					data.newKey = newKey;
-					that.setAttribute('name', newKey);
+					this.setAttribute('name', newKey);
 				}
 			}
 		};
@@ -71,22 +80,38 @@ 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.lastChild.toString(selector)
+			: super.toString(selector, '=');
 	}
 
+	/** @override */
 	getGaps() {
 		return this.anon ? 0 : 1;
 	}
 
-	/** @returns {string} */
+	/** @override */
+	print() {
+		return super.print({sep: this.anon ? '' : '='});
+	}
+
+	/**
+	 * @override
+	 * @returns {string}
+	 */
 	text() {
-		return this.anon ? this.lastElementChild.text() : super.text('=');
+		return this.anon ? this.lastChild.text() : super.text('=');
 	}
 
 	/**
-	 * @param {ParameterToken} token
+	 * @override
+	 * @param {ParameterToken} token 待替换的节点
 	 * @complexity `n`
 	 */
 	safeReplaceWith(token) {
@@ -94,65 +119,80 @@ class ParameterToken extends fixedToken(Token) {
 		return this.replaceWith(token);
 	}
 
+	/**
+	 * 获取参数值
+	 * @this {ParameterToken & {parentNode: TranscludeToken}}
+	 */
 	getValue() {
-		const value = this.lastElementChild.text();
-		return this.anon && this.parentNode?.matches('template, magic-word#invoke') ? value : value.trim();
+		const TranscludeToken = require('./transclude');
+		const value = this.lastChild.text();
+		return this.anon && this.parentNode?.isTemplate() ? value : value.trim();
 	}
 
-	/** @param {string} value */
+	/**
+	 * 设置参数值
+	 * @this {ParameterToken & {parentNode: TranscludeToken}}
+	 * @param {string} value 参数值
+	 * @throws `SyntaxError` 非法的模板参数
+	 */
 	setValue(value) {
 		value = String(value);
-		const templateLike = this.parentElement?.matches('template, magic-word#invoke'),
+		const TranscludeToken = require('./transclude');
+		const templateLike = this.parentNode?.isTemplate(),
 			wikitext = `{{${templateLike ? ':T|' : 'lc:'}${this.anon ? '' : '1='}${value}}}`,
 			root = Parser.parse(wikitext, this.getAttribute('include'), 2, this.getAttribute('config')),
-			{childNodes: {length}, firstElementChild} = root,
-			/** @type {ParameterToken} */ lastElementChild = firstElementChild?.lastElementChild;
-		if (length !== 1 || !firstElementChild?.matches(templateLike ? 'template#T' : 'magic-word#lc')
-			|| firstElementChild.childNodes.length !== 2
-			|| lastElementChild.anon !== this.anon || lastElementChild.name !== '1'
+			{childNodes: {length}, firstChild: transclude} = root,
+			/** @type {Token & {lastChild: ParameterToken}} */
+			{lastChild: parameter, type, name, childNodes: {length: transcludeLength}} = transclude,
+			targetType = templateLike ? 'template' : 'magic-word',
+			targetName = templateLike ? 'T' : 'lc';
+		if (length !== 1 || type !== targetType || name !== targetName || transcludeLength !== 2
+			|| parameter.anon !== this.anon || parameter.name !== '1'
 		) {
 			throw new SyntaxError(`非法的模板参数：${noWrap(value)}`);
 		}
-		const newValue = lastElementChild.lastChild;
-		root.destroy();
-		firstElementChild.destroy();
-		lastElementChild.destroy();
-		this.lastElementChild.safeReplaceWith(newValue);
+		const {lastChild} = parameter;
+		parameter.destroy(true);
+		this.lastChild.safeReplaceWith(lastChild);
 	}
 
-	/** @param {string} key */
-	rename(key, force = false) {
+	/**
+	 * 修改参数名
+	 * @this {ParameterToken & {parentNode: TranscludeToken}}
+	 * @param {string} key 新参数名
+	 * @param {boolean} force 是否无视冲突命名
+	 * @throws `Error` 仅用于模板参数
+	 * @throws `SyntaxError` 非法的模板参数名
+	 * @throws `RangeError` 更名造成重复参数
+	 */
+	rename(key, force) {
 		if (typeof key !== 'string') {
 			this.typeError('rename', 'String');
 		}
+		const TranscludeToken = require('./transclude');
 		const {parentNode} = this;
 		// 必须检测是否是TranscludeToken
-		if (!parentNode || !parentNode.matches('template, magic-word#invoke')
-			|| !(parentNode instanceof require('./transclude'))
-		) {
+		if (!parentNode?.isTemplate() || !(parentNode instanceof require('./transclude'))) {
 			throw new Error(`${this.constructor.name}.rename 方法仅用于模板参数！`);
 		}
 		const root = Parser.parse(`{{:T|${key}=}}`, this.getAttribute('include'), 2, this.getAttribute('config')),
-			{childNodes: {length}, firstElementChild} = root;
-		if (length !== 1 || !firstElementChild?.matches('template#T') || firstElementChild.childNodes.length !== 2) {
+			{childNodes: {length}, firstChild: template} = root,
+			{type, name, lastChild: parameter, childNodes: {length: templateLength}} = template;
+		if (length !== 1 || type !== 'template' || name !== 'T' || templateLength !== 2) {
 			throw new SyntaxError(`非法的模板参数名：${key}`);
 		}
-		const {lastElementChild} = firstElementChild,
-			{name} = lastElementChild,
-			keyToken = lastElementChild.firstChild;
-		if (this.name === name) {
-			Parser.warn('未改变实际参数名', name);
-		} else if (parentNode.hasArg(name)) {
+		const {name: parameterName, firstChild} = parameter;
+		if (this.name === parameterName) {
+			Parser.warn('未改变实际参数名', parameterName);
+		} else if (parentNode.hasArg(parameterName)) {
 			if (force) {
-				Parser.warn('参数更名造成重复参数', name);
+				Parser.warn('参数更名造成重复参数', parameterName);
 			} else {
-				throw new RangeError(`参数更名造成重复参数：${name}`);
+				throw new RangeError(`参数更名造成重复参数：${parameterName}`);
 			}
 		}
-		root.destroy();
-		firstElementChild.destroy();
-		lastElementChild.destroy();
-		this.firstElementChild.safeReplaceWith(keyToken);
+		parameter.destroy(true);
+		this.firstChild.safeReplaceWith(firstChild);
 	}
 }