wikiparser-node 0.3.1 → 0.5.0

package/src/heading.js

@@ -1,8 +1,9 @@
 'use strict';
 
-const fixedToken = require('../mixin/fixedToken'),
+const {generateForSelf} = require('../util/lint'),
+	fixedToken = require('../mixin/fixedToken'),
 	sol = require('../mixin/sol'),
-	/** @type {Parser} */ Parser = require('..'),
+	Parser = require('..'),
 	Token = require('.');
 
 /**
@@ -12,9 +13,14 @@ const fixedToken = require('../mixin/fixedToken'),
 class HeadingToken extends fixedToken(sol(Token)) {
 	type = 'heading';
 
+	/** 内部wikitext */
+	get innerText() {
+		return this.firstChild.text();
+	}
+
 	/**
-	 * @param {number} level
-	 * @param {string[]} input
+	 * @param {number} level 标题层级
+	 * @param {string[]} input 标题文字
 	 * @param {accum} accum
 	 */
 	constructor(level, input, config = Parser.getConfig(), accum = []) {
@@ -23,57 +29,89 @@ class HeadingToken extends fixedToken(sol(Token)) {
 		const token = new Token(input[0], config, true, accum);
 		token.type = 'heading-title';
 		token.setAttribute('name', this.name).setAttribute('stage', 2);
-		const SyntaxToken = require('./syntax'),
-			trail = new SyntaxToken(input[1], /^[^\S\n]*$/, 'heading-trail', config, accum, {
-				'Stage-1': ':', '!ExtToken': '',
-			});
+		const SyntaxToken = require('./syntax');
+		const trail = new SyntaxToken(input[1], /^[^\S\n]*$/u, 'heading-trail', config, accum, {
+			'Stage-1': ':', '!ExtToken': '',
+		});
 		this.append(token, trail);
 	}
 
+	/** @override */
 	cloneNode() {
-		const [title, trail] = this.cloneChildren(),
+		const [title, trail] = this.cloneChildNodes(),
 			token = Parser.run(() => new HeadingToken(Number(this.name), [], this.getAttribute('config')));
-		token.firstElementChild.safeReplaceWith(title);
-		token.lastElementChild.safeReplaceWith(trail);
+		token.firsthild.safeReplaceWith(title);
+		token.lastChild.safeReplaceWith(trail);
 		return token;
 	}
 
-	/** @this {HeadingToken & {prependNewLine(): ''|'\n', appendNewLine(): ''|'\n'}} */
-	toString() {
+	/**
+	 * @override
+	 * @this {{prependNewLine(): ''|'\n', appendNewLine(): ''|'\n'} & HeadingToken}
+	 * @param {string} selector
+	 */
+	toString(selector) {
 		const equals = '='.repeat(Number(this.name));
-		return `${this.prependNewLine()}${equals}${
-			this.firstElementChild.toString()
-		}${equals}${this.lastElementChild.toString()}${this.appendNewLine()}`;
+		return selector && this.matches(selector)
+			? ''
+			: `${this.prependNewLine()}${equals}${
+				this.firstChild.toString(selector)
+			}${equals}${this.lastChild.toString(selector)}${this.appendNewLine()}`;
 	}
 
+	/** @override */
 	getPadding() {
 		return super.getPadding() + Number(this.name);
 	}
 
+	/** @override */
 	getGaps() {
 		return Number(this.name);
 	}
 
+	/** @override */
+	print() {
+		const equals = '='.repeat(Number(this.name));
+		return super.print({pre: equals, sep: equals});
+	}
+
 	/**
+	 * @override
+	 * @param {number} start 起始位置
+	 */
+	lint(start = 0) {
+		const errors = super.lint(start);
+		if (this.name === '1') {
+			errors.push(generateForSelf(this, this.getRootNode().posFromIndex(start), '<h1>'));
+		}
+		return errors;
+	}
+
+	/**
+	 * @override
 	 * @this {HeadingToken & {prependNewLine(): ''|'\n', appendNewLine(): ''|'\n'}}
 	 * @returns {string}
 	 */
 	text() {
 		const equals = '='.repeat(Number(this.name));
-		return `${this.prependNewLine()}${equals}${this.firstElementChild.text()}${equals}${this.appendNewLine()}`;
+		return `${this.prependNewLine()}${equals}${this.firstChild.text()}${equals}${this.appendNewLine()}`;
 	}
 
-	/** @param {number} n */
+	/**
+	 * 设置标题层级
+	 * @param {number} n 标题层级
+	 */
 	setLevel(n) {
 		if (typeof n !== 'number') {
 			this.typeError('setLevel', 'Number');
 		}
 		n = Math.min(Math.max(n, 1), 6);
-		this.setAttribute('name', String(n)).firstElementChild.setAttribute('name', this.name);
+		this.setAttribute('name', String(n)).firstChild.setAttribute('name', this.name);
 	}
 
+	/** 移除标题后的不可见内容 */
 	removeTrail() {
-		this.lastElementChild.replaceChildren();
+		this.lastChild.replaceChildren();
 	}
 }
 

package/src/html.js

@@ -1,9 +1,10 @@
 'use strict';
 
 const {noWrap} = require('../util/string'),
+	{generateForSelf} = require('../util/lint'),
 	fixedToken = require('../mixin/fixedToken'),
 	attributeParent = require('../mixin/attributeParent'),
-	/** @type {Parser} */ Parser = require('..'),
+	Parser = require('..'),
 	Token = require('.');
 
 /**
@@ -12,57 +13,136 @@ const {noWrap} = require('../util/string'),
  */
 class HtmlToken extends attributeParent(fixedToken(Token)) {
 	type = 'html';
-	closing;
-	selfClosing;
+	#closing;
+	#selfClosing;
 	#tag;
 
+	/** getter */
+	get closing() {
+		return this.#closing;
+	}
+
+	/** @throws `Error` 自闭合标签或空标签 */
+	set closing(value) {
+		if (!value) {
+			this.#closing = false;
+			return;
+		} else if (this.#selfClosing) {
+			throw new Error(`这是一个自闭合标签！`);
+		}
+		const {html: [,, tags]} = this.getAttribute('config');
+		if (tags.includes(this.name)) {
+			throw new Error(`这是一个空标签！`);
+		}
+		this.#closing = true;
+	}
+
+	/** getter */
+	get selfClosing() {
+		return this.#selfClosing;
+	}
+
+	/** @throws `Error` 闭合标签或无效自闭合标签 */
+	set selfClosing(value) {
+		if (!value) {
+			this.#selfClosing = false;
+			return;
+		} else if (this.#closing) {
+			throw new Error('这是一个闭合标签！');
+		}
+		const {html: [tags]} = this.getAttribute('config');
+		if (tags.includes(this.name)) {
+			throw new Error(`<${this.name}>标签自闭合无效！`);
+		}
+		this.#selfClosing = true;
+	}
+
 	/**
-	 * @param {string} name
-	 * @param {AttributeToken} attr
-	 * @param {boolean} closing
-	 * @param {boolean} selfClosing
+	 * @param {string} name 标签名
+	 * @param {AttributeToken} attr 标签属性
+	 * @param {boolean} closing 是否闭合
+	 * @param {boolean} selfClosing 是否自封闭
 	 * @param {accum} accum
 	 */
 	constructor(name, attr, closing, selfClosing, config = Parser.getConfig(), accum = []) {
 		super(undefined, config, true, accum);
 		this.appendChild(attr);
 		this.setAttribute('name', name.toLowerCase());
-		this.closing = closing;
-		this.selfClosing = selfClosing;
+		this.#closing = closing;
+		this.#selfClosing = selfClosing;
 		this.#tag = name;
 	}
 
+	/** @override */
 	cloneNode() {
-		const [attr] = this.cloneChildren(),
+		const [attr] = this.cloneChildNodes(),
 			config = this.getAttribute('config');
-		return Parser.run(() => new HtmlToken(this.#tag, attr, this.closing, this.selfClosing, config));
+		return Parser.run(() => new HtmlToken(this.#tag, attr, this.#closing, this.#selfClosing, config));
 	}
 
 	/**
+	 * @override
 	 * @template {string} T
-	 * @param {T} key
+	 * @param {T} key 属性键
 	 * @returns {TokenAttribute<T>}
 	 */
 	getAttribute(key) {
-		if (key === 'tag') {
-			return this.#tag;
-		}
-		return super.getAttribute(key);
+		return key === 'tag' ? this.#tag : super.getAttribute(key);
 	}
 
-	toString() {
-		return `<${this.closing ? '/' : ''}${this.#tag}${super.toString()}${this.selfClosing ? '/' : ''}>`;
+	/**
+	 * @override
+	 * @param {string} selector
+	 */
+	toString(selector) {
+		return selector && this.matches(selector)
+			? ''
+			: `<${this.#closing ? '/' : ''}${this.#tag}${super.toString(selector)}${this.#selfClosing ? '/' : ''}>`;
 	}
 
+	/** @override */
 	getPadding() {
-		return this.#tag.length + (this.closing ? 2 : 1);
+		return this.#tag.length + (this.#closing ? 2 : 1);
+	}
+
+	/** @override */
+	print() {
+		return super.print({
+			pre: `&lt;${this.#closing ? '/' : ''}${this.#tag}`, post: `${this.#selfClosing ? '/' : ''}&gt;`,
+		});
+	}
+
+	/**
+	 * @override
+	 * @param {number} start 起始位置
+	 */
+	lint(start = 0) {
+		const errors = super.lint(start);
+		let /** @type {LintError} */ refError;
+		if (this.name === 'h1' && !this.#closing) {
+			refError = generateForSelf(this, this.getRootNode().posFromIndex(start), '<h1>');
+			errors.push(refError);
+		}
+		try {
+			this.findMatchingTag();
+		} catch ({message: errorMsg}) {
+			const [message] = errorMsg.split('：');
+			refError ||= generateForSelf(this, this.getRootNode().posFromIndex(start), '');
+			errors.push({...refError, message, severity: message === '未闭合的标签' ? 'warning' : 'error'});
+		}
+		return errors;
 	}
 
+	/** @override */
 	text() {
-		return `<${this.closing ? '/' : ''}${this.#tag}${super.text()}${this.selfClosing ? '/' : ''}>`;
+		return `<${this.#closing ? '/' : ''}${this.#tag}${super.text()}${this.#selfClosing ? '/' : ''}>`;
 	}
 
-	/** @param {string} tag */
+	/**
+	 * 更换标签名
+	 * @param {string} tag 标签名
+	 * @throws `RangeError` 非法的HTML标签
+	 */
 	replaceTag(tag) {
 		const name = tag.toLowerCase();
 		if (!this.getAttribute('config').html.flat().includes(name)) {
@@ -71,27 +151,32 @@ class HtmlToken extends attributeParent(fixedToken(Token)) {
 		this.setAttribute('name', name).#tag = tag;
 	}
 
-	/** @complexity `n` */
+	/**
+	 * 搜索匹配的标签
+	 * @complexity `n`
+	 * @throws `SyntaxError` 同时闭合和自封闭的标签
+	 * @throws `SyntaxError` 无效自封闭标签
+	 * @throws `SyntaxError` 未闭合的标签
+	 */
 	findMatchingTag() {
 		const {html} = this.getAttribute('config'),
-			{name, parentElement, closing, selfClosing} = this,
-			string = noWrap(this.toString());
-		if (closing && selfClosing) {
+			{name: tagName, parentNode} = this,
+			string = noWrap(String(this));
+		if (this.#closing && this.#selfClosing) {
 			throw new SyntaxError(`同时闭合和自封闭的标签：${string}`);
-		} else if (html[2].includes(name) || selfClosing && html[1].includes(name)) { // 自封闭标签
+		} else if (html[2].includes(tagName) || this.#selfClosing && html[1].includes(tagName)) { // 自封闭标签
 			return this;
-		} else if (selfClosing && html[0].includes(name)) {
+		} else if (this.#selfClosing && html[0].includes(tagName)) {
 			throw new SyntaxError(`无效自封闭标签：${string}`);
-		} else if (!parentElement) {
-			return;
+		} else if (!parentNode) {
+			return undefined;
 		}
-		const {children} = parentElement,
-			i = children.indexOf(this),
-			selector = `html#${name}`,
-			siblings = closing
-				? children.slice(0, i).reverse().filter(child => child.matches(selector))
-				: children.slice(i + 1).filter(child => child.matches(selector));
-		let imbalance = closing ? -1 : 1;
+		const {childNodes} = parentNode,
+			i = childNodes.indexOf(this),
+			siblings = this.#closing
+				? childNodes.slice(0, i).reverse().filter(({type, name}) => type === 'html' && name === tagName)
+				: childNodes.slice(i + 1).filter(({type, name}) => type === 'html' && name === tagName);
+		let imbalance = this.#closing ? -1 : 1;
 		for (const token of siblings) {
 			if (token.closing) {
 				imbalance--;
@@ -102,35 +187,40 @@ class HtmlToken extends attributeParent(fixedToken(Token)) {
 				return token;
 			}
 		}
-		throw new SyntaxError(`未${closing ? '匹配的闭合' : '闭合的'}标签：${string}`);
+		throw new SyntaxError(`未${this.#closing ? '匹配的闭合' : '闭合的'}标签：${string}`);
 	}
 
+	/** 局部闭合 */
 	#localMatch() {
-		this.selfClosing = false;
+		this.#selfClosing = false;
 		const root = Parser.parse(`</${this.name}>`, false, 3, this.getAttribute('config'));
 		this.after(root.firstChild);
 	}
 
-	/** @complexity `n` */
+	/**
+	 * 修复无效自封闭标签
+	 * @complexity `n`
+	 * @throws `Error` 无法修复无效自封闭标签
+	 */
 	fix() {
 		const config = this.getAttribute('config'),
-			{parentElement, selfClosing, name, firstElementChild} = this;
-		if (!parentElement || !selfClosing || !config.html[0].includes(name)) {
+			{parentNode, name: tagName, firstChild} = this;
+		if (!parentNode || !this.#selfClosing || !config.html[0].includes(tagName)) {
 			return;
-		} else if (firstElementChild.text().trim()) {
+		} else if (firstChild.text().trim()) {
 			this.#localMatch();
 			return;
 		}
-		const {children} = parentElement,
-			i = children.indexOf(this),
+		const {childNodes} = parentNode,
+			i = childNodes.indexOf(this),
 			/** @type {HtmlToken[]} */
-			prevSiblings = children.slice(0, i).filter(child => child.matches(`html#${name}`)),
+			prevSiblings = childNodes.slice(0, i).filter(({type, name}) => type === 'html' && name === tagName),
 			imbalance = prevSiblings.reduce((acc, {closing}) => acc + (closing ? 1 : -1), 0);
 		if (imbalance < 0) {
-			this.selfClosing = false;
-			this.closing = true;
+			this.#selfClosing = false;
+			this.#closing = true;
 		} else {
-			Parser.warn('无法修复无效自封闭标签', noWrap(this.toString()));
+			Parser.warn('无法修复无效自封闭标签', noWrap(String(this)));
 			throw new Error(`无法修复无效自封闭标签：前文共有 ${imbalance} 个未匹配的闭合标签`);
 		}
 	}