wikiparser-node 0.3.1 → 0.5.0

package/index.js

@@ -7,25 +7,102 @@ const fs = require('fs'),
 const /** @type {Parser} */ Parser = {
 	warning: true,
 	debugging: false,
+	running: false,
+
+	config: './config/default',
+
+	MAX_STAGE: 11,
+
+	classes: {},
+	mixins: {},
+	parsers: {},
+
+	aliases: [
+		['AstText'],
+		['CommentToken', 'ExtToken', 'IncludeToken', 'NoincludeToken'],
+		['ArgToken', 'TranscludeToken', 'HeadingToken'],
+		['HtmlToken'],
+		['TableToken'],
+		['HrToken', 'DoubleUnderscoreToken'],
+		['LinkToken', 'FileToken', 'CategoryToken'],
+		['QuoteToken'],
+		['ExtLinkToken'],
+		['MagicLinkToken'],
+		['ListToken', 'DdToken'],
+		['ConverterToken'],
+	],
+	typeAliases: {
+		include: ['includeonly'],
+		ext: ['extension'],
+		'ext-attr': ['extension-attr'],
+		'ext-inner': ['extension-inner'],
+		arg: ['argument'],
+		'arg-name': ['argument-name'],
+		'arg-default': ['argument-default'],
+		'magic-word': ['parser-function', 'parser-func'],
+		'invoke-function': ['invoke-func', 'lua-function', 'lua-func', 'module-function', 'module-func'],
+		'invoke-module': ['lua-module'],
+		parameter: ['param'],
+		'parameter-key': ['param-key'],
+		'parameter-value': ['parameter-val', 'param-value', 'param-val'],
+		heading: ['header'],
+		'heading-title': ['header-title'],
+		'heading-trail': ['header-trail'],
+		'table-attr': ['tr-attr', 'table-row-attr', 'td-attr', 'table-cell-attr', 'table-data-attr'],
+		tr: ['table-row'],
+		td: ['table-cell', 'table-data'],
+		'td-inner': ['table-cell-inner', 'table-data-inner'],
+		'double-underscore': ['underscore', 'behavior-switch', 'behaviour-switch'],
+		hr: ['horizontal'],
+		category: ['category-link', 'cat', 'cat-link'],
+		file: ['file-link', 'image', 'image-link', 'img', 'img-link'],
+		'gallery-image': ['gallery-file', 'gallery-img'],
+		'image-parameter': ['img-parameter', 'image-param', 'img-param'],
+		quote: ['quotes', 'quot', 'apostrophe', 'apostrophes', 'apos'],
+		'ext-link': ['external-link'],
+		'ext-link-text': ['external-link-text'],
+		'ext-link-url': ['external-link-url'],
+		'free-ext-link': ['free-external-link', 'magic-link'],
+		list: ['ol', 'ordered-list', 'ul', 'unordered-list', 'dl', 'description-list'],
+		dd: ['indent', 'indentation'],
+		converter: ['convert', 'conversion'],
+		'converter-flags': ['convert-flags', 'conversion-flags'],
+		'converter-flag': ['convert-flag', 'conversion-flag'],
+		'converter-rule': ['convert-rule', 'conversion-rule'],
+		'converter-rule-noconvert': ['convert-rule-noconvert', 'conversion-rule-noconvert'],
+		'converter-rule-variant': ['convert-rule-variant', 'conversion-rule-variant'],
+		'converter-rule-to': ['convert-rule-to', 'conversion-rule-to'],
+		'converter-rule-from': ['convert-rule-from', 'conversion-rule-from'],
+	},
+
+	promises: [Promise.resolve()],
 
 	warn(msg, ...args) {
 		if (this.warning) {
-			console.warn('\x1b[33m%s\x1b[0m', msg, ...args);
+			console.warn('\x1B[33m%s\x1B[0m', msg, ...args);
 		}
 	},
 	debug(msg, ...args) {
 		if (this.debugging) {
-			console.debug('\x1b[34m%s\x1b[0m', msg, ...args);
+			console.debug('\x1B[34m%s\x1B[0m', msg, ...args);
 		}
 	},
 	error(msg, ...args) {
-		console.error('\x1b[31m%s\x1b[0m', msg, ...args);
+		console.error('\x1B[31m%s\x1B[0m', msg, ...args);
 	},
 	info(msg, ...args) {
-		console.info('\x1b[32m%s\x1b[0m', msg, ...args);
+		console.info('\x1B[32m%s\x1B[0m', msg, ...args);
 	},
 
-	running: false,
+	log(f) {
+		if (typeof f === 'function') {
+			console.log(String(f));
+		}
+	},
+
+	getConfig() {
+		return require(this.config);
+	},
 
 	run(callback) {
 		const {running} = this;
@@ -40,10 +117,6 @@ const /** @type {Parser} */ Parser = {
 		}
 	},
 
-	classes: {},
-	mixins: {},
-	parsers: {},
-
 	clearCache() {
 		const entries = [
 			...Object.entries(this.classes),
@@ -60,53 +133,35 @@ const /** @type {Parser} */ Parser = {
 		}
 	},
 
-	log(f) {
-		if (typeof f === 'function') {
-			console.log(f.toString());
-		}
-	},
-
-	aliases: [
-		['String'],
-		['CommentToken', 'ExtToken', 'IncludeToken', 'NoincludeToken'],
-		['ArgToken', 'TranscludeToken', 'HeadingToken'],
-		['HtmlToken'],
-		['TableToken'],
-		['HrToken', 'DoubleUnderscoreToken'],
-		['LinkToken', 'FileToken', 'CategoryToken'],
-		['QuoteToken'],
-		['ExtLinkToken'],
-		['MagicLinkToken'],
-		['ListToken', 'DdToken'],
-		['ConverterToken'],
-	],
-
-	config: './config/default',
-
-	getConfig() {
-		return require(this.config);
-	},
-
 	isInterwiki(title, {interwiki} = Parser.getConfig()) {
 		title = String(title);
-		return RegExp(`^(${interwiki.join('|')})\\s*:`, 'i').exec(title.replaceAll('_', ' ').replace(/^\s*:?\s*/, ''));
+		return new RegExp(`^(${interwiki.join('|')})\\s*:`, 'iu')
+			.exec(title.replaceAll('_', ' ').replace(/^\s*:?\s*/u, ''));
 	},
 
 	normalizeTitle(title, defaultNs = 0, include = false, config = Parser.getConfig(), halfParsed = false) {
-		title = String(title);
 		let /** @type {Token} */ token;
 		if (!halfParsed) {
 			const Token = require('./src');
-			token = this.run(() => new Token(title, config).parseOnce(0, include).parseOnce());
+			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'),
-			titleObj = new Title(title, defaultNs, config);
+		const Title = require('./lib/title');
+		const titleObj = new Title(String(title), defaultNs, config);
 		if (token) {
-			const build = /** @param {string[]} keys */ keys => {
+			/**
+			 * 重建部分属性值
+			 * @param {string[]} keys 属性键
+			 */
+			const build = keys => {
 				for (const key of keys) {
 					if (titleObj[key].includes('\0')) {
-						titleObj[key] = text(token.buildFromStr(titleObj[key]));
+						titleObj[key] = text(token.getAttribute('buildFromStr')(titleObj[key]));
 					}
 				}
 			};
@@ -117,17 +172,15 @@ const /** @type {Parser} */ Parser = {
 		return titleObj;
 	},
 
-	MAX_STAGE: 11,
-
-	parse(wikitext, include = false, maxStage = Parser.MAX_STAGE, config = Parser.getConfig()) {
+	parse(wikitext, include, maxStage = Parser.MAX_STAGE, config = Parser.getConfig()) {
 		const Token = require('./src');
-		let token;
+		let /** @type {Token} */ token;
 		this.run(() => {
 			if (typeof wikitext === 'string') {
 				token = new Token(wikitext, config);
 			} else if (wikitext instanceof Token) {
 				token = wikitext;
-				wikitext = token.toString();
+				wikitext = String(token);
 			} else {
 				throw new TypeError('待解析的内容应为 String 或 Token！');
 			}
@@ -137,7 +190,7 @@ const /** @type {Parser} */ Parser = {
 				if (e instanceof Error) {
 					const file = path.join(__dirname, 'errors', new Date().toISOString()),
 						stage = token.getAttribute('stage');
-					fs.writeFileSync(file, stage === this.MAX_STAGE ? wikitext : token.toString());
+					fs.writeFileSync(file, stage === this.MAX_STAGE ? wikitext : String(token));
 					fs.writeFileSync(`${file}.err`, e.stack);
 					fs.writeFileSync(`${file}.json`, JSON.stringify({
 						stage, include: token.getAttribute('include'), config: this.config,
@@ -146,25 +199,46 @@ const /** @type {Parser} */ Parser = {
 				throw e;
 			}
 		});
+		if (this.debugging) {
+			let restored = String(token),
+				process = '解析';
+			if (restored === wikitext) {
+				const entities = {lt: '<', gt: '>', amp: '&'};
+				restored = token.print().replaceAll(
+					/<[^<]+?>|&([lg]t|amp);/gu,
+					/** @param {string} s */ (_, s) => s ? entities[s] : '',
+				);
+				process = '渲染HTML';
+			}
+			if (restored !== wikitext) {
+				const diff = require('./util/diff');
+				const {promises: {0: cur, length}} = this;
+				this.promises.unshift((async () => {
+					await cur;
+					this.error(`${process}过程中不可逆地修改了原始文本！`);
+					return diff(wikitext, restored, length);
+				})());
+			}
+		}
 		return token;
 	},
 
 	reparse(date) {
 		const main = fs.readdirSync(path.join(__dirname, 'errors'))
-			.find(name => name.startsWith(date) && name.endsWith('Z'));
+			.find(name => name.startsWith(date) && name.at(-1) === 'Z');
 		if (!main) {
 			throw new RangeError(`找不到对应时间戳的错误记录：${date}`);
 		}
-		const Token = require('./src'),
-			file = path.join(__dirname, 'errors', main),
-			wikitext = fs.readFileSync(file, 'utf8'),
-			{stage, include, config} = require(`${file}.json`);
+		const file = path.join(__dirname, 'errors', main),
+			wikitext = fs.readFileSync(file, 'utf8');
+		const {stage, include, config} = require(`${file}.json`),
+			Token = require('./src');
 		this.config = config;
 		return this.run(() => {
 			const halfParsed = stage < this.MAX_STAGE,
 				token = new Token(wikitext, this.getConfig(), halfParsed);
 			if (halfParsed) {
-				token.setAttribute('stage', stage).parseOnce(stage, include);
+				token.setAttribute('stage', stage).getAttribute('parseOnce')(stage, include);
 			} else {
 				token.parse(undefined, include);
 			}
@@ -179,52 +253,11 @@ const /** @type {Parser} */ Parser = {
 		delete require.cache[require.resolve('./tool')];
 		return require('./tool');
 	},
-
-	typeAliases: {
-		ext: ['extension'],
-		'ext-inner': ['extension-inner'],
-		arg: ['argument'],
-		'arg-name': ['argument-name'],
-		'arg-default': ['argument-default'],
-		'arg-redundant': ['argument-redundant'],
-		template: ['tpl'],
-		'template-name': ['tpl-name'],
-		'magic-word': ['parser-function', 'parser-func'],
-		'invoke-function': ['invoke-func'],
-		'invoke-module': ['invoke-mod'],
-		parameter: ['param'],
-		'parameter-key': ['param-key'],
-		'parameter-value': ['parameter-val', 'param-value', 'param-val'],
-		heading: ['header'],
-		'heading-title': ['header-title'],
-		table: ['tbl'],
-		'table-inter': ['tbl-inter'],
-		tr: ['table-row', 'tbl-row'],
-		td: ['table-cell', 'tbl-cell', 'table-data', 'tbl-data'],
-		'double-underscore': ['underscore', 'behavior-switch', 'behaviour-switch'],
-		hr: ['horizontal'],
-		category: ['category-link', 'cat', 'cat-link'],
-		file: ['file-link', 'image', 'image-link', 'img', 'img-link'],
-		'image-parameter': ['img-parameter', 'image-param', 'img-param'],
-		quote: ['quotes', 'quot', 'apostrophe', 'apostrophes', 'apos'],
-		'ext-link': ['external-link'],
-		'ext-link-text': ['external-link-text'],
-		'ext-link-url': ['external-link-url'],
-		'free-ext-link': ['free-external-link', 'magic-link'],
-		dd: ['indent', 'indentation'],
-		converter: ['convert', 'conversion'],
-		'converter-flags': ['convert-flags', 'conversion-flags', 'converter-flag', 'convert-flag', 'conversion-flag'],
-		'converter-rule': ['convert-rule', 'conversion-rule'],
-		'converter-rule-noconvert': ['convert-rule-noconvert', 'conversion-rule-noconvert'],
-		'converter-rule-variant': ['convert-rule-variant', 'conversion-rule-variant'],
-		'converter-rule-to': ['convert-rule-to', 'conversion-rule-to'],
-		'converter-rule-from': ['convert-rule-from', 'conversion-rule-from'],
-	},
 };
 
 const /** @type {PropertyDescriptorMap} */ def = {};
 for (const key in Parser) {
-	if (['alises', 'MAX_STAGE'].includes(key)) {
+	if (['aliases', 'MAX_STAGE', 'typeAliases', 'promises'].includes(key)) {
 		def[key] = {enumerable: false, writable: false};
 	} else if (!['config', 'isInterwiki', 'normalizeTitle', 'parse', 'getTool'].includes(key)) {
 		def[key] = {enumerable: false};