wikiparser-node 0.4.0 → 0.6.1

package/src/magicLink.js

@@ -1,6 +1,7 @@
 'use strict';
 
-const Parser = require('..'),
+const {generateForChild} = require('../util/lint'),
+	Parser = require('..'),
 	Token = require('.');
 
 /**
@@ -19,11 +20,14 @@ class MagicLinkToken extends Token {
 	set protocol(value) {
 		if (typeof value !== 'string') {
 			this.typeError('protocol', 'String');
-		}
-		if (!new RegExp(`${this.#protocolRegex.source}$`, 'iu').test(value)) {
+		} else if (!new RegExp(`${this.#protocolRegex.source}$`, 'iu').test(value)) {
 			throw new RangeError(`非法的外链协议：${value}`);
 		}
-		this.replaceChildren(this.text().replace(this.#protocolRegex, value));
+		const {link} = this;
+		if (!this.#protocolRegex.test(link)) {
+			throw new Error(`特殊外链无法更改协议！${link}`);
+		}
+		this.replaceChildren(link.replace(this.#protocolRegex, value));
 	}
 
 	/** 和内链保持一致 */
@@ -48,25 +52,41 @@ class MagicLinkToken extends Token {
 		this.#protocolRegex = new RegExp(`^(?:${config.protocol}${doubleSlash ? '|//' : ''})`, 'iu');
 	}
 
-	/** @override */
-	afterBuild() {
-		const ParameterToken = require('./parameter');
-		const /** @type {ParameterToken} */ parameter = this.closest('parameter');
-		if (parameter?.getValue() === this.text()) {
-			this.replaceWith(...this.childNodes);
+	/**
+	 * @override
+	 * @param {number} start 起始位置
+	 */
+	lint(start = 0) {
+		const errors = super.lint(start);
+		let /** @type {{top: number, left: number}} */ rect;
+		for (const child of this.childNodes) {
+			const str = String(child);
+			if (child.type !== 'text' || !/[，；。：！？（）【】]/u.test(str)) {
+				continue;
+			}
+			rect ||= this.getRootNode().posFromIndex(start);
+			const refError = generateForChild(child, rect, 'URL中的全角标点', 'warning');
+			errors.push(...[...str.matchAll(/[，；。：！？（）【】]/gu)].map(({index}) => {
+				const lines = str.slice(0, index).split('\n'),
+					{length: top} = lines,
+					{length: left} = lines.at(-1),
+					startLine = refError.startLine + top - 1,
+					startCol = top > 1 ? left : refError.startCol + left;
+				return {...refError, startLine, endLine: startLine, startCol, endCol: startCol + 1};
+			}));
 		}
-		return this;
+		return errors;
 	}
 
 	/** @override */
 	cloneNode() {
-		const cloned = this.cloneChildNodes(),
-			token = Parser.run(() => new MagicLinkToken(
-				undefined, this.type === 'ext-link-url', this.getAttribute('config'),
-			));
-		token.append(...cloned);
-		token.afterBuild();
-		return token;
+		const cloned = this.cloneChildNodes();
+		return Parser.run(() => {
+			const token = new MagicLinkToken(undefined, this.type === 'ext-link-url', this.getAttribute('config'));
+			token.append(...cloned);
+			token.afterBuild();
+			return token;
+		});
 	}
 
 	/**
@@ -96,11 +116,18 @@ class MagicLinkToken extends Token {
 	setTarget(url) {
 		url = String(url);
 		const root = Parser.parse(url, this.getAttribute('include'), 9, this.getAttribute('config')),
-			{childNodes: {length}, firstElementChild} = root;
-		if (length !== 1 || firstElementChild?.type !== 'free-ext-link') {
+			{length, firstChild: freeExtLink} = root;
+		if (length !== 1 || freeExtLink.type !== 'free-ext-link') {
 			throw new SyntaxError(`非法的自由外链目标：${url}`);
 		}
-		this.replaceChildren(...firstElementChild.childNodes);
+		this.replaceChildren(...freeExtLink.childNodes);
+	}
+
+	/** 是否是模板或魔术字参数 */
+	isParamValue() {
+		const ParameterToken = require('./parameter');
+		const /** @type {ParameterToken} */ parameter = this.closest('parameter');
+		return parameter?.getValue() === this.text();
 	}
 }
 

package/src/nested/choose.js

@@ -0,0 +1,24 @@
+'use strict';
+
+const Parser = require('../..'),
+	NestedToken = require('.');
+
+/**
+ * `<choose>`
+ * @classdesc `{childNodes: [...ExtToken|NoincludeToken]}`
+ */
+class ChooseToken extends NestedToken {
+	name = 'choose';
+
+	/**
+	 * @param {string|undefined} wikitext wikitext
+	 * @param {accum} accum
+	 */
+	constructor(wikitext, config = Parser.getConfig(), accum = []) {
+		const regex = /<(option|choicetemplate)(\s[^>]*)?>(.*?)<\/(\1)>/gsu;
+		super(wikitext, regex, ['option', 'choicetemplate'], config, accum);
+	}
+}
+
+Parser.classes.ChooseToken = __filename;
+module.exports = ChooseToken;

package/src/nested/combobox.js

@@ -0,0 +1,23 @@
+'use strict';
+
+const Parser = require('../..'),
+	NestedToken = require('.');
+
+/**
+ * `<combobox>`
+ * @classdesc `{childNodes: [...ExtToken|NoincludeToken]}`
+ */
+class ComboboxToken extends NestedToken {
+	name = 'combobox';
+
+	/**
+	 * @param {string|undefined} wikitext wikitext
+	 * @param {accum} accum
+	 */
+	constructor(wikitext, config = Parser.getConfig(), accum = []) {
+		super(wikitext, /<(combooption)(\s[^>]*)?>(.*?)<\/(combooption\s*)>/gisu, ['combooption'], config, accum);
+	}
+}
+
+Parser.classes.ComboboxToken = __filename;
+module.exports = ComboboxToken;

package/src/nested/index.js

@@ -0,0 +1,88 @@
+'use strict';
+
+const {generateForChild} = require('../../util/lint'),
+	Parser = require('../..'),
+	Token = require('..');
+
+/**
+ * 嵌套式的扩展标签
+ * @classdesc `{childNodes: [...ExtToken|NoincludeToken]}`
+ */
+class NestedToken extends Token {
+	type = 'ext-inner';
+	#tags;
+
+	/**
+	 * @param {string|undefined} wikitext wikitext
+	 * @param {RegExp} regex 内层正则
+	 * @param {string[]} tags 内层标签名
+	 * @param {accum} accum
+	 */
+	constructor(wikitext, regex, tags, config = Parser.getConfig(), accum = []) {
+		const ExtToken = require('../tagPair/ext'),
+			NoincludeToken = require('../nowiki/noinclude');
+		const text = wikitext?.replaceAll(
+			regex,
+			/** @type {function(...string): string} */ (_, name, attr, inner, closing) => {
+				const str = `\0${accum.length + 1}e\x7F`;
+				new ExtToken(name, attr, inner, closing, config, accum);
+				return str;
+			},
+		)?.replaceAll(/(?<=^|\0\d+e\x7F).*?(?=$|\0\d+e\x7F)/gsu, substr => {
+			if (substr === '') {
+				return '';
+			}
+			new NoincludeToken(substr, config, accum);
+			return `\0${accum.length}c\x7F`;
+		});
+		super(text, config, true, accum, {NoincludeToken: ':', ExtToken: ':'});
+		this.#tags = tags;
+	}
+
+	/**
+	 * @override
+	 * @param {number} start 起始位置
+	 */
+	lint(start = 0) {
+		let rect;
+		return [
+			...super.lint(start),
+			...this.childNodes.filter(child => {
+				if (child.type === 'ext') {
+					return false;
+				}
+				const str = String(child).trim();
+				return str && !/^<!--.*-->$/u.test(str);
+			}).map(child => {
+				rect ||= this.getRootNode().posFromIndex(start);
+				return generateForChild(child, rect, `<${this.name}>内的无效内容`);
+			}),
+		];
+	}
+
+	/**
+	 * @override
+	 * @template {string|Token} T
+	 * @param {T} token 待插入的子节点
+	 * @param {number} i 插入位置
+	 */
+	insertAt(token, i = this.childNodes.length) {
+		return token.type === 'ext' && !this.#tags.includes(token.name)
+			? this.typeError(`${this.constructor.name}只能以${this.#tags.join('或')}标签作为子节点！`)
+			: super.insertAt(token, i);
+	}
+
+	/** @override */
+	cloneNode() {
+		const cloned = this.cloneChildNodes(),
+			config = this.getAttribute('config');
+		return Parser.run(() => {
+			const token = new this.constructor(undefined, config);
+			token.append(...cloned);
+			return token;
+		});
+	}
+}
+
+Parser.classes.NestedToken = __filename;
+module.exports = NestedToken;

package/src/nested/references.js

@@ -0,0 +1,23 @@
+'use strict';
+
+const Parser = require('../..'),
+	NestedToken = require('.');
+
+/**
+ * `<references>`
+ * @classdesc `{childNodes: [...ExtToken|NoincludeToken]}`
+ */
+class ReferencesToken extends NestedToken {
+	name = 'references';
+
+	/**
+	 * @param {string|undefined} wikitext wikitext
+	 * @param {accum} accum
+	 */
+	constructor(wikitext, config = Parser.getConfig(), accum = []) {
+		super(wikitext, /<(ref)(\s[^>]*)?>(.*?)<\/(ref\s*)>/gisu, ['ref'], config, accum);
+	}
+}
+
+Parser.classes.ReferencesToken = __filename;
+module.exports = ReferencesToken;

package/src/nowiki/comment.js

@@ -1,6 +1,7 @@
 'use strict';
 
 const hidden = require('../../mixin/hidden'),
+	{generateForSelf} = require('../../util/lint'),
 	Parser = require('../..'),
 	NowikiToken = require('.');
 
@@ -29,8 +30,21 @@ class CommentToken extends hidden(NowikiToken) {
 	}
 
 	/** @override */
-	cloneNode() {
-		return Parser.run(() => new CommentToken(String(this.firstChild), this.closed, this.getAttribute('config')));
+	getPadding() {
+		return 4;
+	}
+
+	/** @override */
+	print() {
+		return super.print({pre: '<!--', post: this.closed ? '-->' : ''});
+	}
+
+	/**
+	 * @override
+	 * @param {number} start 起始位置
+	 */
+	lint(start = 0) {
+		return this.closed ? [] : [generateForSelf(this, this.getRootNode().posFromIndex(start), '未闭合的HTML注释')];
 	}
 
 	/**
@@ -48,8 +62,8 @@ class CommentToken extends hidden(NowikiToken) {
 	}
 
 	/** @override */
-	getPadding() {
-		return 4;
+	cloneNode() {
+		return Parser.run(() => new CommentToken(String(this.firstChild), this.closed, this.getAttribute('config')));
 	}
 }
 

package/src/nowiki/dd.js

@@ -32,9 +32,9 @@ class DdToken extends NowikiToken {
 
 	set indent(indent) {
 		if (this.type === 'dd') {
-			if (typeof indent !== 'number') {
+			if (!Number.isInteger(indent)) {
 				this.typeError('set indent', 'Number');
-			} else if (!Number.isInteger(indent) || indent < 0) {
+			} else if (indent < 0) {
 				throw new RangeError(`indent 应为自然数！${indent}`);
 			}
 			this.setText(':'.repeat(indent));

package/src/nowiki/doubleUnderscore.js

@@ -11,18 +11,14 @@ const hidden = require('../../mixin/hidden'),
 class DoubleUnderscoreToken extends hidden(NowikiToken) {
 	type = 'double-underscore';
 
-	/**
-	 * @param {string} word 状态开关名
-	 * @param {accum} accum
-	 */
-	constructor(word, config = Parser.getConfig(), accum = []) {
-		super(word, config, accum);
-		this.setAttribute('name', word.toLowerCase());
+	/** @override */
+	getPadding() {
+		return 2;
 	}
 
 	/** @override */
-	cloneNode() {
-		return Parser.run(() => new DoubleUnderscoreToken(String(this.firstChild), this.getAttribute('config')));
+	print() {
+		return super.print({pre: '__', post: '__'});
 	}
 
 	/**
@@ -33,9 +29,18 @@ class DoubleUnderscoreToken extends hidden(NowikiToken) {
 		return selector && this.matches(selector) ? '' : `__${String(this.firstChild)}__`;
 	}
 
+	/**
+	 * @param {string} word 状态开关名
+	 * @param {accum} accum
+	 */
+	constructor(word, config = Parser.getConfig(), accum = []) {
+		super(word, config, accum);
+		this.setAttribute('name', word.toLowerCase());
+	}
+
 	/** @override */
-	getPadding() {
-		return 2;
+	cloneNode() {
+		return Parser.run(() => new DoubleUnderscoreToken(String(this.firstChild), this.getAttribute('config')));
 	}
 
 	/**

package/src/nowiki/index.js

@@ -1,6 +1,7 @@
 'use strict';
 
 const fixedToken = require('../../mixin/fixedToken'),
+	{generateForSelf} = require('../../util/lint'),
 	Parser = require('../..'),
 	Token = require('..'),
 	AstText = require('../../lib/text');
@@ -20,6 +21,17 @@ class NowikiToken extends fixedToken(Token) {
 		super(wikitext, config, true, accum);
 	}
 
+	/**
+	 * @override
+	 * @param {number} start 起始位置
+	 */
+	lint(start = 0) {
+		const {type, name} = this;
+		return type === 'ext-inner' && (name === 'templatestyles' || name === 'section') && String(this)
+			? [generateForSelf(this, this.getRootNode().posFromIndex(start), `<${name}>标签内不应有任何内容`)]
+			: super.lint(start);
+	}
+
 	/**
 	 * @override
 	 * @this {NowikiToken & {firstChild: AstText, constructor: typeof NowikiToken}}

package/src/nowiki/quote.js

@@ -1,6 +1,8 @@
 'use strict';
 
-const Parser = require('../..'),
+const {generateForSelf} = require('../../util/lint'),
+	Parser = require('../..'),
+	AstText = require('../../lib/text'),
 	NowikiToken = require('.');
 
 /**
@@ -19,6 +21,31 @@ class QuoteToken extends NowikiToken {
 		this.setAttribute('name', String(n));
 	}
 
+	/**
+	 * @override
+	 * @this {AstText}
+	 * @param {number} start 起始位置
+	 */
+	lint(start = 0) {
+		const {previousSibling, nextSibling} = this,
+			message = `孤立的"'"`,
+			/** @type {LintError[]} */ errors = [];
+		let /** @type {LintError} */ refError;
+		if (previousSibling?.type === 'text' && previousSibling.data.at(-1) === "'") {
+			refError = generateForSelf(this, this.getRootNode().posFromIndex(start), '');
+			const {startLine, startCol} = refError,
+				[{length}] = previousSibling.data.match(/(?<!')'+$/u);
+			errors.push({message, startLine, startCol: startCol - length, endLine: startLine, endCol: startCol});
+		}
+		if (nextSibling?.type === 'text' && nextSibling.data[0] === "'") {
+			refError ||= generateForSelf(this, this.getRootNode().posFromIndex(start), '');
+			const {endLine, endCol} = refError,
+				[{length}] = nextSibling.data.match(/^'+/u);
+			errors.push({message, startLine: endLine, startCol: endCol, endLine, endCol: endCol + length});
+		}
+		return errors;
+	}
+
 	/**
 	 * @override
 	 * @param {string} str 新文本

package/src/onlyinclude.js

@@ -23,14 +23,6 @@ class OnlyincludeToken extends Token {
 		super(inner, config, true, accum);
 	}
 
-	/** @override */
-	cloneNode() {
-		const cloned = this.cloneChildNodes(),
-			token = Parser.run(() => new OnlyincludeToken(undefined, this.getAttribute('config')));
-		token.append(...cloned);
-		return token;
-	}
-
 	/**
 	 * @override
 	 * @param {string} selector
@@ -44,10 +36,25 @@ class OnlyincludeToken extends Token {
 		return 13;
 	}
 
+	/** @override */
+	print() {
+		return super.print({pre: '<onlyinclude>', post: '</onlyinclude>'});
+	}
+
 	/** @override */
 	isPlain() {
 		return true;
 	}
+
+	/** @override */
+	cloneNode() {
+		const cloned = this.cloneChildNodes();
+		return Parser.run(() => {
+			const token = new OnlyincludeToken(undefined, this.getAttribute('config'));
+			token.append(...cloned);
+			return token;
+		});
+	}
 }
 
 Parser.classes.OnlyincludeToken = __filename;

package/src/paramTag/index.js

@@ -0,0 +1,83 @@
+'use strict';
+
+const {generateForChild} = require('../../util/lint'),
+	Parser = require('../..'),
+	Token = require('..'),
+	AtomToken = require('../atom');
+
+/**
+ * `<inputbox>`
+ * @classdesc `{childNodes: ...AtomToken}`
+ */
+class ParamTagToken extends Token {
+	type = 'ext-inner';
+
+	/**
+	 * @param {string} wikitext wikitext
+	 * @param {accum} accum
+	 */
+	constructor(wikitext, config = Parser.getConfig(), accum = []) {
+		super(undefined, config, true, accum, {AtomToken: ':'});
+		if (wikitext) {
+			this.append(
+				...wikitext.split('\n').map(line => new AtomToken(line, 'param-line', config, accum, {AstText: ':'})),
+			);
+		}
+	}
+
+	/**
+	 * @override
+	 * @param {string} selector
+	 */
+	toString(selector) {
+		return super.toString(selector, '\n');
+	}
+
+	/** @override */
+	getGaps() {
+		return 1;
+	}
+
+	/** @override */
+	print() {
+		return super.print({sep: '\n'});
+	}
+
+	/**
+	 * @override
+	 * @param {number} start 起始位置
+	 */
+	lint(start = 0) {
+		let /** @type {{top: number, left: number}} */ rect;
+		return this.childNodes.filter(child => {
+			const {childNodes} = child,
+				i = childNodes.findIndex(({type}) => type !== 'text'),
+				str = (i >= 0 ? childNodes.slice(0, i).map(String).join('') : String(child)).trim();
+			return str && !(i >= 0 ? /^[a-z]+\s*(?:=|$)/iu : /^[a-z]+\s*=/iu).test(str);
+		}).map(child => {
+			rect ||= this.getRootNode().posFromIndex(start);
+			return generateForChild(child, rect, `${this.name}的无效参数`);
+		});
+	}
+
+	/** @override */
+	text() {
+		return super.text('\n');
+	}
+
+	/**
+	 * @override
+	 * @this {ParamTagToken & {constructor: typeof ParamTagToken}}
+	 */
+	cloneNode() {
+		const cloned = this.cloneChildNodes();
+		return Parser.run(() => {
+			const token = new this.constructor(undefined, this.getAttribute('config'));
+			token.append(...cloned);
+			return token;
+		});
+	}
+}
+
+Parser.classes.ParamTagToken = __filename;
+module.exports = ParamTagToken;

package/src/paramTag/inputbox.js

@@ -0,0 +1,42 @@
+'use strict';
+
+const parseBrackets = require('../../parser/brackets'),
+	Parser = require('../..'),
+	ParamTagToken = require('.'),
+	AtomToken = require('../atom');
+
+/**
+ * `<inputbox>`
+ * @classdesc `{childNodes: ...AtomToken}`
+ */
+class InputboxToken extends ParamTagToken {
+	name = 'inputbox';
+
+	/**
+	 * @param {string} wikitext wikitext
+	 * @param {accum} accum
+	 */
+	constructor(wikitext, config = Parser.getConfig(), accum = []) {
+		super(undefined, config, accum);
+		wikitext = parseBrackets(wikitext, config, accum);
+		accum.splice(accum.indexOf(this), 1);
+		accum.push(this);
+		if (wikitext) {
+			this.append(...wikitext.split('\n').map(line => new AtomToken(
+				line, 'param-line', config, accum, {AstText: ':', ArgToken: ':', TranscludeToken: ':'},
+			)));
+		}
+	}
+
+	/** @override */
+	afterBuild() {
+		for (const heading of this.querySelectorAll('heading')) {
+			const {firstChild, lastChild, name} = heading,
+				syntax = '='.repeat(name);
+			heading.replaceWith(syntax, ...firstChild.cloneChildNodes(), `${syntax}${String(lastChild)}`);
+		}
+	}
+}
+
+Parser.classes.InputboxToken = __filename;
+module.exports = InputboxToken;