wikiparser-node 0.4.0 → 0.6.1

package/src/arg.js

@@ -1,16 +1,22 @@
 'use strict';
 
 const {text, noWrap} = require('../util/string'),
+	{generateForChild} = require('../util/lint'),
 	Parser = require('..'),
 	Token = require('.');
 
 /**
  * `{{{}}}`包裹的参数
- * @classdesc `{childNodes: [AtomToken, Token, ...HiddenToken]}`
+ * @classdesc `{childNodes: [AtomToken, ?Token, ...HiddenToken]}`
  */
 class ArgToken extends Token {
 	type = 'arg';
 
+	/** default */
+	get default() {
+		return this.childNodes[1]?.text() ?? false;
+	}
+
 	/**
 	 * @param {string[]} parts 以'|'分隔的各部分
 	 * @param {accum} accum
@@ -20,26 +26,67 @@ class ArgToken extends Token {
 		super(undefined, config, true, accum, {AtomToken: 0, Token: 1, HiddenToken: '2:'});
 		for (let i = 0; i < parts.length; i++) {
 			if (i === 0 || i > 1) {
-				const AtomToken = i === 0 ? require('./atom') : require('./atom/hidden'),
-					token = new AtomToken(parts[i], i === 0 ? 'arg-name' : undefined, config, accum, {
-						'Stage-2': ':', '!HeadingToken': '',
-					});
-				this.appendChild(token);
+				const AtomToken = i === 0 ? require('./atom') : require('./atom/hidden');
+				const token = new AtomToken(parts[i], i === 0 ? 'arg-name' : undefined, config, accum, {
+					'Stage-2': ':', '!HeadingToken': '',
+				});
+				super.insertAt(token);
 			} else {
 				const token = new Token(parts[i], config, true, accum);
 				token.type = 'arg-default';
-				this.appendChild(token.setAttribute('stage', 2));
+				super.insertAt(token.setAttribute('stage', 2));
 			}
 		}
 		this.getAttribute('protectChildren')(0);
 	}
 
+	/**
+	 * @override
+	 * @param {string} selector
+	 */
+	toString(selector) {
+		return selector && this.matches(selector) ? '' : `{{{${super.toString(selector, '|')}}}}`;
+	}
+
+	/** @override */
+	getPadding() {
+		return 3;
+	}
+
+	/** @override */
+	getGaps() {
+		return 1;
+	}
+
+	/** @override */
+	print() {
+		return super.print({pre: '{{{', post: '}}}', sep: '|'});
+	}
+
+	/**
+	 * @override
+	 * @param {number} start 起始位置
+	 * @returns {LintError[]}
+	 */
+	lint(start = 0) {
+		const {childNodes: [argName, argDefault, ...rest]} = this,
+			errors = argName.lint(start + 3);
+		if (argDefault) {
+			errors.push(...argDefault.lint(start + 4 + String(argName).length));
+		}
+		if (rest.length > 0) {
+			const rect = this.getRootNode().posFromIndex(start);
+			errors.push(...rest.map(child => generateForChild(child, rect, '三重括号内的不可见部分')));
+		}
+		return errors;
+	}
+
 	/** @override */
 	cloneNode() {
 		const [name, ...cloned] = this.cloneChildNodes();
 		return Parser.run(() => {
 			const token = new ArgToken([''], this.getAttribute('config'));
-			token.firstElementChild.safeReplaceWith(name);
+			token.firstChild.safeReplaceWith(name);
 			token.append(...cloned);
 			return token.afterBuild();
 		});
@@ -47,9 +94,9 @@ class ArgToken extends Token {
 
 	/** @override */
 	afterBuild() {
-		this.setAttribute('name', this.firstElementChild.text().trim());
+		this.setAttribute('name', this.firstChild.text().trim());
 		const /** @type {AstListener} */ argListener = ({prevTarget}) => {
-			if (prevTarget === this.firstElementChild) {
+			if (prevTarget === this.firstChild) {
 				this.setAttribute('name', prevTarget.text().trim());
 			}
 		};
@@ -57,30 +104,12 @@ class ArgToken extends Token {
 		return this;
 	}
 
-	/**
-	 * @override
-	 * @param {string} selector
-	 */
-	toString(selector) {
-		return selector && this.matches(selector) ? '' : `{{{${super.toString(selector, '|')}}}}`;
-	}
-
-	/** @override */
-	getPadding() {
-		return 3;
-	}
-
-	/** @override */
-	getGaps() {
-		return 1;
-	}
-
 	/**
 	 * @override
 	 * @returns {string}
 	 */
 	text() {
-		return `{{{${text(this.children.slice(0, 2), '|')}}}}`;
+		return `{{{${text(this.childNodes.slice(0, 2), '|')}}}}`;
 	}
 
 	/**
@@ -115,7 +144,7 @@ class ArgToken extends Token {
 	 */
 	insertAt(token, i = this.childNodes.length) {
 		const j = i < 0 ? i + this.childNodes.length : i;
-		if (j > 1 && !Parser.running) {
+		if (j > 1) {
 			throw new RangeError(`${this.constructor.name} 不可插入多余的子节点！`);
 		}
 		super.insertAt(token, i);
@@ -133,13 +162,13 @@ class ArgToken extends Token {
 	setName(name) {
 		name = String(name);
 		const root = Parser.parse(`{{{${name}}}}`, this.getAttribute('include'), 2, this.getAttribute('config')),
-			{childNodes: {length}, firstElementChild} = root;
-		if (length !== 1 || firstElementChild?.type !== 'arg' || firstElementChild.childNodes.length !== 1) {
+			{length, firstChild: arg} = root;
+		if (length !== 1 || arg.type !== 'arg' || arg.childNodes.length !== 1) {
 			throw new SyntaxError(`非法的参数名称：${noWrap(name)}`);
 		}
-		const {firstElementChild: newName} = firstElementChild;
-		firstElementChild.destroy(true);
-		this.firstElementChild.safeReplaceWith(newName);
+		const {firstChild} = arg;
+		arg.destroy(true);
+		this.firstChild.safeReplaceWith(firstChild);
 	}
 
 	/**
@@ -150,17 +179,17 @@ class ArgToken extends Token {
 	setDefault(value) {
 		value = String(value);
 		const root = Parser.parse(`{{{|${value}}}}`, this.getAttribute('include'), 2, this.getAttribute('config')),
-			{childNodes: {length}, firstElementChild} = root;
-		if (length !== 1 || firstElementChild?.type !== 'arg' || firstElementChild.childNodes.length !== 2) {
+			{length, firstChild: arg} = root;
+		if (length !== 1 || arg.type !== 'arg' || arg.childNodes.length !== 2) {
 			throw new SyntaxError(`非法的参数预设值：${noWrap(value)}`);
 		}
-		const {children: [, oldDefault]} = this,
-			{lastElementChild} = firstElementChild;
-		firstElementChild.destroy(true);
+		const {childNodes: [, oldDefault]} = this,
+			{lastChild} = arg;
+		arg.destroy(true);
 		if (oldDefault) {
-			oldDefault.safeReplaceWith(lastElementChild);
+			oldDefault.safeReplaceWith(lastChild);
 		} else {
-			this.appendChild(lastElementChild);
+			this.insertAt(lastChild);
 		}
 	}
 }

package/src/atom/index.js

@@ -5,7 +5,7 @@ const Parser = require('../..'),
 
 /**
  * 不会被继续解析的plain Token
- * @classdesc `{childNodes: (AstText|Token)[]}`
+ * @classdesc `{childNodes: ...AstText|Token}`
  */
 class AtomToken extends Token {
 	type = 'plain';
@@ -30,10 +30,12 @@ class AtomToken extends Token {
 	cloneNode() {
 		const cloned = this.cloneChildNodes(),
 			config = this.getAttribute('config'),
-			acceptable = this.getAttribute('acceptable'),
-			token = Parser.run(() => new this.constructor(undefined, this.type, config, [], acceptable));
-		token.append(...cloned);
-		return token;
+			acceptable = this.getAttribute('acceptable');
+		return Parser.run(() => {
+			const token = new this.constructor(undefined, this.type, config, [], acceptable);
+			token.append(...cloned);
+			return token;
+		});
 	}
 }
 

package/src/attribute.js

@@ -1,6 +1,7 @@
 'use strict';
 
 const {externalUse} = require('../util/debug'),
+	{generateForSelf} = require('../util/lint'),
 	{toCase, removeComment, normalizeSpace} = require('../util/string'),
 	Parser = require('..'),
 	Token = require('.');
@@ -14,6 +15,7 @@ const stages = {'ext-attr': 0, 'html-attr': 2, 'table-attr': 3};
 class AttributeToken extends Token {
 	/** @type {Map<string, string|true>} */ #attr = new Map();
 	#sanitized = true;
+	#quoteBalance = true;
 
 	/**
 	 * @override
@@ -82,17 +84,26 @@ class AttributeToken extends Token {
 		this.setAttr('id', id);
 	}
 
+	/** #sanitized */
+	get sanitized() {
+		return this.#sanitized;
+	}
+
+	/** #quoteBalance */
+	get quoteBalance() {
+		return this.#quoteBalance;
+	}
+
 	/**
 	 * 从`this.#attr`更新`childNodes`
 	 * @complexity `n`
 	 */
 	#updateFromAttr() {
 		let equal = '=';
-		const ParameterToken = require('./parameter');
-		const parent = this.closest('ext, parameter');
-		if (parent instanceof ParameterToken && parent.anon
-			&& parent.parentNode?.matches('template, magic-word#invoke')
-		) {
+		const ParameterToken = require('./parameter'),
+			TranscludeToken = require('./transclude');
+		const /** @type {ParameterToken & {parentNode: TranscludeToken}} */ parent = this.closest('ext, parameter');
+		if (parent instanceof ParameterToken && parent.anon && parent.parentNode?.isTemplate()) {
 			equal = '{{=}}';
 		}
 		return [...this.#attr].map(([k, v]) => {
@@ -117,6 +128,7 @@ class AttributeToken extends Token {
 			this.replaceChildren(...token.childNodes, true);
 		});
 		this.#sanitized = true;
+		this.#quoteBalance = true;
 	}
 
 	/**
@@ -146,11 +158,13 @@ class AttributeToken extends Token {
 		 */
 		const build = str =>
 			typeof str === 'boolean' || !token ? str : token.getAttribute('buildFromStr')(str).map(String).join('');
-		for (const [, key,, quoted, unquoted] of string
-			.matchAll(/([^\s/][^\s/=]*)(?:\s*=\s*(?:(["'])(.*?)(?:\2|$)|(\S*)))?/gsu)
+		for (const [, key, quoteStart, quoted, quoteEnd, unquoted] of string
+			.matchAll(/([^\s/][^\s/=]*)(?:\s*=\s*(?:(["'])(.*?)(\2|$)|(\S*)))?/gsu)
 		) {
 			if (!this.setAttr(build(key), build(quoted ?? unquoted ?? true), true)) {
 				this.#sanitized = false;
+			} else if (quoteStart !== quoteEnd) {
+				this.#quoteBalance = false;
 			}
 		}
 	}
@@ -164,7 +178,87 @@ class AttributeToken extends Token {
 	constructor(attr, type, name, config = Parser.getConfig(), accum = []) {
 		super(attr, config, true, accum, {[`Stage-${stages[type]}`]: ':'});
 		this.type = type;
-		this.setAttribute('name', name).#parseAttr();
+		this.#parseAttr();
+		this.setAttribute('name', name);
+	}
+
+	/**
+	 * 获取标签属性
+	 * @template {string|undefined} T
+	 * @param {T} key 属性键
+	 * @returns {T extends string ? string|true : Record<string, string|true>}
+	 */
+	getAttr(key) {
+		if (key === undefined) {
+			return Object.fromEntries(this.#attr);
+		}
+		return typeof key === 'string' ? this.#attr.get(key.toLowerCase().trim()) : this.typeError('getAttr', 'String');
+	}
+
+	/**
+	 * 设置标签属性
+	 * @param {string} key 属性键
+	 * @param {string|boolean} value 属性值
+	 * @param {boolean} init 是否是初次解析
+	 * @complexity `n`
+	 * @throws `RangeError` 扩展标签属性不能包含">"
+	 * @throws `RangeError` 无效的属性名
+	 */
+	setAttr(key, value, init) {
+		init &&= !externalUse('setAttr');
+		if (typeof key !== 'string' || typeof value !== 'string' && typeof value !== 'boolean') {
+			this.typeError('setAttr', 'String', 'Boolean');
+		} else if (!init && this.type === 'ext-attr' && typeof value === 'string' && value.includes('>')) {
+			throw new RangeError('扩展标签属性不能包含 ">"！');
+		}
+		key = key.toLowerCase().trim();
+		const config = this.getAttribute('config'),
+			include = this.getAttribute('include'),
+			parsedKey = this.type === 'ext-attr' || init
+				? key
+				: Parser.run(() => {
+					const token = new Token(key, config),
+						parseOnce = token.getAttribute('parseOnce');
+					parseOnce(0, include);
+					return String(parseOnce());
+				});
+		if (!/^(?:[\w:]|\0\d+[t!~{}+-]\x7F)(?:[\w:.-]|\0\d+[t!~{}+-]\x7F)*$/u.test(parsedKey)) {
+			if (init) {
+				return false;
+			}
+			throw new RangeError(`无效的属性名：${key}！`);
+		} else if (value === false) {
+			this.#attr.delete(key);
+		} else {
+			this.#attr.set(key, value === true ? true : value.replaceAll(/\s/gu, ' ').trim());
+		}
+		if (!init) {
+			this.sanitize();
+		}
+		return true;
+	}
+
+	/**
+	 * @override
+	 * @this {AttributeToken & {parentNode: HtmlToken}}
+	 * @param {number} start 起始位置
+	 */
+	lint(start = 0) {
+		const HtmlToken = require('./html');
+		const errors = super.lint(start);
+		let /** @type {{top: number, left: number}} */ rect;
+		if (this.type === 'html-attr' && this.parentNode.closing && this.text().trim()) {
+			rect = this.getRootNode().posFromIndex(start);
+			errors.push(generateForSelf(this, rect, '位于闭合标签的属性'));
+		}
+		if (!this.#sanitized) {
+			rect ||= this.getRootNode().posFromIndex(start);
+			errors.push(generateForSelf(this, rect, '包含无效属性'));
+		} else if (!this.#quoteBalance) {
+			rect ||= this.getRootNode().posFromIndex(start);
+			errors.push(generateForSelf(this, rect, '未闭合的引号', 'warning'));
+		}
+		return errors;
 	}
 
 	/** @override */
@@ -227,19 +321,6 @@ class AttributeToken extends Token {
 		return typeof key === 'string' ? this.#attr.has(key.toLowerCase().trim()) : this.typeError('hasAttr', 'String');
 	}
 
-	/**
-	 * 获取标签属性
-	 * @template {string|undefined} T
-	 * @param {T} key 属性键
-	 * @returns {T extends string ? string|true : Record<string, string|true>}
-	 */
-	getAttr(key) {
-		if (key === undefined) {
-			return Object.fromEntries(this.#attr);
-		}
-		return typeof key === 'string' ? this.#attr.get(key.toLowerCase().trim()) : this.typeError('getAttr', 'String');
-	}
-
 	/** 获取全部的标签属性名 */
 	getAttrNames() {
 		return [...this.#attr.keys()];
@@ -250,49 +331,6 @@ class AttributeToken extends Token {
 		return this.getAttrNames().length > 0;
 	}
 
-	/**
-	 * 设置标签属性
-	 * @param {string} key 属性键
-	 * @param {string|boolean} value 属性值
-	 * @param {boolean} init 是否是初次解析
-	 * @complexity `n`
-	 * @throws `RangeError` 扩展标签属性不能包含">"
-	 * @throws `RangeError` 无效的属性名
-	 */
-	setAttr(key, value, init) {
-		init &&= !externalUse('setAttr');
-		if (typeof key !== 'string' || typeof value !== 'string' && typeof value !== 'boolean') {
-			this.typeError('setAttr', 'String', 'Boolean');
-		} else if (!init && this.type === 'ext-attr' && typeof value === 'string' && value.includes('>')) {
-			throw new RangeError('扩展标签属性不能包含 ">"！');
-		}
-		key = key.toLowerCase().trim();
-		const config = this.getAttribute('config'),
-			include = this.getAttribute('include'),
-			parsedKey = this.type === 'ext-attr' || init
-				? key
-				: Parser.run(() => {
-					const token = new Token(key, config),
-						parseOnce = token.getAttribute('parseOnce');
-					parseOnce(0, include);
-					return String(parseOnce());
-				});
-		if (!/^(?:[\w:]|\0\d+[t!~{}+-]\x7F)(?:[\w:.-]|\0\d+[t!~{}+-]\x7F)*$/u.test(parsedKey)) {
-			if (init) {
-				return false;
-			}
-			throw new RangeError(`无效的属性名：${key}！`);
-		} else if (value === false) {
-			this.#attr.delete(key);
-		} else {
-			this.#attr.set(key, value === true ? true : value.replaceAll(/\s/gu, ' ').trim());
-		}
-		if (!init) {
-			this.sanitize();
-		}
-		return true;
-	}
-
 	/**
 	 * 移除标签属性
 	 * @param {string} key 属性键

package/src/charinsert.js

@@ -0,0 +1,91 @@
+'use strict';
+
+const Parser = require('..'),
+	Token = require('.'),
+	HasNowikiToken = require('./hasNowiki');
+
+/**
+ * `<charinsert>`
+ * @classdesc `{childNodes: [...HasNowikiToken]}`
+ */
+class CharinsertToken extends Token {
+	type = 'ext-inner';
+	name = 'charinsert';
+
+	/**
+	 * @param {string} wikitext wikitext
+	 * @param {accum} accum
+	 */
+	constructor(wikitext, config = Parser.getConfig(), accum = []) {
+		super(undefined, config, true, accum, {HasNowikiToken: ':'});
+		this.append(...wikitext.split('\n').map(str => new HasNowikiToken(str, 'charinsert-line', config, accum)));
+	}
+
+	/**
+	 * @override
+	 * @param {string} selector
+	 */
+	toString(selector) {
+		return super.toString(selector, '\n');
+	}
+
+	/** @override */
+	getGaps() {
+		return 1;
+	}
+
+	/** @override */
+	print() {
+		return super.print({sep: '\n'});
+	}
+
+	/** @override */
+	cloneNode() {
+		const cloned = this.cloneChildNodes();
+		return Parser.run(() => {
+			const token = new CharinsertToken(undefined, this.getAttribute('config'));
+			token.append(...cloned);
+			return token;
+		});
+	}
+
+	/**
+	 * 获取某一行的插入选项
+	 * @param {number|HasNowikiToken} child 行号或子节点
+	 */
+	getLineItems(child) {
+		if (Number.isInteger(child)) {
+			child = this.childNodes.at(child);
+		}
+		if (!(child instanceof HasNowikiToken)) {
+			this.typeError('getLineItems', 'Number', 'HasNowikiToken');
+		}
+		const entities = {'\t': '&#9;', '\r': '&#12;', ' ': '&#32;'};
+		return String(child).replaceAll(
+			/<nowiki>(.+?)<\/nowiki>/giu,
+			/** @type {function(...string): string} */ (_, inner) => inner.replaceAll(/[\t\r ]/gu, s => entities[s]),
+		).split(/\s/u).filter(Boolean)
+			.map(item => {
+				const parts = item.split('+');
+				if (parts.length === 1) {
+					return parts[0];
+				}
+				return parts[0] ? parts.slice(0, 2) : '+';
+			});
+	}
+
+	/** 获取所有插入选项 */
+	getAllItems() {
+		return this.childNodes.flatMap(child => this.getLineItems(child));
+	}
+
+	/** @override */
+	text() {
+		return this.childNodes.map(
+			child => this.getLineItems(child).map(str => Array.isArray(str) ? str.join('+') : str).join(' '),
+		).join('\n');
+	}
+}
+
+Parser.classes.CharinsertToken = __filename;
+module.exports = CharinsertToken;

package/src/converter.js

@@ -1,6 +1,6 @@
 'use strict';
 
-const {text} = require('../util/string'),
+const {text, print} = require('../util/string'),
 	Parser = require('..'),
 	Token = require('.'),
 	ConverterFlagsToken = require('./converterFlags'),
@@ -21,6 +21,11 @@ class ConverterToken extends Token {
 		return this.hasFlag('R') || this.childNodes.length === 2 && !this.lastChild.variant;
 	}
 
+	/** flags */
+	get flags() {
+		return this.getAllFlags();
+	}
+
 	/**
 	 * @param {string[]} flags 转换类型标记
 	 * @param {string[]} rules 转换规则
@@ -33,7 +38,7 @@ class ConverterToken extends Token {
 			hasColon = firstRule.includes(':'),
 			firstRuleToken = new ConverterRuleToken(firstRule, hasColon, config, accum);
 		if (hasColon && firstRuleToken.childNodes.length === 1) {
-			this.appendChild(new ConverterRuleToken(rules.join(';'), false, config, accum));
+			this.insertAt(new ConverterRuleToken(rules.join(';'), false, config, accum));
 		} else {
 			this.append(
 				firstRuleToken,
@@ -43,21 +48,13 @@ class ConverterToken extends Token {
 		this.getAttribute('protectChildren')(0);
 	}
 
-	/** @override */
-	cloneNode() {
-		const [flags, ...rules] = this.cloneChildNodes(),
-			token = Parser.run(() => new ConverterToken([], [], this.getAttribute('config')));
-		token.firstElementChild.safeReplaceWith(flags);
-		token.append(...rules);
-		return token;
-	}
-
 	/**
 	 * @override
 	 * @param {string} selector
+	 * @returns {string}
 	 */
 	toString(selector) {
-		const {children: [flags, ...rules]} = this;
+		const {childNodes: [flags, ...rules]} = this;
 		return selector && this.matches(selector)
 			? ''
 			: `-{${flags.toString(selector)}${flags.childNodes.length > 0 ? '|' : ''}${rules.map(String).join(';')}}-`;
@@ -69,17 +66,39 @@ class ConverterToken extends Token {
 	}
 
 	/**
-	 * /** @override
+	 * @override
 	 * @param {number} i 子节点位置
 	 */
 	getGaps(i = 0) {
 		i = i < 0 ? i + this.childNodes.length : i;
-		return i || this.firstElementChild.childNodes.length > 0 ? 1 : 0;
+		return i || this.firstChild.childNodes.length > 0 ? 1 : 0;
 	}
 
 	/** @override */
-	text() {
+	print() {
 		const {children: [flags, ...rules]} = this;
+		return `<span class="wpb-converter">-{${flags.print()}${
+			flags.childNodes.length > 0 ? '|' : ''
+		}${print(rules, {sep: ';'})}}-</span>`;
+	}
+
+	/** @override */
+	cloneNode() {
+		const [flags, ...rules] = this.cloneChildNodes();
+		return Parser.run(() => {
+			const token = new ConverterToken([], [], this.getAttribute('config'));
+			token.firstChild.safeReplaceWith(flags);
+			token.append(...rules);
+			return token;
+		});
+	}
+
+	/**
+	 * @override
+	 * @returns {string}
+	 */
+	text() {
+		const {childNodes: [flags, ...rules]} = this;
 		return `-{${flags.text()}|${text(rules, ';')}}-`;
 	}