wikiparser-node 0.3.1 → 0.5.0

package/src/link/category.js

@@ -1,8 +1,8 @@
 'use strict';
 
-const /** @type {Parser} */ Parser = require('../..'),
-	LinkToken = require('.'),
-	Token = require('..');
+const Title = require('../../lib/title'),
+	Parser = require('../..'),
+	LinkToken = require('.');
 
 /**
  * 分类
@@ -10,72 +10,40 @@ const /** @type {Parser} */ Parser = require('../..'),
  */
 class CategoryToken extends LinkToken {
 	type = 'category';
-	sortkey = '';
 
 	setLangLink = undefined;
 	setFragment = undefined;
 	asSelfLink = undefined;
 	pipeTrick = undefined;
 
-	/**
-	 * @param {string} link
-	 * @param {string|undefined} text
-	 * @param {Title} title
-	 * @param {accum} accum
-	 */
-	constructor(link, text, title, config = Parser.getConfig(), accum = []) {
-		super(link, text, title, config, accum);
-		this.seal(['sortkey', 'setFragment', 'asSelfLink', 'pipeTrick']);
-	}
-
-	afterBuild() {
-		super.afterBuild();
-		this.#updateSortkey();
-		const that = this;
-		const /** @type {AstListener} */ categoryListener = ({prevTarget}) => {
-			if (prevTarget?.type === 'link-text') {
-				that.#updateSortkey();
-			}
-		};
-		this.addEventListener(['remove', 'insert', 'replace', 'text'], categoryListener);
-		return this;
-	}
-
-	#updateSortkey() {
-		this.setAttribute('sortkey', this.children[1]?.text()
-			?.replace(/&#(\d+);/g, /** @param {string} p1 */ (_, p1) => String.fromCharCode(Number(p1)))
-			?.replace(/&#x([\da-f]+);/gi, /** @param {string} p1 */ (_, p1) => String.fromCharCode(parseInt(p1, 16)))
-			?.replaceAll('\n', '') ?? '',
+	/** 分类排序关键字 */
+	get sortkey() {
+		return this.childNodes[1]?.text()?.replaceAll(
+			/&#(\d+|x[\da-f]+);|\n/gu,
+			/** @param {string} p */
+			(_, p) => p ? String.fromCodePoint(p[0] === 'x' ? parseInt(p.slice(1), 16) : Number(p)) : '',
 		);
 	}
 
-	/** @param {number} i */
-	removeAt(i) {
-		if (i === 1) {
-			this.setAttribute('sortkey', '');
-		}
-		return super.removeAt(i);
+	set sortkey(text) {
+		this.setSortkey(text);
 	}
 
 	/**
-	 * @template {string|Token} T
-	 * @param {T} token
-	 * @param {number} i
+	 * @param {string} link 分类名
+	 * @param {string|undefined} text 排序关键字
+	 * @param {Title} title 分类页面标题对象
+	 * @param {accum} accum
 	 */
-	insertAt(token, i) {
-		super.insertAt(token, i);
-		if (i === 1 && !Parser.running) {
-			this.#updateSortkey();
-		}
-		return token;
-	}
-
-	/** @returns {string} */
-	text() {
-		return `[[${this.firstElementChild.text()}]]`;
+	constructor(link, text, title, config = Parser.getConfig(), accum = []) {
+		super(link, text, title, config, accum);
+		this.seal(['setFragment', 'asSelfLink', 'pipeTrick'], true);
 	}
 
-	/** @param {string} text */
+	/**
+	 * 设置排序关键字
+	 * @param {string} text 排序关键字
+	 */
 	setSortkey(text) {
 		this.setLinkText(text);
 	}

package/src/link/file.js

@@ -1,8 +1,10 @@
 'use strict';
 
-const {explode, noWrap} = require('../../util/string'),
+const Title = require('../../lib/title'),
+	{explode, noWrap} = require('../../util/string'),
 	{externalUse} = require('../../util/debug'),
-	/** @type {Parser} */ Parser = require('../..'),
+	{generateForChild} = require('../../util/lint'),
+	Parser = require('../..'),
 	LinkToken = require('.'),
 	ImageParameterToken = require('../imageParameter');
 
@@ -21,18 +23,25 @@ class FileToken extends LinkToken {
 	setLinkText = undefined;
 	pipeTrick = undefined;
 
+	/** 图片链接 */
 	get link() {
 		return this.getArg('link')?.link;
 	}
+
 	set link(value) {
 		this.setValue('link', value);
 	}
+
+	/** 图片大小 */
 	get size() {
 		return this.getArg('width')?.size;
 	}
+
+	/** 图片宽度 */
 	get width() {
 		return this.size?.width;
 	}
+
 	set width(width) {
 		const arg = this.getArg('width');
 		if (arg) {
@@ -41,9 +50,12 @@ class FileToken extends LinkToken {
 			this.setValue('width', width);
 		}
 	}
+
+	/** 图片高度 */
 	get height() {
 		return this.size?.height;
 	}
+
 	set height(height) {
 		const arg = this.getArg('width');
 		if (arg) {
@@ -54,9 +66,9 @@ class FileToken extends LinkToken {
 	}
 
 	/**
-	 * @param {string} link
-	 * @param {string|undefined} text
-	 * @param {Title} title
+	 * @param {string} link 文件名
+	 * @param {string|undefined} text 图片参数
+	 * @param {Title} title 文件标题对象
 	 * @param {accum} accum
 	 * @complexity `n`
 	 */
@@ -64,11 +76,32 @@ class FileToken extends LinkToken {
 		super(link, undefined, title, config, accum);
 		this.setAttribute('acceptable', {AtomToken: 0, ImageParameterToken: '1:'});
 		this.append(...explode('-{', '}-', '|', text).map(part => new ImageParameterToken(part, config, accum)));
-		this.seal(['setLangLink', 'setFragment', 'asSelfLink', 'setLinkText', 'pipeTrick']);
+		this.seal(['setLangLink', 'setFragment', 'asSelfLink', 'setLinkText', 'pipeTrick'], true);
+	}
+
+	/**
+	 * @override
+	 * @param {number} start 起始位置
+	 */
+	lint(start = 0) {
+		const errors = super.lint(start),
+			frameArgs = this.getFrameArgs(),
+			captions = this.getArgs('caption');
+		if (frameArgs.length > 1 || captions.size > 1) {
+			const rect = this.getRootNode().posFromIndex(start);
+			if (frameArgs.length > 1) {
+				errors.push(...frameArgs.map(arg => generateForChild(arg, rect, '重复或冲突的图片框架参数')));
+			}
+			if (captions.size > 1) {
+				errors.push(...[...captions].map(arg => generateForChild(arg, rect, '重复的图片说明')));
+			}
+		}
+		return errors;
 	}
 
 	/**
-	 * @param {number} i
+	 * @override
+	 * @param {number} i 移除位置
 	 * @complexity `n`
 	 */
 	removeAt(i) {
@@ -82,7 +115,9 @@ class FileToken extends LinkToken {
 	}
 
 	/**
-	 * @param {ImageParameterToken} token
+	 * @override
+	 * @param {ImageParameterToken} token 待插入的子节点
+	 * @param {number} i 插入位置
 	 * @complexity `n`
 	 */
 	insertAt(token, i = this.childNodes.length) {
@@ -93,12 +128,18 @@ class FileToken extends LinkToken {
 		return super.insertAt(token, i);
 	}
 
-	/** @returns {ImageParameterToken[]} */
+	/**
+	 * 获取所有图片参数节点
+	 * @returns {ImageParameterToken[]}
+	 */
 	getAllArgs() {
 		return this.childNodes.slice(1);
 	}
 
-	/** @complexity `n` */
+	/**
+	 * 获取图片框架属性参数节点
+	 * @complexity `n`
+	 */
 	getFrameArgs() {
 		const args = this.getAllArgs()
 			.filter(({name}) => ['manualthumb', 'frameless', 'framed', 'thumbnail'].includes(name));
@@ -109,15 +150,16 @@ class FileToken extends LinkToken {
 	}
 
 	/**
-	 * @param {string} key
+	 * 获取指定图片参数
+	 * @param {string} key 参数名
+	 * @param {boolean} copy 是否返回备份
 	 * @complexity `n`
 	 */
 	getArgs(key, copy = true) {
 		if (typeof key !== 'string') {
 			this.typeError('getArgs', 'String');
-		} else if (!copy && !Parser.debugging && externalUse('getArgs')) {
-			this.debugOnly('getArgs');
 		}
+		copy ||= !Parser.debugging && externalUse('getArgs');
 		let args = this.#args[key];
 		if (!args) {
 			args = new Set(this.getAllArgs().filter(({name}) => key === name));
@@ -127,7 +169,8 @@ class FileToken extends LinkToken {
 	}
 
 	/**
-	 * @param {string} key
+	 * 是否具有指定图片参数
+	 * @param {string} key 参数名
 	 * @complexity `n`
 	 */
 	hasArg(key) {
@@ -135,15 +178,17 @@ class FileToken extends LinkToken {
 	}
 
 	/**
-	 * @param {string} key
+	 * 获取生效的指定图片参数
+	 * @param {string} key 参数名
 	 * @complexity `n`
 	 */
 	getArg(key) {
-		return [...this.getArgs(key, false)].sort((a, b) => a.comparePosition(b)).at(-1);
+		return [...this.getArgs(key, false)].sort((a, b) => a.compareDocumentPosition(b)).at(-1);
 	}
 
 	/**
-	 * @param {string} key
+	 * 移除指定图片参数
+	 * @param {string} key 参数名
 	 * @complexity `n`
 	 */
 	removeArg(key) {
@@ -152,10 +197,13 @@ class FileToken extends LinkToken {
 		}
 	}
 
-	/** @complexity `n` */
+	/**
+	 * 获取图片参数名
+	 * @complexity `n`
+	 */
 	getKeys() {
 		const args = this.getAllArgs();
-		if (this.#keys.size === 0 && args.length) {
+		if (this.#keys.size === 0 && args.length > 0) {
 			for (const {name} of args) {
 				this.#keys.add(name);
 			}
@@ -164,7 +212,8 @@ class FileToken extends LinkToken {
 	}
 
 	/**
-	 * @param {string} key
+	 * 获取指定的图片参数值
+	 * @param {string} key 参数名
 	 * @complexity `n`
 	 */
 	getValues(key) {
@@ -172,22 +221,25 @@ class FileToken extends LinkToken {
 	}
 
 	/**
+	 * 获取生效的指定图片参数值
 	 * @template {string|undefined} T
-	 * @param {T} key
+	 * @param {T} key 参数名
 	 * @returns {T extends undefined ? Object<string, string> : string|true}
 	 * @complexity `n`
 	 */
 	getValue(key) {
-		if (key !== undefined) {
-			return this.getArg(key)?.getValue();
-		}
-		return Object.fromEntries(this.getKeys().map(k => [k, this.getValue(k)]));
+		return key === undefined
+			? Object.fromEntries(this.getKeys().map(k => [k, this.getValue(k)]))
+			: this.getArg(key)?.getValue();
 	}
 
 	/**
-	 * @param {string} key
-	 * @param {string|boolean} value
+	 * 设置图片参数
+	 * @param {string} key 参数名
+	 * @param {string|boolean} value 参数值
 	 * @complexity `n`
+	 * @throws `RangeError` 未定义的图片参数
+	 * @throws `SyntaxError` 非法的参数
 	 */
 	setValue(key, value) {
 		if (typeof key !== 'string') {
@@ -220,13 +272,12 @@ class FileToken extends LinkToken {
 		}
 		const wikitext = `[[File:F|${syntax ? syntax.replace('$1', value) : value}]]`,
 			root = Parser.parse(wikitext, this.getAttribute('include'), 6, config),
-			{childNodes: {length}, firstElementChild} = root;
-		if (length !== 1 || !firstElementChild?.matches('file#File:F')
-			|| firstElementChild.childNodes.length !== 2 || firstElementChild.lastElementChild.name !== key
-		) {
+			{childNodes: {length}, firstChild: file} = root,
+			{name, type, childNodes: {length: fileLength}, lastChild: imageParameter} = file;
+		if (length !== 1 || type !== 'file' || name !== 'File:F' || fileLength !== 2 || imageParameter.name !== key) {
 			throw new SyntaxError(`非法的 ${key} 参数：${noWrap(value)}`);
 		}
-		this.appendChild(firstElementChild.lastChild);
+		this.appendChild(imageParameter);
 	}
 }
 

package/src/link/galleryImage.js

@@ -1,6 +1,7 @@
 'use strict';
 
-const /** @type {Parser} */ Parser = require('../..'),
+const Title = require('../../lib/title'),
+	Parser = require('../..'),
 	Token = require('..'),
 	FileToken = require('./file');
 
@@ -16,9 +17,9 @@ class GalleryImageToken extends FileToken {
 	height = undefined;
 
 	/**
-	 * @param {string} link
-	 * @param {string|undefined} text
-	 * @param {Title} title
+	 * @param {string} link 图片文件名
+	 * @param {string|undefined} text 图片参数
+	 * @param {Title} title 图片文件标题对象
 	 * @param {accum} accum
 	 */
 	constructor(link, text, title, config = Parser.getConfig(), accum = []) {
@@ -26,21 +27,34 @@ class GalleryImageToken extends FileToken {
 		if (text !== undefined) {
 			token = new Token(text, config, true, accum);
 			token.type = 'temp';
-			token.setAttribute('stage', 1);
 			for (let n = 1; n < Parser.MAX_STAGE; n++) {
-				token.parseOnce();
+				token.getAttribute('parseOnce')();
 			}
 			accum.splice(accum.indexOf(token), 1);
 		}
 		const newConfig = structuredClone(config);
 		newConfig.img = Object.fromEntries(Object.entries(config.img).filter(([, param]) => param !== 'width'));
 		super(link, token?.toString(), title, newConfig, accum);
-		this.seal(['size', 'width', 'height']);
+		this.seal(['size', 'width', 'height'], true);
 	}
 
+	/** @override */
 	getPadding() {
 		return 0;
 	}
+
+	/**
+	 * @override
+	 * @param {string} selector
+	 */
+	toString(selector) {
+		return super.toString(selector).replaceAll('\n', ' ');
+	}
+
+	/** @override */
+	text() {
+		return super.text().replaceAll('\n', ' ');
+	}
 }
 
 Parser.classes.GalleryImageToken = __filename;