wikiparser-node 0.11.0 → 1.0.0-beta.1

package/typings/api.d.ts

@@ -1,9 +0,0 @@
-interface MediaWikiRevision {
-	content: string;
-	contentmodel: string;
-}
-export interface MediaWikiPage {
-	title: string;
-	ns: number;
-	revisions: MediaWikiRevision[];
-}

package/typings/array.d.ts

@@ -1,29 +0,0 @@
-declare global {
-	interface Array<T> {
-
-		/**
-		 * Returns the value of the last element in the array where predicate is true, and undefined
-		 * otherwise.
-		 * @param predicate find calls predicate once for each element of the array, in descending
-		 * order, until it finds one where predicate returns true. If such an element is found, findLast
-		 * immediately returns that element value. Otherwise, findLast returns undefined.
-		 * @param thisArg If provided, it will be used as the this value for each invocation of
-		 * predicate. If it is not provided, undefined is used instead.
-		 */
-		findLast<S extends T>(predicate: (this: void, value: T, index: number, obj: T[]) => value is S, thisArg?: unknown): S | undefined;
-		findLast(predicate: (value: T, index: number, obj: T[]) => unknown, thisArg?: unknown): T | undefined;
-
-		/**
-		 * Returns the index of the last element in the array where predicate is true, and -1
-		 * otherwise.
-		 * @param predicate find calls predicate once for each element of the array, in descending
-		 * order, until it finds one where predicate returns true. If such an element is found,
-		 * findLastIndex immediately returns that element index. Otherwise, findLastIndex returns -1.
-		 * @param thisArg If provided, it will be used as the this value for each invocation of
-		 * predicate. If it is not provided, undefined is used instead.
-		 */
-		findLastIndex(predicate: (value: T, index: number, obj: T[]) => unknown, thisArg?: unknown): number;
-	}
-}
-
-export {};

package/typings/event.d.ts

@@ -1,22 +0,0 @@
-import Token = require('../src');
-import AstText = require('../lib/text');
-
-export interface AstEvent {
-	readonly type: string;
-	readonly target: Token & AstText;
-	currentTarget: Token;
-	prevTarget: Token;
-	bubbles: boolean;
-}
-export interface AstEventData {
-	position: number;
-	removed: AstText|Token;
-	inserted: AstText|Token;
-	oldToken: Token;
-	newToken: Token;
-	oldText: string;
-	newText: string;
-	oldKey: string;
-	newKey: string;
-}
-export type AstListener = (e: AstEvent, data: AstEventData) => unknown;

package/typings/index.d.ts

@@ -1,118 +0,0 @@
-import Token = require('../src');
-import $ = require('../tool');
-import Title = require('../lib/title');
-import {ParserConfig} from './token';
-
-declare interface Parser {
-	config: string|ParserConfig;
-	i18n: string|Record<string, string>;
-
-	readonly MAX_STAGE: number;
-
-	warning: boolean;
-	debugging: boolean;
-	running: boolean;
-
-	/** 只储存导出各个Class的文件路径 */
-	classes: Record<string, string>;
-	mixins: Record<string, string>;
-	parsers: Record<string, string>;
-	tool: {$: string};
-
-	readonly aliases: string[][];
-	readonly typeAliases: Record<string, string[]>;
-
-	readonly promises: Promise<void>[];
-
-	/** 获取设置 */
-	getConfig(): ParserConfig;
-
-	/**
-	 * 生成I18N消息
-	 * @param msg 消息名
-	 * @param arg 额外参数
-	 */
-	msg(msg: string, arg: string): string;
-
-	/**
-	 * 规范化页面标题
-	 * @param title 标题（含或不含命名空间前缀）
-	 * @param defaultNs 命名空间
-	 * @param include 是否嵌入
-	 * @param halfParsed 是否是半解析状态
-	 * @param decode 是否需要解码
-	 * @param selfLink 是否允许selfLink
-	 */
-	normalizeTitle(
-		title: string,
-		defaultNs?: number,
-		include?: boolean,
-		config?: ParserConfig,
-		halfParsed?: boolean,
-		decode?: boolean,
-		selfLink?: boolean,
-	): Title;
-
-	/**
-	 * 解析wikitext
-	 * @param wikitext wikitext
-	 * @param include 是否嵌入
-	 * @param maxStage 最大解析层级
-	 */
-	parse(wikitext: string, include?: boolean, maxStage?: number, config?: ParserConfig): Token;
-
-	run<T>(callback: () => T): T;
-
-	/**
-	 * 默认输出到console.warn
-	 * @param msg 消息
-	 * @param args 更多信息
-	 */
-	warn(msg: string, ...args: unknown[]): void;
-
-	/**
-	 * 默认不输出到console.debug
-	 * @param msg 消息
-	 * @param args 更多信息
-	 */
-	debug(msg: string, ...args: unknown[]): void;
-
-	/**
-	 * 总是输出到console.error
-	 * @param msg 消息
-	 * @param args 更多信息
-	 */
-	error(msg: string, ...args: unknown[]): void;
-
-	/**
-	 * 总是输出到console.info
-	 * @param msg 消息
-	 * @param args 更多信息
-	 */
-	info(msg: string, ...args: unknown[]): void;
-
-	/**
-	 * 打印函数定义
-	 * @param f 待打印的函数
-	 */
-	log(f: (...args: unknown[]) => unknown): void;
-
-	/** 清除各模块的缓存 */
-	clearCache(): void;
-
-	/**
-	 * 是否是跨维基链接
-	 * @param title 链接标题
-	 */
-	isInterwiki(title: string, config?: ParserConfig): RegExpMatchArray;
-
-	/**
-	 * 再次解析上次出错的wikitext
-	 * @param date 错误日期
-	 */
-	reparse(date: string): Token;
-
-	getTool(): typeof $;
-}
-
-export = Parser;

package/typings/node.d.ts

@@ -1,35 +0,0 @@
-import Ranges = require('../lib/ranges');
-import Token = require('../src');
-import AstText = require('../lib/text');
-import ParameterToken = require('../src/parameter');
-import {ParserConfig, accum} from './token';
-
-type buildFromStr = <S extends string>(str: string, type: S) => S extends 'string'|'text' ? string : (AstText|Token)[];
-
-export type TokenAttribute<T> =
-	T extends 'stage' ? number :
-	T extends 'config' ? ParserConfig :
-	T extends 'accum' ? accum :
-	T extends 'parentNode' ? Token|undefined :
-	T extends 'childNodes' ? (AstText|Token)[] :
-	T extends 'parseOnce' ? (n: number, include: boolean) => Token :
-	T extends 'buildFromStr' ? buildFromStr :
-	T extends 'build' ? () => void :
-	T extends 'bracket'|'include' ? boolean :
-	T extends 'pattern' ? RegExp :
-	T extends 'tags'|'flags'|'quotes' ? string[] :
-	T extends 'optional'|'keys' ? Set<string> :
-	T extends 'acceptable' ? Record<string, Ranges> :
-	T extends 'args' ? Record<string, Set<ParameterToken>> :
-	T extends 'protectedChildren' ? Ranges :
-	T extends 'verifyChild' ? (i: number, addition: number) => void :
-	T extends 'matchesAttr' ? (key: string, equal: string, val: string, i: string) => boolean :
-	T extends 'protectChildren' ? (...args: (string|number|Range)[]) => void :
-	string;
-
-export interface printOpt {
-	pre?: string;
-	post?: string;
-	sep?: string;
-	class?: string;
-}

package/typings/parser.d.ts

@@ -1,12 +0,0 @@
-export interface BracketExecArray extends RegExpExecArray {
-	parts: string[][];
-	findEqual: boolean;
-	pos: number;
-}
-export interface SelectorArray extends Array<string|RegExpExecArray> {
-	relation: string|undefined;
-}
-
-export type pseudo = 'root'|'is'|'not'|'nth-child'|'nth-of-type'|'nth-last-child'|'nth-last-of-type'
-	|'first-child'|'first-of-type'|'last-child'|'last-of-type'|'only-child'|'only-of-type'|'empty'
-	|'contains'|'has'|'header'|'parent'|'hidden'|'visible';

package/typings/table.d.ts

@@ -1,10 +0,0 @@
-export interface TableCoords {
-	row: number;
-	column: number;
-	start: boolean;
-}
-
-export interface TableRenderedCoords {
-	x: number;
-	y: number;
-}

package/typings/token.d.ts

@@ -1,31 +0,0 @@
-import Token = require('../src');
-import Ranges = require('../lib/ranges');
-
-export interface ParserConfig {
-	ext: string[];
-	html: string[][];
-	namespaces: Record<string, string>;
-	nsid: Record<string, number>;
-	parserFunction: [Record<string, string>, string[], string[], string[]];
-	doubleUnderscore: string[][];
-	protocol: string;
-	img: Record<string, string>;
-	variants: string[];
-	interwiki: string[];
-	excludes: string[];
-}
-
-export type accum = Token[];
-export type acceptable = Record<string, number|string|Ranges|(number|string)[]>;
-
-export interface LintError {
-	message: string;
-	severity: 'error'|'warning';
-	startIndex: number;
-	endIndex: number;
-	startLine: number;
-	startCol: number;
-	endLine: number;
-	endCol: number;
-	excerpt: string;
-}

package/typings/tool.d.ts

@@ -1,6 +0,0 @@
-import Token = require('../src');
-import AstText = require('../lib/text');
-
-export interface CollectionCallback<T, S> extends Function {
-	call: (thisArg: AstText|Token, i: number, ele: S) => T;
-}

package/util/base.js

@@ -1,17 +0,0 @@
-'use strict';
-
-/**
- * 是否是普通对象
- * @param {*} obj 对象
- */
-const isPlainObject = obj => Boolean(obj) && Object.getPrototypeOf(obj).constructor === Object;
-
-/**
- * 延时
- * @param {number} t 秒数
- */
-const sleep = t => new Promise(resolve => {
-	setTimeout(resolve, t * 1000);
-});
-
-module.exports = {isPlainObject, sleep};

package/util/debug.js

@@ -1,73 +0,0 @@
-'use strict';
-
-/**
- * 定制TypeError消息
- * @param {Function} constructor 类
- * @param {string} method
- * @param {...string} args 可接受的参数类型
- * @throws `TypeError`
- */
-const typeError = ({name}, method, ...args) => {
-	throw new TypeError(`${name}.${method} 方法仅接受 ${args.join('、')} 作为输入参数！`);
-};
-
-/**
- * 不是被构造器或原型方法调用
- * @param {string} name 方法名称
- */
-const externalUse = name => {
-	const Parser = require('..');
-	if (Parser.running) {
-		return false;
-	}
-	const regex = new RegExp(`^new \\w*Token$|^(?:Ast\\w*|\\w*Token)\\.(?!${name}$)`, 'u');
-	try {
-		throw new Error(); // eslint-disable-line unicorn/error-message
-	} catch (e) {
-		if (e instanceof Error) {
-			const mt = e.stack.match(/(?<=^\s+at )(?:new )?[\w.]+(?= \(\/)/gmu);
-			return !mt.slice(2).some(func => regex.test(func));
-		}
-	}
-	return false;
-};
-
-/**
- * 撤销最近一次Mutation
- * @param {import('../typings/event').AstEvent} e 事件
- * @param {import('../typings/event').AstEventData} data 事件数据
- * @throws `RangeError` 无法撤销的事件类型
- */
-const undo = (e, data) => {
-	const {target, type} = e;
-	switch (type) {
-		case 'remove': {
-			const childNodes = [...target.childNodes];
-			childNodes.splice(data.position, 0, data.removed);
-			data.removed.setAttribute('parentNode', target);
-			target.setAttribute('childNodes', childNodes);
-			break;
-		}
-		case 'insert': {
-			const childNodes = [...target.childNodes];
-			childNodes.splice(data.position, 1);
-			target.setAttribute('childNodes', childNodes);
-			break;
-		}
-		case 'replace': {
-			const {parentNode} = target,
-				childNodes = [...parentNode.childNodes];
-			childNodes.splice(data.position, 1, data.oldToken);
-			data.oldToken.setAttribute('parentNode', parentNode);
-			parentNode.setAttribute('childNodes', childNodes);
-			break;
-		}
-		case 'text':
-			target.replaceData(data.oldText);
-			break;
-		default:
-			throw new RangeError(`无法撤销未知类型的事件：${type}`);
-	}
-};
-
-module.exports = {typeError, externalUse, undo};

package/util/diff.js

@@ -1,76 +0,0 @@
-'use strict';
-
-const {spawn} = require('child_process'),
-	fs = require('fs/promises');
-
-process.on('unhandledRejection', e => {
-	console.error(e);
-});
-
-/**
- * 将shell命令转化为Promise对象
- * @param {string} command shell指令
- * @param {string[]} args shell输入参数
- * @returns {Promise<?string>}
- */
-const cmd = (command, args) => new Promise(resolve => {
-	let timer, shell;
-
-	/**
-	 * 清除进程并返回
-	 * @param {*} val 返回值
-	 */
-	const r = val => {
-		clearTimeout(timer);
-		shell.kill('SIGINT');
-		resolve(val);
-	};
-	try {
-		shell = spawn(command, args);
-		timer = setTimeout(() => {
-			shell.kill('SIGINT');
-		}, 60 * 1000);
-		let buf = '';
-		shell.stdout.on('data', data => {
-			buf += data.toString();
-		});
-		shell.stdout.on('end', () => {
-			r(buf);
-		});
-		shell.on('exit', () => {
-			r(shell.killed ? undefined : '');
-		});
-		shell.on('error', () => {
-			r(undefined);
-		});
-	} catch {
-		r(undefined);
-	}
-});
-
-/**
- * 比较两个文件
- * @param {string} oldStr 旧文本
- * @param {string} newStr 新文本
- * @param {string} uid 唯一标识
- */
-const diff = async (oldStr, newStr, uid = '') => {
-	if (oldStr === newStr) {
-		return;
-	}
-	const oldFile = `diffOld${uid}`,
-		newFile = `diffNew${uid}`;
-	await Promise.all([fs.writeFile(oldFile, oldStr), fs.writeFile(newFile, newStr)]);
-	const stdout = await cmd('git', [
-		'diff',
-		'--color-words=[\xC0-\xFF][\x80-\xBF]+|<?/?\\w+/?>?|[^[:space:]]',
-		'-U0',
-		'--no-index',
-		oldFile,
-		newFile,
-	]);
-	await Promise.all([fs.unlink(oldFile), fs.unlink(newFile)]);
-	console.log(stdout?.split('\n')?.slice(4)?.join('\n'));
-};
-
-module.exports = diff;

package/util/lint.js

@@ -1,57 +0,0 @@
-'use strict';
-
-/** @typedef {import('../typings/token').LintError} LintError */
-
-const Parser = require('..'),
-	Token = require('../src');
-
-/**
- * 生成对于子节点的LintError对象
- * @param {Token} child 子节点
- * @param {{top: number, left: number, start: number}} boundingRect 父节点的绝对定位
- * @param {string} msg 错误信息
- * @param {'error'|'warning'} severity 严重程度
- * @returns {LintError}
- */
-const generateForChild = (child, boundingRect, msg, severity = 'error') => {
-	const index = child.getRelativeIndex(),
-		{offsetHeight, offsetWidth, parentNode, length} = child,
-		{top: offsetTop, left: offsetLeft} = parentNode.posFromIndex(index),
-		{start} = boundingRect,
-		{top, left} = 'top' in boundingRect ? boundingRect : child.getRootNode().posFromIndex(start),
-		excerpt = String(child).slice(0, 50),
-		startIndex = start + index,
-		endIndex = startIndex + length,
-		startLine = top + offsetTop,
-		endLine = startLine + offsetHeight - 1,
-		startCol = offsetTop ? offsetLeft : left + offsetLeft,
-		endCol = offsetHeight > 1 ? offsetWidth : startCol + offsetWidth;
-	return {message: Parser.msg(msg), severity, startIndex, endIndex, startLine, endLine, startCol, endCol, excerpt};
-};
-
-/**
- * 生成对于自己的LintError对象
- * @param {Token} token 节点
- * @param {{top: number, left: number, start: number}} boundingRect 绝对定位
- * @param {string} msg 错误信息
- * @param {'error'|'warning'} severity 严重程度
- * @returns {LintError}
- */
-const generateForSelf = (token, boundingRect, msg, severity = 'error') => {
-	const {start} = boundingRect,
-		{offsetHeight, offsetWidth, length} = token,
-		{top, left} = 'top' in boundingRect ? boundingRect : token.getRootNode().posFromIndex(start);
-	return {
-		message: Parser.msg(msg),
-		severity,
-		startIndex: start,
-		endIndex: start + length,
-		startLine: top,
-		endLine: top + offsetHeight - 1,
-		startCol: left,
-		endCol: offsetHeight > 1 ? offsetWidth : left + offsetWidth,
-		excerpt: String(token).slice(0, 50),
-	};
-};
-
-module.exports = {generateForChild, generateForSelf};

package/util/string.js

@@ -1,126 +0,0 @@
-'use strict';
-
-const extUrlCharFirst = '(?:\\[[\\da-f:.]+\\]|[^[\\]<>"\\0-\\x1F\\x7F\\p{Zs}\\uFFFD])',
-	extUrlChar = '(?:[^[\\]<>"\\0-\\x1F\\x7F\\p{Zs}\\uFFFD]|\\0\\d+c\\x7F)*';
-
-/**
- * remove half-parsed comment-like tokens
- * @param {string} str 原字符串
- */
-const removeComment = str => str.replace(/\0\d+c\x7F/gu, '');
-
-/**
- * 以HTML格式打印
- * @param {(AstText|AstElement)[]} childNodes 子节点
- * @param {import('../typings/node').printOpt} opt 选项
- */
-const print = (childNodes, opt = {}) => {
-	const AstText = require('../lib/text'),
-		AstElement = require('../lib/element');
-	const {pre = '', post = '', sep = ''} = opt,
-		entities = {'&': 'amp', '<': 'lt', '>': 'gt'};
-	return `${pre}${childNodes.map(
-		child => child instanceof AstElement
-			? child.print()
-			: String(child).replace(/[&<>]/gu, p => `&${entities[p]};`),
-	).join(sep)}${post}`;
-};
-
-/**
- * escape special chars for RegExp constructor
- * @param {string} str RegExp source
- */
-const escapeRegExp = str => str.replace(/[\\{}()|.?*+^$[\]]/gu, '\\$&');
-
-/**
- * a more sophisticated string-explode function
- * @param {string} start start syntax of a nested AST node
- * @param {string} end end syntax of a nested AST node
- * @param {string} separator syntax for explosion
- * @param {string} str string to be exploded
- */
-const explode = (start, end, separator, str) => {
-	if (str === undefined) {
-		return [];
-	}
-	const regex = new RegExp(`${[start, end, separator].map(escapeRegExp).join('|')}`, 'gu'),
-		/** @type {string[]} */ exploded = [];
-	let mt = regex.exec(str),
-		depth = 0,
-		lastIndex = 0;
-	while (mt) {
-		const {0: match, index} = mt;
-		if (match !== separator) {
-			depth += match === start ? 1 : -1;
-		} else if (depth === 0) {
-			exploded.push(str.slice(lastIndex, index));
-			({lastIndex} = regex);
-		}
-		mt = regex.exec(str);
-	}
-	exploded.push(str.slice(lastIndex));
-	return exploded;
-};
-
-/**
- * extract effective wikitext
- * @param {(string|AstNode)[]} childNodes a Token's contents
- * @param {string} separator delimiter between nodes
- */
-const text = (childNodes, separator = '') => {
-	const AstNode = require('../lib/node');
-	return childNodes.map(child => typeof child === 'string' ? child : child.text()).join(separator);
-};
-
-/**
- * decode HTML entities
- * @param {string} str 原字符串
- */
-const decodeHtml = str => str?.replace(
-	/&#(\d+|x[\da-f]+);/giu,
-	/** @param {string} code */ (_, code) => String.fromCodePoint(`${code[0].toLowerCase() === 'x' ? '0' : ''}${code}`),
-);
-
-/**
- * optionally convert to lower cases
- * @param {string} val 属性值
- * @param {string|undefined} i 是否对大小写不敏感
- */
-const toCase = (val, i) => i ? val.toLowerCase() : val;
-
-/**
- * escape newlines
- * @param {string} str 原字符串
- */
-const noWrap = str => str.replaceAll('\n', '\\n');
-
-/**
- * convert newline in text nodes to single whitespace
- * @param {Token & {childNodes: AstText[]}} token 父节点
- */
-const normalizeSpace = token => {
-	if (token === undefined) {
-		return;
-	}
-	const Token = require('../src'),
-		AstText = require('../lib/text');
-	for (const child of token.childNodes) {
-		if (child.type === 'text') {
-			child.replaceData(child.data.replaceAll('\n', ' '));
-		}
-	}
-};
-
-module.exports = {
-	extUrlCharFirst,
-	extUrlChar,
-	removeComment,
-	print,
-	escapeRegExp,
-	explode,
-	text,
-	decodeHtml,
-	toCase,
-	noWrap,
-	normalizeSpace,
-};