wikiparser-node 0.10.0 → 0.11.0-m

package/typings/index.d.ts

@@ -0,0 +1,51 @@
+import Token = require('../src');
+import Title = require('../lib/title');
+import {ParserConfig} from './token';
+
+declare interface Parser {
+	config: string|ParserConfig;
+	i18n: string|Record<string, string>;
+
+	readonly MAX_STAGE: number;
+
+	/** 获取设置 */
+	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;
+}
+
+export = Parser;

package/typings/node.d.ts

@@ -0,0 +1,16 @@
+import Token = require('../src');
+import AstText = require('../lib/text');
+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 'parseOnce' ? (n: number, include: boolean) => Token :
+	T extends 'buildFromStr' ? buildFromStr :
+	T extends 'build' ? () => void :
+	T extends 'bracket'|'include' ? boolean :
+	string;

package/typings/parser.d.ts

@@ -0,0 +1,5 @@
+export interface BracketExecArray extends RegExpExecArray {
+	parts: string[][];
+	findEqual: boolean;
+	pos: number;
+}

package/typings/token.d.ts

@@ -0,0 +1,28 @@
+import Token = require('../src');
+
+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[];
+	excludes: string[];
+}
+
+export type accum = Token[];
+
+export interface LintError {
+	message: string;
+	severity: 'error'|'warning';
+	startIndex: number;
+	endIndex: number;
+	startLine: number;
+	startCol: number;
+	endLine: number;
+	endCol: number;
+	excerpt: string;
+}

package/util/lint.js

@@ -1,5 +1,7 @@
 'use strict';
 
+/** @typedef {import('../typings/token').LintError} LintError */
+
 const Parser = require('..'),
 	Token = require('../src');
 

package/util/string.js

@@ -9,23 +9,6 @@ const extUrlCharFirst = '(?:\\[[\\da-f:.]+\\]|[^[\\]<>"\\0-\\x1F\\x7F\\p{Zs}\\uF
  */
 const removeComment = str => str.replace(/\0\d+c\x7F/gu, '');
 
-/**
- * 以HTML格式打印
- * @param {(AstText|AstElement)[]} childNodes 子节点
- * @param {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
@@ -81,46 +64,12 @@ const decodeHtml = str => str?.replace(
 	/** @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,
 };

package/lib/ranges.js

@@ -1,130 +0,0 @@
-'use strict';
-
-const Parser = require('..');
-
-/** 模拟Python的Range对象。除`step`至少为`1`外，允许负数、小数或`end < start`的情形。 */
-class Range {
-	start;
-	end;
-	step;
-
-	/**
-	 * @param {string|Range} str 表达式
-	 * @throws `RangeError` 起点、终点和步长均应为整数
-	 * @throws `RangeError` n的系数不能为0
-	 * @throws `RangeError` 应使用CSS选择器或Python切片的格式
-	 */
-	constructor(str) {
-		if (str instanceof Range) {
-			Object.assign(this, str);
-			return;
-		}
-		str = str.trim();
-		if (str === 'odd') {
-			Object.assign(this, {start: 1, end: Infinity, step: 2});
-		} else if (str === 'even') {
-			Object.assign(this, {start: 0, end: Infinity, step: 2});
-		} else if (str.includes(':')) {
-			const [start, end, step = '1'] = str.split(':', 3);
-			this.start = Number(start);
-			this.end = Number(end || Infinity);
-			this.step = Math.max(Number(step), 1);
-			if (!Number.isInteger(this.start)) {
-				throw new RangeError(`起点 ${this.start} 应为整数！`);
-			} else if (this.end !== Infinity && !Number.isInteger(this.end)) {
-				throw new RangeError(`终点 ${this.end} 应为整数！`);
-			} else if (!Number.isInteger(this.step)) {
-				throw new RangeError(`步长 ${this.step} 应为整数！`);
-			}
-		} else {
-			const mt = /^([+-])?(\d+)?n(?:([+-])(\d+))?$/u.exec(str);
-			if (mt) {
-				const [, sgnA = '+', a = 1, sgnB = '+'] = mt,
-					b = Number(mt[4] ?? 0);
-				this.step = Number(a);
-				if (this.step === 0) {
-					throw new RangeError(`参数 ${str} 中 "n" 的系数不允许为 0！`);
-				} else if (sgnA === '+') {
-					this.start = sgnB === '+' || b === 0 ? b : this.step - 1 - (b - 1) % this.step;
-					this.end = Infinity;
-				} else if (sgnB === '-') {
-					this.start = 0;
-					this.end = b > 0 ? 0 : this.step;
-				} else {
-					this.start = b % this.step;
-					this.end = this.step + b;
-				}
-			} else {
-				throw new RangeError(`参数 ${str} 应写作CSS选择器的 "an+b" 形式或Python切片！`);
-			}
-		}
-	}
-
-	/**
-	 * 将Range转换为针对特定数组的下标集
-	 * @param {number|*[]} arr 参考数组
-	 * @complexity `n`
-	 */
-	applyTo(arr) {
-		return new Array(typeof arr === 'number' ? arr : arr.length).fill().map((_, i) => i).slice(this.start, this.end)
-			.filter((_, j) => j % this.step === 0);
-	}
-}
-
-/** @extends {Array<number|Range>} */
-class Ranges extends Array {
-	/** @param {number|string|Range|(number|string|Range)[]} arr 表达式数组 */
-	constructor(arr) {
-		super();
-		if (arr === undefined) {
-			return;
-		}
-		arr = Array.isArray(arr) ? arr : [arr];
-		for (const ele of arr) {
-			if (ele instanceof Range) {
-				this.push(new Range(ele));
-				continue;
-			}
-			const number = Number(ele);
-			if (Number.isInteger(number)) {
-				this.push(number);
-			} else if (typeof ele === 'string' && Number.isNaN(number)) {
-				try {
-					const range = new Range(ele);
-					this.push(range);
-				} catch {}
-			}
-		}
-	}
-
-	/**
-	 * 将Ranges转换为针对特定Array的下标集
-	 * @param {number|*[]} arr 参考数组
-	 * @complexity `n`
-	 */
-	applyTo(arr) {
-		const length = typeof arr === 'number' ? arr : arr.length;
-		return [
-			...new Set(
-				[...this].flatMap(ele => {
-					if (typeof ele === 'number') {
-						return ele < 0 ? ele + length : ele;
-					}
-					return ele.applyTo(length);
-				}),
-			),
-		].filter(i => i >= 0 && i < length).sort();
-	}
-
-	/**
-	 * 检查某个下标是否符合表达式
-	 * @param {string} str 表达式
-	 * @param {number} i 待检查的下标
-	 */
-	static nth(str, i) {
-		return new Ranges(str.split(',')).applyTo(i + 1).includes(i);
-	}
-}
-
-Parser.classes.Ranges = __filename;
-module.exports = Ranges;

package/mixin/attributeParent.js

@@ -1,117 +0,0 @@
-'use strict';
-
-const Parser = require('..'),
-	AttributesToken = require('../src/attributes');
-
-/**
- * 子节点含有AttributesToken的类
- * @template T
- * @param {T} Constructor 基类
- * @param {number} i AttributesToken子节点的位置
- * @returns {T}
- */
-const attributeParent = (Constructor, i = 0) => class extends Constructor {
-	/** getAttrs()方法的getter写法 */
-	get attributes() {
-		return this.getAttrs();
-	}
-
-	/** 以字符串表示的class属性 */
-	get className() {
-		const attr = this.getAttr('class');
-		return typeof attr === 'string' ? attr : '';
-	}
-
-	set className(className) {
-		this.setAttr('class', className);
-	}
-
-	/** 以Set表示的class属性 */
-	get classList() {
-		return new Set(this.className.split(/\s/u));
-	}
-
-	/** id属性 */
-	get id() {
-		const attr = this.getAttr('id');
-		return typeof attr === 'string' ? attr : '';
-	}
-
-	set id(id) {
-		this.setAttr('id', id);
-	}
-
-	/**
-	 * AttributesToken子节点是否具有某属性
-	 * @this {{childNodes: AttributesToken[]}}
-	 * @param {string} key 属性键
-	 */
-	hasAttr(key) {
-		return this.childNodes.at(i).hasAttr(key);
-	}
-
-	/**
-	 * 获取AttributesToken子节点的属性
-	 * @this {{childNodes: AttributesToken[]}}
-	 * @param {string} key 属性键
-	 */
-	getAttr(key) {
-		return this.childNodes.at(i).getAttr(key);
-	}
-
-	/**
-	 * 列举AttributesToken子节点的属性键
-	 * @this {{childNodes: AttributesToken[]}}
-	 */
-	getAttrNames() {
-		return this.childNodes.at(i).getAttrNames();
-	}
-
-	/**
-	 * AttributesToken子节点是否具有任意属性
-	 * @this {{childNodes: AttributesToken[]}}
-	 */
-	hasAttrs() {
-		return this.childNodes.at(i).hasAttrs();
-	}
-
-	/**
-	 * 获取AttributesToken子节点的全部标签属性
-	 * @this {{childNodes: AttributesToken[]}}
-	 */
-	getAttrs() {
-		return this.childNodes.at(i).getAttrs();
-	}
-
-	/**
-	 * 对AttributesToken子节点设置属性
-	 * @this {{childNodes: AttributesToken[]}}
-	 * @param {string} key 属性键
-	 * @param {string|boolean} value 属性值
-	 */
-	setAttr(key, value) {
-		return this.childNodes.at(i).setAttr(key, value);
-	}
-
-	/**
-	 * 移除AttributesToken子节点的某属性
-	 * @this {{childNodes: AttributesToken[]}}
-	 * @param {string} key 属性键
-	 */
-	removeAttr(key) {
-		this.childNodes.at(i).removeAttr(key);
-	}
-
-	/**
-	 * 开关AttributesToken子节点的某属性
-	 * @this {{childNodes: AttributesToken[]}}
-	 * @param {string} key 属性键
-	 * @param {boolean|undefined} force 强制开启或关闭
-	 */
-	toggleAttr(key, force) {
-		this.childNodes.at(i).toggleAttr(key, force);
-	}
-};
-
-Parser.mixins.attributeParent = __filename;
-module.exports = attributeParent;

package/mixin/fixedToken.js

@@ -1,40 +0,0 @@
-'use strict';
-
-const Parser = require('..'),
-	Token = require('../src');
-
-/**
- * 不可增删子节点的类
- * @template T
- * @param {T} Constructor 基类
- * @returns {T}
- */
-const fixedToken = Constructor => class extends Constructor {
-	static fixed = true;
-
-	/**
-	 * 移除子节点
-	 * @throws `Error`
-	 */
-	removeAt() {
-		throw new Error(`${this.constructor.name} 不可删除元素！`);
-	}
-
-	/**
-	 * 插入子节点
-	 * @template {Token} T
-	 * @param {T} token 待插入的子节点
-	 * @param {number} i 插入位置
-	 * @throws `Error`
-	 */
-	insertAt(token, i = this.length) {
-		if (Parser.running) {
-			super.insertAt(token, i);
-			return token;
-		}
-		throw new Error(`${this.constructor.name} 不可插入元素！`);
-	}
-};
-
-Parser.mixins.fixedToken = __filename;
-module.exports = fixedToken;

package/mixin/singleLine.js

@@ -1,31 +0,0 @@
-'use strict';
-
-const Parser = require('..');
-
-/**
- * 不可包含换行符的类
- * @template {Function} T
- * @param {T} Constructor 基类
- * @returns {T}
- */
-const singleLine = Constructor => {
-	const SingleLineConstructor = class extends Constructor {
-		/**
-		 * @override
-		 * @param {string} selector
-		 */
-		toString(selector) {
-			return super.toString(selector).replaceAll('\n', ' ');
-		}
-
-		/** @override */
-		text() {
-			return super.text().replaceAll('\n', ' ');
-		}
-	};
-	Object.defineProperty(SingleLineConstructor, 'name', {value: `SingleLine${Constructor.name}`});
-	return SingleLineConstructor;
-};
-
-Parser.mixins.singleLine = __filename;
-module.exports = singleLine;

package/mixin/sol.js

@@ -1,54 +0,0 @@
-'use strict';
-
-const Parser = require('..'),
-	Token = require('../src');
-
-/**
- * 只能位于行首的类
- * @template T
- * @param {T} Constructor 基类
- * @returns {T}
- */
-const sol = Constructor => class SolToken extends Constructor {
-	/**
-	 * 是否可以视为root节点
-	 * @this {Token}
-	 */
-	#isRoot() {
-		const {parentNode, type} = this;
-		return parentNode?.type === 'root'
-			|| type !== 'heading' && parentNode?.type === 'ext-inner' && parentNode.name === 'poem';
-	}
-
-	/**
-	 * 在前方插入newline
-	 * @this {SolToken & Token}
-	 */
-	prependNewLine() {
-		return (this.previousVisibleSibling || !this.#isRoot()) && !String(this.previousVisibleSibling).endsWith('\n')
-			? '\n'
-			: '';
-	}
-
-	/**
-	 * 还原为wikitext
-	 * @this {SolToken & Token}
-	 * @param {string} selector
-	 */
-	toString(selector) {
-		return selector && this.matches(selector) ? '' : `${this.prependNewLine()}${super.toString(selector)}`;
-	}
-
-	/** 获取padding */
-	getPadding() {
-		return this.prependNewLine().length;
-	}
-
-	/** 可见部分 */
-	text() {
-		return `${this.prependNewLine()}${super.text()}`;
-	}
-};
-
-Parser.mixins.sol = __filename;
-module.exports = sol;