wikiparser-node 0.4.0 → 0.6.1

package/util/base.js

@@ -0,0 +1,17 @@
+'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

@@ -3,7 +3,7 @@
 /**
  * 定制TypeError消息
  * @param {Function} constructor 类
- * @param {string} method 方法名称
+ * @param {string} method
  * @param {...string} args 可接受的参数类型
  * @throws `TypeError`
  */

package/{test/util.js → util/diff.js}

@@ -1,4 +1,5 @@
 'use strict';
+
 const {spawn} = require('child_process'),
 	fs = require('fs/promises');
 
@@ -17,7 +18,7 @@ const cmd = (command, args) => new Promise(resolve => {
 
 	/**
 	 * 清除进程并返回
-	 * @param {any} val 返回值
+	 * @param {*} val 返回值
 	 */
 	const r = val => {
 		clearTimeout(timer);
@@ -49,32 +50,27 @@ const cmd = (command, args) => new Promise(resolve => {
 
 /**
  * 比较两个文件
- * @param {string} oldfile 旧文件
- * @param {string} newfile 新文件
+ * @param {string} oldStr 旧文本
+ * @param {string} newStr 新文本
+ * @param {string} uid 唯一标识
  */
-const diff = async (oldfile, newfile) => {
-	if (oldfile === newfile) {
+const diff = async (oldStr, newStr, uid = '') => {
+	if (oldStr === newStr) {
 		return;
 	}
-	await Promise.all([fs.writeFile('npmTestOldContent', oldfile), fs.writeFile('npmTestNewContent', newfile)]);
+	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:]]',
+		'--color-words=[\xC0-\xFF][\x80-\xBF]+|<?/?\\w+/?>?|[^[:space:]]',
 		'-U0',
 		'--no-index',
-		'npmTestOldContent',
-		'npmTestNewContent',
+		oldFile,
+		newFile,
 	]);
-	await Promise.all([fs.unlink('npmTestOldContent'), fs.unlink('npmTestNewContent')]);
+	await Promise.all([fs.unlink(oldFile), fs.unlink(newFile)]);
 	console.log(stdout?.split('\n')?.slice(4)?.join('\n'));
 };
 
-/**
- * 延时
- * @param {number} t 秒数
- */
-const sleep = t => new Promise(resolve => {
-	setTimeout(resolve, t * 1000);
-});
-
-module.exports = {diff, sleep};
+module.exports = diff;

package/util/lint.js

@@ -0,0 +1,40 @@
+'use strict';
+
+const Token = require('../src');
+
+/**
+ * 生成对于子节点的LintError对象
+ * @param {Token} child 子节点
+ * @param {{top: number, left: number}} boundingRect 父节点的绝对定位
+ * @param {string} message 错误信息
+ * @param {'error'|'warning'} severity 严重程度
+ * @returns {LintError}
+ */
+const generateForChild = (child, boundingRect, message, severity = 'error') => {
+	const {style: {top: offsetTop, left: offsetLeft, height, width}} = child,
+		{top, left} = boundingRect,
+		startLine = top + offsetTop,
+		endLine = startLine + height - 1,
+		startCol = offsetTop ? offsetLeft : left + offsetLeft,
+		endCol = height > 1 ? width : startCol + width;
+	return {message, severity, startLine, endLine, startCol, endCol};
+};
+
+/**
+ * 生成对于自己的LintError对象
+ * @param {Token} token 节点
+ * @param {{top: number, left: number}} boundingRect 绝对定位
+ * @param {string} message 错误信息
+ * @param {'error'|'warning'} severity 严重程度
+ * @returns {LintError}
+ */
+const generateForSelf = (token, boundingRect, message, severity = 'error') => ({
+	message,
+	severity,
+	startLine: boundingRect.top,
+	endLine: boundingRect.top + token.offsetHeight - 1,
+	startCol: boundingRect.left,
+	endCol: token.offsetHeight > 1 ? token.offsetWidth : boundingRect.left + token.offsetWidth,
+});
+
+module.exports = {generateForChild, generateForSelf};

package/util/string.js

@@ -1,11 +1,7 @@
 'use strict';
 
-/**
- * optionally convert to lower cases
- * @param {string} val 属性值
- * @param {string|undefined} i 是否对大小写不敏感
- */
-const toCase = (val, i) => i ? val.toLowerCase() : val;
+const extUrlChar = '(?:\\[[\\da-f:.]+\\]|[^[\\]<>"\\0-\\x1F\\x7F\\p{Zs}\\uFFFD])'
+	+ '(?:[^[\\]<>"\\0-\\x1F\\x7F\\p{Zs}\\uFFFD]|\\0\\d+c\\x7F)*';
 
 /**
  * remove half-parsed comment-like tokens
@@ -14,20 +10,27 @@ const toCase = (val, i) => i ? val.toLowerCase() : val;
 const removeComment = str => str.replaceAll(/\0\d+c\x7F/gu, '');
 
 /**
- * escape special chars for RegExp constructor
- * @param {string} str RegExp source
+ * 以HTML格式打印
+ * @param {(AstText|AstElement)[]} childNodes 子节点
+ * @param {printOpt} opt 选项
  */
-const escapeRegExp = str => str.replaceAll(/[\\{}()|.?*+^$[\]]/gu, '\\$&');
+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).replaceAll(/[&<>]/gu, p => `&${entities[p]};`),
+	).join(sep)}${post}`;
+};
 
 /**
- * extract effective wikitext
- * @param {(string|AstNode)[]} childNodes a Token's contents
- * @param {string} separator delimiter between nodes
+ * escape special chars for RegExp constructor
+ * @param {string} str RegExp source
  */
-const text = (childNodes, separator = '') => {
-	const AstNode = require('../lib/node');
-	return childNodes.map(child => typeof child === 'string' ? child : child.text()).join(separator);
-};
+const escapeRegExp = str => str.replaceAll(/[\\{}()|.?*+^$[\]]/gu, '\\$&');
 
 /**
  * a more sophisticated string-explode function
@@ -59,6 +62,23 @@ const explode = (start, end, separator, str) => {
 	return exploded;
 };
 
+/**
+ * optionally convert to lower cases
+ * @param {string} val 属性值
+ * @param {string|undefined} i 是否对大小写不敏感
+ */
+const toCase = (val, i) => i ? val.toLowerCase() : val;
+
+/**
+ * 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);
+};
+
 /**
  * escape newlines
  * @param {string} str 原字符串
@@ -82,7 +102,4 @@ const normalizeSpace = token => {
 	}
 };
 
-const extUrlChar = '(?:\\[[\\da-f:.]+\\]|[^[\\]<>"\\0-\\x1f\\x7f\\p{Zs}\\ufffd])'
-	+ '(?:[^[\\]<>"\\0-\\x1f\\x7f\\p{Zs}\\ufffd]|\\0\\d+c\\x7f)*';
-
-module.exports = {toCase, removeComment, escapeRegExp, text, explode, noWrap, normalizeSpace, extUrlChar};
+module.exports = {extUrlChar, removeComment, print, escapeRegExp, explode, toCase, text, noWrap, normalizeSpace};