wikiparser-node 0.6.5-b → 0.7.0-m

package/src/link/file.js

@@ -0,0 +1,125 @@
+'use strict';
+
+const {explode} = require('../../util/string'),
+	{generateForChild} = require('../../util/lint'),
+	Parser = require('../..'),
+	LinkToken = require('.'),
+	ImageParameterToken = require('../imageParameter');
+
+const frame = new Set(['manualthumb', 'frameless', 'framed', 'thumbnail']),
+	horizAlign = new Set(['left', 'right', 'center', 'none']),
+	vertAlign = new Set(['baseline', 'sub', 'super', 'top', 'text-top', 'middle', 'bottom', 'text-bottom']);
+
+/**
+ * 图片
+ * @classdesc `{childNodes: [AtomToken, ...ImageParameterToken]}`
+ */
+class FileToken extends LinkToken {
+	type = 'file';
+
+	/**
+	 * @param {string} link 文件名
+	 * @param {string|undefined} text 图片参数
+	 * @param {accum} accum
+	 * @param {string} delimiter `|`
+	 * @complexity `n`
+	 */
+	constructor(link, text, title, config = Parser.getConfig(), accum = [], delimiter = '|') {
+		super(link, undefined, title, config, accum, delimiter);
+		this.append(...explode('-{', '}-', '|', text).map(part => new ImageParameterToken(part, config, accum)));
+	}
+
+	/**
+	 * @override
+	 * @param {number} start 起始位置
+	 */
+	lint(start = 0) {
+		const errors = super.lint(start),
+			args = this.getAllArgs(),
+			keys = [...new Set(args.map(({name}) => name))],
+			frameKeys = keys.filter(key => frame.has(key)),
+			horizAlignKeys = keys.filter(key => horizAlign.has(key)),
+			vertAlignKeys = keys.filter(key => vertAlign.has(key));
+		if (args.length === keys.length
+			&& frameKeys.length < 2 && horizAlignKeys.length < 2 && vertAlignKeys.length < 2
+		) {
+			return errors;
+		}
+		const rect = {start, ...this.getRootNode().posFromIndex(start)};
+		for (const key of keys) {
+			let relevantArgs = args.filter(({name}) => name === key);
+			if (key === 'caption') {
+				relevantArgs = [
+					...relevantArgs.slice(0, -1).filter(arg => arg.text()),
+					relevantArgs.at(-1),
+				];
+			}
+			if (relevantArgs.length > 1) {
+				errors.push(...relevantArgs.map(arg => generateForChild(arg, rect, `重复的图片${key}参数`)));
+			}
+		}
+		if (frameKeys.size > 1) {
+			errors.push(
+				...args.filter(({name}) => frame.has(name)).map(arg => generateForChild(arg, rect, '冲突的图片框架参数')),
+			);
+		}
+		if (horizAlignKeys.size > 1) {
+			errors.push(
+				...args.filter(({name}) => horizAlign.has(name))
+					.map(arg => generateForChild(arg, rect, '冲突的图片水平对齐参数')),
+			);
+		}
+		if (vertAlignKeys.size > 1) {
+			errors.push(
+				...args.filter(({name}) => vertAlign.has(name))
+					.map(arg => generateForChild(arg, rect, '冲突的图片垂直对齐参数')),
+			);
+		}
+		return errors;
+	}
+
+	/**
+	 * 获取所有图片参数节点
+	 * @returns {ImageParameterToken[]}
+	 */
+	getAllArgs() {
+		return this.childNodes.slice(1);
+	}
+
+	/**
+	 * 获取指定图片参数
+	 * @param {string} key 参数名
+	 * @complexity `n`
+	 */
+	getArgs(key) {
+		return this.getAllArgs().filter(({name}) => key === name);
+	}
+
+	/**
+	 * 获取特定类型的图片属性参数节点
+	 * @param {Set<string>} keys 接受的参数名
+	 * @param {type} type 类型名
+	 * @complexity `n`
+	 */
+	#getTypedArgs(keys, type) {
+		const args = this.getAllArgs().filter(({name}) => keys.has(name));
+		return args;
+	}
+
+	/** 获取图片框架属性参数节点 */
+	getFrameArgs() {
+		return this.#getTypedArgs(frame, '框架');
+	}
+
+	/** 获取图片水平对齐参数节点 */
+	getHorizAlignArgs() {
+		return this.#getTypedArgs(horizAlign, '水平对齐');
+	}
+
+	/** 获取图片垂直对齐参数节点 */
+	getVertAlignArgs() {
+		return this.#getTypedArgs(vertAlign, '垂直对齐');
+	}
+}
+
+module.exports = FileToken;

package/src/link/galleryImage.js

@@ -0,0 +1,62 @@
+'use strict';
+
+const {generateForSelf} = require('../../util/lint'),
+	Parser = require('../..'),
+	Token = require('..'),
+	FileToken = require('./file');
+
+/**
+ * 图片
+ * @classdesc `{childNodes: [AtomToken, ...ImageParameterToken]}`
+ */
+class GalleryImageToken extends FileToken {
+	type = 'gallery-image';
+	#invalid = false;
+
+	/**
+	 * @param {string} link 图片文件名
+	 * @param {string|undefined} text 图片参数
+	 * @param {accum} accum
+	 */
+	constructor(link, text, title, config = Parser.getConfig(), accum = []) {
+		let token;
+		if (text !== undefined) {
+			token = new Token(text, config, true, accum);
+			token.type = 'temp';
+			for (let n = 1; n < Parser.MAX_STAGE; n++) {
+				token.getAttribute('parseOnce')();
+			}
+			accum.splice(accum.indexOf(token), 1);
+		}
+		super(link, token?.toString(), title, config, accum);
+		this.setAttribute('bracket', false);
+	}
+
+	/**
+	 * @override
+	 */
+	afterBuild() {
+		const initImagemap = this.type === 'imagemap-image',
+			titleObj = this.normalizeTitle(String(this.firstChild), initImagemap ? 0 : 6, true, !initImagemap);
+		this.#invalid = titleObj.interwiki || titleObj.ns !== 6; // 只用于gallery-image的首次解析
+	}
+
+	/** @override */
+	getPadding() {
+		return 0;
+	}
+
+	/**
+	 * @override
+	 * @param {number} start 起始位置
+	 */
+	lint(start = 0) {
+		const errors = super.lint(start);
+		if (this.#invalid) {
+			errors.push(generateForSelf(this, {start}, '无效的图库图片'));
+		}
+		return errors;
+	}
+}
+
+module.exports = GalleryImageToken;

package/src/link/index.js

@@ -0,0 +1,115 @@
+'use strict';
+
+const {generateForChild} = require('../../util/lint'),
+	Parser = require('../..'),
+	AstText = require('../../lib/text'),
+	Token = require('..'),
+	AtomToken = require('../atom');
+
+/**
+ * 内链
+ * @classdesc `{childNodes: [AtomToken, ?Token]}`
+ */
+class LinkToken extends Token {
+	type = 'link';
+	#bracket = true;
+	#delimiter;
+	#fragment = '';
+	#encoded = false;
+
+	/**
+	 * @param {string} link 链接标题
+	 * @param {string|undefined} linkText 链接显示文字
+	 * @param {accum} accum
+	 * @param {string} delimiter `|`
+	 */
+	constructor(link, linkText, title, config = Parser.getConfig(), accum = [], delimiter = '|') {
+		super(undefined, config, true, accum, {
+		});
+		this.insertAt(new AtomToken(link, 'link-target', config, accum, {
+		}));
+		if (linkText !== undefined) {
+			const inner = new Token(linkText, config, true, accum, {
+			});
+			inner.type = 'link-text';
+			this.insertAt(inner.setAttribute('stage', Parser.MAX_STAGE - 1));
+		}
+		this.#delimiter = delimiter;
+	}
+
+	/**
+	 * @override
+	 */
+	afterBuild() {
+		const titleObj = this.normalizeTitle(this.firstChild.text(), 0, false, true, true);
+		this.#fragment = titleObj.fragment;
+		this.#encoded = titleObj.encoded;
+		if (this.#delimiter?.includes('\0')) {
+			this.#delimiter = this.getAttribute('buildFromStr')(this.#delimiter, 'string');
+		}
+	}
+
+	/**
+	 * @override
+	 * @template {string} T
+	 * @param {T} key 属性键
+	 * @param {TokenAttribute<T>} value 属性值
+	 */
+	setAttribute(key, value) {
+		if (key === 'bracket') {
+			this.#bracket = Boolean(value);
+			return this;
+		}
+		return super.setAttribute(key, value);
+	}
+
+	/**
+	 * @override
+	 */
+	toString(selector) {
+		const str = super.toString(selector, this.#delimiter);
+		return this.#bracket ? `[[${str}]]` : str;
+	}
+
+	/** @override */
+	text() {
+		const str = super.text('|');
+		return this.#bracket ? `[[${str}]]` : str;
+	}
+
+	/** @override */
+	getPadding() {
+		return 2;
+	}
+
+	/** @override */
+	getGaps() {
+		return this.#delimiter.length;
+	}
+
+	/**
+	 * @override
+	 * @param {number} start 起始位置
+	 */
+	lint(start = 0) {
+		const errors = super.lint(start),
+			{childNodes: [target, linkText], type: linkType} = this;
+		let rect;
+		if (this.#encoded) {
+			rect = {start, ...this.getRootNode().posFromIndex(start)};
+			errors.push(generateForChild(target, rect, '内链中不必要的URL编码'));
+		}
+		if (linkType === 'link' && linkText?.childNodes?.some(
+			/** @param {AstText} */ ({type, data}) => type === 'text' && data.includes('|'),
+		)) {
+			rect ||= {start, ...this.getRootNode().posFromIndex(start)};
+			errors.push(generateForChild(linkText, rect, '链接文本中多余的"|"', 'warning'));
+		} else if (linkType !== 'link' && this.#fragment) {
+			rect ||= {start, ...this.getRootNode().posFromIndex(start)};
+			errors.push(generateForChild(target, rect, '多余的fragment'));
+		}
+		return errors;
+	}
+}
+
+module.exports = LinkToken;

package/src/magicLink.js

@@ -0,0 +1,68 @@
+'use strict';
+
+const {generateForChild} = require('../util/lint'),
+	Parser = require('..'),
+	Token = require('.');
+
+/**
+ * 自由外链
+ * @classdesc `{childNodes: [...AstText|CommentToken|IncludeToken|NoincludeToken]}`
+ */
+class MagicLinkToken extends Token {
+	type = 'free-ext-link';
+
+	/**
+	 * @override
+	 * @param {number} start 起始位置
+	 */
+	lint(start = 0) {
+		const errors = super.lint(start),
+			source = `[，；。：！？（）]+${this.type === 'ext-link-url' ? '|\\|+' : ''}`;
+		let /** @type {{top: number, left: number}} */ rect;
+		for (const child of this.childNodes) {
+			const str = String(child);
+			if (child.type !== 'text' || !new RegExp(source, 'u').test(str)) {
+				continue;
+			}
+			rect ||= {start, ...this.getRootNode().posFromIndex(start)};
+			const refError = generateForChild(child, rect, '', 'warning'),
+				regex = new RegExp(source, 'gu');
+			for (let mt = regex.exec(str); mt; mt = regex.exec(str)) {
+				const {index, 0: {0: char, length}} = mt,
+					lines = str.slice(0, index).split('\n'),
+					{length: top} = lines,
+					{length: left} = lines[top - 1],
+					startIndex = start + index,
+					startLine = refError.startLine + top - 1,
+					startCol = (top > 1 ? 0 : refError.startCol) + left;
+				errors.push({
+					...refError,
+					message: `URL中的${char === '|' ? '"|"' : '全角标点'}`,
+					startIndex,
+					endIndex: startIndex + length,
+					startLine,
+					endLine: startLine,
+					startCol,
+					endCol: startCol + length,
+					excerpt: str.slice(Math.max(0, index - 25), index + 25),
+				});
+			}
+		}
+		return errors;
+	}
+
+	/**
+	 * @param {string} url 网址
+	 * @param {boolean} doubleSlash 是否接受"//"作为协议
+	 * @param {accum} accum
+	 */
+	constructor(url, doubleSlash, config = Parser.getConfig(), accum = []) {
+		super(url, config, true, accum, {
+		});
+		if (doubleSlash) {
+			this.type = 'ext-link-url';
+		}
+	}
+}
+
+module.exports = MagicLinkToken;

package/src/nested/choose.js

@@ -0,0 +1,23 @@
+'use strict';
+
+const Parser = require('../..'),
+	NestedToken = require('.');
+
+/**
+ * `<choose>`
+ * @classdesc `{childNodes: [...ExtToken|NoincludeToken]}`
+ */
+class ChooseToken extends NestedToken {
+	name = 'choose';
+
+	/**
+	 * @param {string|undefined} wikitext wikitext
+	 * @param {accum} accum
+	 */
+	constructor(wikitext, config = Parser.getConfig(), accum = []) {
+		const regex = /<(option|choicetemplate)(\s[^>]*)?>(.*?)<\/(\1)>/gsu;
+		super(wikitext, regex, ['option', 'choicetemplate'], config, accum);
+	}
+}
+
+module.exports = ChooseToken;

package/src/nested/combobox.js

@@ -0,0 +1,22 @@
+'use strict';
+
+const Parser = require('../..'),
+	NestedToken = require('.');
+
+/**
+ * `<combobox>`
+ * @classdesc `{childNodes: [...ExtToken|NoincludeToken]}`
+ */
+class ComboboxToken extends NestedToken {
+	name = 'combobox';
+
+	/**
+	 * @param {string|undefined} wikitext wikitext
+	 * @param {accum} accum
+	 */
+	constructor(wikitext, config = Parser.getConfig(), accum = []) {
+		super(wikitext, /<(combooption)(\s[^>]*)?>(.*?)<\/(combooption\s*)>/gisu, ['combooption'], config, accum);
+	}
+}
+
+module.exports = ComboboxToken;

package/src/nested/index.js

@@ -0,0 +1,69 @@
+'use strict';
+
+const {generateForChild} = require('../../util/lint'),
+	Parser = require('../..'),
+	Token = require('..'),
+	ExtToken = require('../tagPair/ext'),
+	NoincludeToken = require('../nowiki/noinclude'),
+	CommentToken = require('../nowiki/comment');
+
+/**
+ * 嵌套式的扩展标签
+ * @classdesc `{childNodes: [...ExtToken|NoincludeToken|CommentToken]}`
+ */
+class NestedToken extends Token {
+	type = 'ext-inner';
+
+	/**
+	 * @param {string|undefined} wikitext wikitext
+	 * @param {RegExp} regex 内层正则
+	 * @param {string[]} tags 内层标签名
+	 * @param {accum} accum
+	 */
+	constructor(wikitext, regex, tags, config = Parser.getConfig(), accum = []) {
+		const text = wikitext?.replace(
+			regex,
+			/** @type {function(...string): string} */ (comment, name, attr, inner, closing) => {
+				const str = `\0${accum.length + 1}${name ? 'e' : 'c'}\x7F`;
+				if (name) {
+					new ExtToken(name, attr, inner, closing, config, accum);
+				} else {
+					const closed = comment.endsWith('-->');
+					new CommentToken(comment.slice(4, closed ? -3 : undefined), closed, config, accum);
+				}
+				return str;
+			},
+		)?.replace(/(^|\0\d+[ce]\x7F)(.*?)(?=$|\0\d+[ce]\x7F)/gsu, (_, lead, substr) => {
+			if (substr === '') {
+				return lead;
+			}
+			new NoincludeToken(substr, config, accum);
+			return `${lead}\0${accum.length}c\x7F`;
+		});
+		super(text, config, true, accum, {
+		});
+	}
+
+	/**
+	 * @override
+	 * @param {number} start 起始位置
+	 */
+	lint(start = 0) {
+		let rect;
+		return [
+			...super.lint(start),
+			...this.childNodes.filter(child => {
+				if (child.type === 'ext' || child.type === 'comment') {
+					return false;
+				}
+				const str = String(child).trim();
+				return str && !/^<!--.*-->$/u.test(str);
+			}).map(child => {
+				rect ||= {start, ...this.getRootNode().posFromIndex(start)};
+				return generateForChild(child, rect, `<${this.name}>内的无效内容`);
+			}),
+		];
+	}
+}
+
+module.exports = NestedToken;

package/src/nested/references.js

@@ -0,0 +1,22 @@
+'use strict';
+
+const Parser = require('../..'),
+	NestedToken = require('.');
+
+/**
+ * `<references>`
+ * @classdesc `{childNodes: [...ExtToken|NoincludeToken|CommentToken]}`
+ */
+class ReferencesToken extends NestedToken {
+	name = 'references';
+
+	/**
+	 * @param {string|undefined} wikitext wikitext
+	 * @param {accum} accum
+	 */
+	constructor(wikitext, config = Parser.getConfig(), accum = []) {
+		super(wikitext, /<!--.*?(?:-->|$)|<(ref)(\s[^>]*)?>(.*?)<\/(ref\s*)>/gisu, ['ref'], config, accum);
+	}
+}
+
+module.exports = ReferencesToken;

package/src/nowiki/comment.js

@@ -0,0 +1,47 @@
+'use strict';
+
+const hidden = require('../../mixin/hidden'),
+	{generateForSelf} = require('../../util/lint'),
+	Parser = require('../..'),
+	NowikiToken = require('.');
+
+/**
+ * HTML注释，不可见
+ * @classdesc `{childNodes: [AstText]}`
+ */
+class CommentToken extends hidden(NowikiToken) {
+	type = 'comment';
+	closed;
+
+	/**
+	 * @param {string} wikitext wikitext
+	 * @param {boolean} closed 是否闭合
+	 * @param {accum} accum
+	 */
+	constructor(wikitext, closed = true, config = Parser.getConfig(), accum = []) {
+		super(wikitext, config, accum);
+		this.closed = closed;
+	}
+
+	/** @override */
+	getPadding() {
+		return 4;
+	}
+
+	/**
+	 * @override
+	 * @param {number} start 起始位置
+	 */
+	lint(start = 0) {
+		return this.closed ? [] : [generateForSelf(this, {start}, '未闭合的HTML注释')];
+	}
+
+	/**
+	 * @override
+	 */
+	toString(selector) {
+		return `<!--${String(this.firstChild)}${this.closed ? '-->' : ''}`;
+	}
+}
+
+module.exports = CommentToken;

package/src/nowiki/dd.js

@@ -0,0 +1,13 @@
+'use strict';
+
+const NowikiToken = require('.');
+
+/**
+ * :
+ * @classdesc `{childNodes: [AstText]}`
+ */
+class DdToken extends NowikiToken {
+	type = 'dd';
+}
+
+module.exports = DdToken;

package/src/nowiki/doubleUnderscore.js

@@ -0,0 +1,26 @@
+'use strict';
+
+const hidden = require('../../mixin/hidden'),
+	NowikiToken = require('.');
+
+/**
+ * 状态开关
+ * @classdesc `{childNodes: [AstText]}`
+ */
+class DoubleUnderscoreToken extends hidden(NowikiToken) {
+	type = 'double-underscore';
+
+	/** @override */
+	getPadding() {
+		return 2;
+	}
+
+	/**
+	 * @override
+	 */
+	toString(selector) {
+		return `__${String(this.firstChild)}__`;
+	}
+}
+
+module.exports = DoubleUnderscoreToken;

package/src/nowiki/hr.js

@@ -0,0 +1,22 @@
+'use strict';
+
+const Parser = require('../..'),
+	NowikiToken = require('.');
+
+/**
+ * `<hr>`
+ * @classdesc `{childNodes: [AstText]}`
+ */
+class HrToken extends NowikiToken {
+	type = 'hr';
+
+	/**
+	 * @param {number} n 字符串长度
+	 * @param {accum} accum
+	 */
+	constructor(n, config = Parser.getConfig(), accum = []) {
+		super('-'.repeat(n), config, accum);
+	}
+}
+
+module.exports = HrToken;

package/src/nowiki/index.js

@@ -0,0 +1,34 @@
+'use strict';
+
+const {generateForSelf} = require('../../util/lint'),
+	Parser = require('../..'),
+	Token = require('..');
+
+/**
+ * 纯文字Token，不会被解析
+ * @classdesc `{childNodes: [AstText]}`
+ */
+class NowikiToken extends Token {
+	type = 'ext-inner';
+
+	/**
+	 * @param {string} wikitext wikitext
+	 * @param {accum} accum
+	 */
+	constructor(wikitext, config = Parser.getConfig(), accum = []) {
+		super(wikitext, config, true, accum);
+	}
+
+	/**
+	 * @override
+	 * @param {number} start 起始位置
+	 */
+	lint(start = 0) {
+		const {type, name} = this;
+		return type === 'ext-inner' && (name === 'templatestyles' || name === 'section') && String(this)
+			? [generateForSelf(this, {start}, `<${name}>标签内不应有任何内容`)]
+			: super.lint(start);
+	}
+}
+
+module.exports = NowikiToken;

package/src/nowiki/list.js

@@ -0,0 +1,13 @@
+'use strict';
+
+const DdToken = require('./dd');
+
+/**
+ * ;:*#
+ * @classdesc `{childNodes: [AstText]}`
+ */
+class ListToken extends DdToken {
+	type = 'list';
+}
+
+module.exports = ListToken;

package/src/nowiki/noinclude.js

@@ -0,0 +1,14 @@
+'use strict';
+
+const hidden = require('../../mixin/hidden'),
+	NowikiToken = require('.');
+
+/**
+ * `<noinclude>`和`</noinclude>`，不可进行任何更改
+ * @classdesc `{childNodes: [AstText]}`
+ */
+class NoincludeToken extends hidden(NowikiToken) {
+	type = 'noinclude';
+}
+
+module.exports = NoincludeToken;