wikiparser-node 0.9.2-b → 0.10.0-m

package/i18n/zh-hans.json

@@ -30,6 +30,7 @@
 	"nothing should be in <$1>": "<$1>标签内不应有任何内容",
 	"section header in a HTML tag": "HTML标签属性中的段落标题",
 	"tag that is both closing and self-closing": "同时闭合和自封闭的标签",
+	"template in an internal link target": "内链目标包含模板",
 	"unbalanced \"=\" in a section header": "段落标题中不平衡的\"=\"",
 	"unclosed HTML comment": "未闭合的HTML注释",
 	"unclosed quotes": "未闭合的引号",

package/i18n/zh-hant.json

@@ -30,6 +30,7 @@
 	"nothing should be in <$1>": "<$1>標籤內不應有任何內容",
 	"section header in a HTML tag": "HTML標籤屬性中的段落標題",
 	"tag that is both closing and self-closing": "同時閉合和自封閉的標籤",
+	"template in an internal link target": "內部連結目標包含模板",
 	"unbalanced \"=\" in a section header": "段落標題中不平衡的\"=\"",
 	"unclosed HTML comment": "未閉合的HTML註釋",
 	"unclosed quotes": "未閉合的引號",

package/index.js

@@ -0,0 +1,81 @@
+'use strict';
+
+const /** @type {Parser} */ Parser = {
+	config: './config/default',
+	i18n: undefined,
+
+	MAX_STAGE: 11,
+
+	getConfig() {
+		if (typeof this.config === 'string') {
+			this.config = require(this.config);
+		}
+		return {...this.config, excludes: []};
+	},
+
+	msg(msg, arg) {
+		if (typeof this.i18n === 'string') {
+			this.i18n = require(this.i18n);
+		}
+		msg = this.i18n?.[msg] ?? msg;
+		return msg.replace('$1', arg);
+	},
+
+	normalizeTitle(
+		title,
+		defaultNs = 0,
+		include = false,
+		config = Parser.getConfig(),
+		halfParsed = false,
+		decode = false,
+		selfLink = false,
+	) {
+		let /** @type {Token} */ token;
+		if (!halfParsed) {
+			const Token = require('./src');
+			token = this.run(() => {
+				const newToken = new Token(String(title), config),
+					parseOnce = newToken.getAttribute('parseOnce');
+				parseOnce(0, include);
+				return parseOnce();
+			});
+			title = token.firstChild;
+		}
+		const Title = require('./lib/title');
+		const titleObj = new Title(String(title), defaultNs, config, decode, selfLink);
+		return titleObj;
+	},
+
+	parse(wikitext, include, maxStage = Parser.MAX_STAGE, config = Parser.getConfig()) {
+		if (typeof wikitext !== 'string') {
+			throw new TypeError('待解析的内容应为 String！');
+		}
+		const Token = require('./src');
+		let /** @type {Token} */ token;
+		this.run(() => {
+			token = new Token(wikitext, config);
+			try {
+				token.parse(maxStage, include);
+			} catch {}
+		});
+		return token;
+	},
+
+	run(callback) {
+		return callback();
+	},
+};
+
+const /** @type {PropertyDescriptorMap} */ def = {},
+	immutable = new Set(['MAX_STAGE']),
+	enumerable = new Set(['config', 'normalizeTitle', 'parse']);
+for (const key in Parser) {
+	if (immutable.has(key)) {
+		def[key] = {enumerable: false, writable: false};
+	} else if (!enumerable.has(key)) {
+		def[key] = {enumerable: false};
+	}
+}
+Object.defineProperties(Parser, def);
+
+module.exports = Parser;

package/lib/element.js

@@ -0,0 +1,136 @@
+'use strict';
+
+const fs = require('fs'),
+	path = require('path'),
+	AstNode = require('./node'),
+	AstText = require('./text');
+
+const lintIgnoredExt = new Set([
+	'nowiki',
+	'pre',
+	'charinsert',
+	'score',
+	'syntaxhighlight',
+	'source',
+	'math',
+	'chem',
+	'ce',
+	'graph',
+	'mapframe',
+	'maplink',
+	'quiz',
+	'templatedata',
+	'timeline',
+]);
+
+/** 类似HTMLElement */
+class AstElement extends AstNode {
+	/** @type {string} */ name;
+
+	/** 子节点总数 */
+	get length() {
+		return this.childNodes.length;
+	}
+
+	/**
+	 * 最近的祖先节点
+	 * @param {string} selector
+	 */
+	closest(selector) {
+		const types = new Set(selector.split(',').map(type => type.trim()));
+		let {parentNode} = this;
+		while (parentNode) {
+			if (types.has(parentNode.type)) {
+				return parentNode;
+			}
+			({parentNode} = parentNode);
+		}
+		return undefined;
+	}
+
+	/**
+	 * 在末尾批量插入子节点
+	 * @param {...this} elements 插入节点
+	 * @complexity `n`
+	 */
+	append(...elements) {
+		for (const element of elements) {
+			this.insertAt(element);
+		}
+	}
+
+	/**
+	 * 批量替换子节点
+	 * @param {...this} elements 新的子节点
+	 * @complexity `n`
+	 */
+	replaceChildren(...elements) {
+		this.childNodes.length = 0;
+		this.append(...elements);
+	}
+
+	/**
+	 * 修改文本子节点
+	 * @param {string} str 新文本
+	 * @param {number} i 子节点位置
+	 */
+	setText(str, i = 0) {
+		const /** @type {AstText} */ oldText = this.childNodes.at(i),
+			{type, data} = oldText;
+		if (type === 'text') {
+			oldText.replaceData(str);
+			return data;
+		}
+		return undefined;
+	}
+
+	/**
+	 * 还原为wikitext
+	 * @param {string} separator 子节点间的连接符
+	 * @returns {string}
+	 */
+	toString(selector, separator = '') {
+		return this.childNodes.map(child => child.toString()).join(separator);
+	}
+
+	/**
+	 * Linter
+	 * @param {number} start 起始位置
+	 */
+	lint(start = this.getAbsoluteIndex()) {
+		const SyntaxToken = require('../src/syntax');
+		if (this instanceof SyntaxToken || this.constructor.hidden
+			|| this.type === 'ext-inner' && lintIgnoredExt.has(this.name)
+		) {
+			return [];
+		}
+		const /** @type {LintError[]} */ errors = [];
+		for (let i = 0, cur = start + this.getPadding(); i < this.length; i++) {
+			const child = this.childNodes[i];
+			errors.push(...child.lint(cur));
+			cur += String(child).length + this.getGaps(i);
+		}
+		return errors;
+	}
+
+	/**
+	 * 保存为JSON
+	 * @param {string} file 文件名
+	 * @returns {Record<string, *>}
+	 */
+	json(file) {
+		const json = {
+			...this,
+			childNodes: this.childNodes.map(child => child.type === 'text' ? String(child) : child.json()),
+		};
+		if (typeof file === 'string') {
+			fs.writeFileSync(
+				path.join(__dirname.slice(0, -4), 'printed', `${file}${file.endsWith('.json') ? '' : '.json'}`),
+				JSON.stringify(json, null, 2),
+			);
+		}
+		return json;
+	}
+}
+
+module.exports = AstElement;

package/lib/node.js

@@ -0,0 +1,236 @@
+'use strict';
+
+const {text} = require('../util/string');
+
+/** 类似Node */
+class AstNode {
+	/** @type {string} */ type;
+	/** @type {this[]} */ childNodes = [];
+	/** @type {this} */ #parentNode;
+
+	/** 首位子节点 */
+	get firstChild() {
+		return this.childNodes[0];
+	}
+
+	/** 末位子节点 */
+	get lastChild() {
+		return this.childNodes.at(-1);
+	}
+
+	/** 父节点 */
+	get parentNode() {
+		return this.#parentNode;
+	}
+
+	/**
+	 * 后一个兄弟节点
+	 * @complexity `n`
+	 */
+	get nextSibling() {
+		const childNodes = this.#parentNode?.childNodes;
+		return childNodes && childNodes[childNodes.indexOf(this) + 1];
+	}
+
+	/**
+	 * 前一个兄弟节点
+	 * @complexity `n`
+	 */
+	get previousSibling() {
+		const childNodes = this.#parentNode?.childNodes;
+		return childNodes && childNodes[childNodes.indexOf(this) - 1];
+	}
+
+	/**
+	 * 是否具有某属性
+	 * @param {PropertyKey} key 属性键
+	 */
+	hasAttribute(key) {
+		const type = typeof key;
+		return type === 'string' || type === 'number' || type === 'symbol'
+			? key in this
+			: false;
+	}
+
+	/**
+	 * 获取属性值。除非用于私有属性，否则总是返回字符串。
+	 * @template {string} T
+	 * @param {T} key 属性键
+	 * @returns {TokenAttribute<T>}
+	 */
+	getAttribute(key) {
+		return this.hasAttribute(key) ? String(this[key]) : undefined;
+	}
+
+	/**
+	 * 设置属性
+	 * @template {string} T
+	 * @param {T} key 属性键
+	 * @param {TokenAttribute<T>} value 属性值
+	 */
+	setAttribute(key, value) {
+		if (key === 'parentNode') {
+			this.#parentNode = value;
+		} else {
+			this[key] = value;
+		}
+		return this;
+	}
+
+	/**
+	 * 可见部分
+	 * @param {string} separator 子节点间的连接符
+	 * @returns {string}
+	 * @complexity `n`
+	 */
+	text(separator = '') {
+		return text(this.childNodes, separator);
+	}
+
+	/**
+	 * 移除子节点
+	 * @param {number} i 移除位置
+	 */
+	removeAt(i) {
+		const {childNodes} = this,
+			[node] = childNodes.splice(i, 1);
+		return node;
+	}
+
+	/**
+	 * 插入子节点
+	 * @template {this} T
+	 * @param {T} node 待插入的子节点
+	 * @param {number} i 插入位置
+	 * @complexity `n`
+	 */
+	insertAt(node, i = this.childNodes.length) {
+		const {childNodes} = this,
+			j = -1;
+		if (j === -1) {
+			node.setAttribute('parentNode', this);
+		}
+		childNodes.splice(i, 0, node);
+		return node;
+	}
+
+	/**
+	 * 合并相邻的文本子节点
+	 * @complexity `n`
+	 */
+	normalize() {
+		const AstText = require('./text');
+		const /** @type {{childNodes: AstText[]}} */ {childNodes} = this;
+		for (let i = childNodes.length - 1; i >= 0; i--) {
+			const {type, data} = childNodes[i];
+			if (this.getGaps(i - 1)) {
+				//
+			} else if (data === '') {
+				childNodes.splice(i, 1);
+			} else if (type === 'text' && childNodes[i - 1]?.type === 'text') {
+				childNodes[i - 1].setAttribute('data', childNodes[i - 1].data + data);
+				childNodes.splice(i, 1);
+			}
+		}
+	}
+
+	/** 获取根节点 */
+	getRootNode() {
+		let {parentNode} = this;
+		while (parentNode?.parentNode) {
+			({parentNode} = parentNode);
+		}
+		return parentNode ?? this;
+	}
+
+	/**
+	 * 将字符位置转换为行列号
+	 * @param {number} index 字符位置
+	 * @complexity `n`
+	 */
+	posFromIndex(index) {
+		const str = String(this);
+		if (index >= -str.length && index <= str.length) {
+			const lines = str.slice(0, index).split('\n');
+			return {top: lines.length - 1, left: lines.at(-1).length};
+		}
+		return undefined;
+	}
+
+	/**
+	 * 获取行数和最后一行的列数
+	 * @complexity `n`
+	 */
+	#getDimension() {
+		const lines = String(this).split('\n');
+		return {height: lines.length, width: lines.at(-1).length};
+	}
+
+	/** 第一个子节点前的间距 */
+	getPadding() {
+		return 0;
+	}
+
+	/** 子节点间距 */
+	getGaps() {
+		return 0;
+	}
+
+	/**
+	 * 获取当前节点的相对字符位置，或其第`j`个子节点的相对字符位置
+	 * @param {number|undefined} j 子节点序号
+	 * @complexity `n`
+	 */
+	getRelativeIndex(j) {
+		let /** @type {this[]} */ childNodes;
+
+		/**
+		 * 获取子节点相对于父节点的字符位置，使用前需要先给`childNodes`赋值
+		 * @param {number} end 子节点序号
+		 * @param {this} parent 父节点
+		 * @returns {number}
+		 */
+		const getIndex = (end, parent) => childNodes.slice(0, end).reduce(
+			(acc, cur, i) => acc + String(cur).length + parent.getGaps(i),
+			0,
+		) + parent.getPadding();
+		if (j === undefined) {
+			const {parentNode} = this;
+			if (parentNode) {
+				({childNodes} = parentNode);
+				return getIndex(childNodes.indexOf(this), parentNode);
+			}
+			return 0;
+		}
+		({childNodes} = this);
+		return getIndex(j, this);
+	}
+
+	/**
+	 * 获取当前节点的绝对位置
+	 * @returns {number}
+	 * @complexity `n`
+	 */
+	getAbsoluteIndex() {
+		const {parentNode} = this;
+		return parentNode ? parentNode.getAbsoluteIndex() + this.getRelativeIndex() : 0;
+	}
+
+	/**
+	 * 行数
+	 * @complexity `n`
+	 */
+	get offsetHeight() {
+		return this.#getDimension().height;
+	}
+
+	/**
+	 * 最后一行的列数
+	 * @complexity `n`
+	 */
+	get offsetWidth() {
+		return this.#getDimension().width;
+	}
+}
+
+module.exports = AstNode;

package/lib/text.js

@@ -0,0 +1,168 @@
+'use strict';
+
+const Parser = require('..'),
+	AstNode = require('./node'),
+	AstElement = require('./element');
+
+const errorSyntax = /https?:\/\/|\{+|\}+|\[{2,}|\[(?![^[]*\])|(?<=^|\])([^[]*?)\]+|\]{2,}|<\s*\/?([a-z]\w*)/giu,
+	errorSyntaxUrl = /\{+|\}+|\[{2,}|\[(?![^[]*\])|(?<=^|\])([^[]*?)\]+|\]{2,}|<\s*\/?([a-z]\w*)/giu,
+	disallowedTags = [
+		'html',
+		'base',
+		'head',
+		'style',
+		'title',
+		'body',
+		'menu',
+		'a',
+		'area',
+		'audio',
+		'img',
+		'map',
+		'track',
+		'video',
+		'embed',
+		'iframe',
+		'object',
+		'picture',
+		'source',
+		'canvas',
+		'script',
+		'col',
+		'colgroup',
+		'tbody',
+		'tfoot',
+		'thead',
+		'button',
+		'datalist',
+		'fieldset',
+		'form',
+		'input',
+		'label',
+		'legend',
+		'meter',
+		'optgroup',
+		'option',
+		'output',
+		'progress',
+		'select',
+		'textarea',
+		'details',
+		'dialog',
+		'slot',
+		'template',
+		'dir',
+		'frame',
+		'frameset',
+		'marquee',
+		'param',
+		'xmp',
+	];
+
+/** 文本节点 */
+class AstText extends AstNode {
+	type = 'text';
+	/** @type {string} */ data;
+
+	/** @param {string} text 包含文本 */
+	constructor(text = '') {
+		super();
+		this.data = text;
+	}
+
+	/** 输出字符串 */
+	toString() {
+		return this.data;
+	}
+
+	/** @override */
+	text() {
+		return this.data;
+	}
+
+	/**
+	 * Linter
+	 * @this {AstText & {parentNode: AstElement}}
+	 * @param {number} start 起始位置
+	 * @returns {LintError[]}
+	 */
+	lint(start = this.getAbsoluteIndex()) {
+		const {data, parentNode, nextSibling, previousSibling} = this,
+			type = parentNode?.type,
+			name = parentNode?.name,
+			nextType = nextSibling?.type,
+			previousType = previousSibling?.type,
+			errorRegex
+			= type === 'free-ext-link' || type === 'ext-link-url' || type === 'image-parameter' && name === 'link'
+				? errorSyntaxUrl
+				: errorSyntax,
+			errors = [...data.matchAll(errorRegex)],
+			{ext, html} = this.getRootNode().getAttribute('config');
+		if (errors.length > 0) {
+			const root = this.getRootNode(),
+				{top, left} = root.posFromIndex(start),
+				tags = new Set([ext, html, disallowedTags].flat(2));
+			return errors.map(/** @returns {LintError} */ ({0: error, 1: prefix, 2: tag, index}) => {
+				if (prefix) {
+					index += prefix.length;
+					error = error.slice(prefix.length);
+				}
+				const startIndex = start + index,
+					lines = data.slice(0, index).split('\n'),
+					startLine = lines.length + top - 1,
+					line = lines.at(-1),
+					startCol = lines.length > 1 ? line.length : left + line.length,
+					{0: char, length} = error,
+					endIndex = startIndex + length,
+					end = char === '}' || char === ']' ? endIndex + 1 : startIndex + 49,
+					rootStr = String(root),
+					nextChar = rootStr[endIndex],
+					previousChar = rootStr[startIndex - 1],
+					severity = length > 1 && (char !== '<' || /[\s/>]/u.test(nextChar))
+						|| char === '{' && (nextChar === char || previousChar === '-')
+						|| char === '}' && (previousChar === char || nextChar === '-')
+						|| char === '[' && (
+							nextChar === char || type === 'ext-link-text'
+							|| !data.slice(index + 1).trim() && nextType === 'free-ext-link'
+						)
+						|| char === ']' && (
+							previousChar === char
+							|| !data.slice(0, index).trim() && previousType === 'free-ext-link'
+						)
+						? 'error'
+						: 'warning';
+				return (char !== 'h' || index > 0) && (char !== '<' || tags.has(tag.toLowerCase())) && {
+					message: Parser.msg('lonely "$1"', char === 'h' ? error : char),
+					severity,
+					startIndex,
+					endIndex,
+					startLine,
+					endLine: startLine,
+					startCol,
+					endCol: startCol + length,
+					excerpt: rootStr.slice(Math.max(0, end - 50), end),
+				};
+			}).filter(Boolean);
+		}
+		return [];
+	}
+
+	/**
+	 * 修改内容
+	 * @param {string} text 新内容
+	 */
+	#setData(text) {
+		text = String(text);
+		this.setAttribute('data', text);
+	}
+
+	/**
+	 * 替换字符串
+	 * @param {string} text 替换的字符串
+	 */
+	replaceData(text = '') {
+		this.#setData(text);
+	}
+}
+
+module.exports = AstText;

package/lib/title.js

@@ -0,0 +1,56 @@
+'use strict';
+
+const {decodeHtml} = require('../util/string'),
+	Parser = require('..');
+
+/** MediaWiki页面标题对象 */
+class Title {
+	valid = true;
+	ns = 0;
+	fragment;
+	encoded = false;
+
+	/**
+	 * @param {string} title 标题（含或不含命名空间前缀）
+	 * @param {number} defaultNs 命名空间
+	 * @param {boolean} decode 是否需要解码
+	 * @param {boolean} selfLink 是否允许selfLink
+	 */
+	constructor(title, defaultNs = 0, config = Parser.getConfig(), decode = false, selfLink = false) {
+		const {namespaces, nsid} = config;
+		let namespace = namespaces[defaultNs];
+		title = decodeHtml(title);
+		if (decode && title.includes('%')) {
+			try {
+				const encoded = /%(?!21|3[ce]|5[bd]|7[b-d])[\da-f]{2}/iu.test(title);
+				title = decodeURIComponent(title);
+				this.encoded = encoded;
+			} catch {}
+		}
+		title = title.replaceAll('_', ' ').trim();
+		if (title[0] === ':') {
+			namespace = '';
+			title = title.slice(1).trim();
+		}
+		const m = title.split(':');
+		if (m.length > 1) {
+			const id = namespaces[nsid[m[0].trim().toLowerCase()]];
+			if (id !== undefined) {
+				namespace = id;
+				title = m.slice(1).join(':').trim();
+			}
+		}
+		this.ns = nsid[namespace.toLowerCase()];
+		const i = title.indexOf('#');
+		let fragment;
+		if (i !== -1) {
+			fragment = title.slice(i + 1).trimEnd();
+			title = title.slice(0, i).trim();
+		}
+		this.valid = Boolean(title || selfLink && fragment !== undefined)
+			&& !/\0\d+[eh!+-]\x7F|[<>[\]{}|]|%[\da-f]{2}/iu.test(title);
+		this.fragment = fragment;
+	}
+}
+
+module.exports = Title;

package/mixin/hidden.js

@@ -0,0 +1,18 @@
+'use strict';
+
+/**
+ * 解析后不可见的类
+ * @template T
+ * @param {T} Constructor 基类
+ * @returns {T}
+ */
+const hidden = Constructor => class extends Constructor {
+	static hidden = true;
+
+	/** 没有可见部分 */
+	text() { // eslint-disable-line class-methods-use-this
+		return '';
+	}
+};
+
+module.exports = hidden;