wikiparser-node 0.9.2-b → 0.10.0

package/src/tagPair/ext.js

@@ -0,0 +1,145 @@
+'use strict';
+
+const {generateForSelf} = require('../../util/lint'),
+	attributeParent = require('../../mixin/attributeParent'),
+	Parser = require('../..'),
+	Token = require('..'),
+	TagPairToken = require('.'),
+	AttributesToken = require('../attributes');
+
+/**
+ * 扩展标签
+ * @classdesc `{childNodes: [AttributesToken, NowikiToken|Token]}`
+ */
+class ExtToken extends attributeParent(TagPairToken) {
+	type = 'ext';
+	closed = true;
+
+	/**
+	 * @param {string} name 标签名
+	 * @param {string} attr 标签属性
+	 * @param {string} inner 内部wikitext
+	 * @param {string|undefined} closed 是否封闭
+	 * @param {accum} accum
+	 */
+	constructor(name, attr = '', inner = '', closed = undefined, config = Parser.getConfig(), accum = []) {
+		attr = !attr || attr.trimStart() !== attr ? attr : ` ${attr}`;
+		const lcName = name.toLowerCase(),
+			attrToken = new AttributesToken(attr, 'ext-attrs', lcName, config, accum),
+			/** @type {ParserConfig} */ newConfig = {...config, excludes: [...config.excludes]},
+			ext = new Set(newConfig.ext);
+		let /** @type {Token} */ innerToken;
+		ext.delete(lcName);
+		newConfig.ext = [...ext];
+		switch (lcName) {
+			case 'tab':
+				ext.delete('tabs');
+				newConfig.ext = [...ext];
+				// fall through
+			case 'indicator':
+			case 'poem':
+			case 'ref':
+			case 'option':
+			case 'combooption':
+			case 'tabs':
+			case 'poll':
+			case 'seo':
+				if (lcName === 'poem') {
+					newConfig.excludes.push('heading');
+				}
+				innerToken = new Token(inner, newConfig, true, accum);
+				break;
+			case 'gallery': {
+				const GalleryToken = require('../gallery');
+				innerToken = new GalleryToken(inner, newConfig, accum);
+				break;
+			}
+			case 'pre': {
+				const PreToken = require('../hasNowiki/pre');
+				innerToken = new PreToken(inner, newConfig, accum);
+				break;
+			}
+			case 'charinsert': {
+				const CharinsertToken = require('../charinsert');
+				innerToken = new CharinsertToken(inner, newConfig, accum);
+				break;
+			}
+			case 'references': {
+				const ReferencesToken = require('../nested/references');
+				innerToken = new ReferencesToken(inner, newConfig, accum);
+				break;
+			}
+			case 'choose': {
+				const ChooseToken = require('../nested/choose');
+				innerToken = new ChooseToken(inner, newConfig, accum);
+				break;
+			}
+			case 'combobox': {
+				const ComboboxToken = require('../nested/combobox');
+				innerToken = new ComboboxToken(inner, newConfig, accum);
+				break;
+			}
+			case 'imagemap': {
+				const ImagemapToken = require('../imagemap');
+				innerToken = new ImagemapToken(inner, config, accum);
+				break;
+			}
+			case 'dynamicpagelist': {
+				const ParamTagToken = require('../paramTag');
+				innerToken = new ParamTagToken(inner, newConfig, accum);
+				break;
+			}
+			case 'inputbox': {
+				newConfig.excludes.push('heading');
+				const InputboxToken = require('../paramTag/inputbox');
+				innerToken = new InputboxToken(inner, newConfig, accum);
+				break;
+			}
+			// 更多定制扩展的代码示例：
+			// ```
+			// case 'extensionName': {
+			// 	const ExtensionToken = require('../extension');
+			// 	innerToken = new ExtensionToken(inner, newConfig, accum);
+			// 	break;
+			// }
+			// ```
+			default: {
+				const NowikiToken = require('../nowiki');
+				innerToken = new NowikiToken(inner, config);
+			}
+		}
+		innerToken.setAttribute('name', lcName).type = 'ext-inner';
+		super(name, attrToken, innerToken, closed, config, accum);
+	}
+
+	/**
+	 * @override
+	 * @param {number} start 起始位置
+	 */
+	lint(start = this.getAbsoluteIndex()) {
+		const errors = super.lint(start);
+		if (this.name !== 'nowiki' && this.closest('html-attrs, table-attrs')) {
+			const root = this.getRootNode(),
+				excerpt = String(root).slice(Math.max(0, start - 25), start + 25),
+				rect = {start, ...root.posFromIndex(start)};
+			errors.push({...generateForSelf(this, rect, 'extension tag in HTML tag attributes'), excerpt});
+		}
+		return errors;
+	}
+
+	/** @override */
+	cloneNode() {
+		const inner = this.lastChild.cloneNode(),
+			tags = this.getAttribute('tags'),
+			config = this.getAttribute('config'),
+			attr = String(this.firstChild);
+		return Parser.run(() => {
+			const token = new ExtToken(tags[0], attr, '', this.selfClosing ? undefined : tags[1], config);
+			token.lastChild.safeReplaceWith(inner);
+			return token;
+		});
+	}
+}
+
+Parser.classes.ExtToken = __filename;
+module.exports = ExtToken;

package/src/tagPair/include.js

@@ -0,0 +1,50 @@
+'use strict';
+
+const hidden = require('../../mixin/hidden'),
+	Parser = require('../..'),
+	TagPairToken = require('.');
+
+/**
+ * `<includeonly>`或`<noinclude>`
+ * @classdesc `{childNodes: [AstText, AstText]}`
+ */
+class IncludeToken extends hidden(TagPairToken) {
+	type = 'include';
+
+	/**
+	 * @param {string} name 标签名
+	 * @param {string} attr 标签属性
+	 * @param {string|undefined} inner 内部wikitext
+	 * @param {string|undefined} closed 是否封闭
+	 * @param {accum} accum
+	 */
+	constructor(name, attr = '', inner = undefined, closed = undefined, config = Parser.getConfig(), accum = []) {
+		super(name, attr, inner ?? '', inner === undefined ? closed : closed ?? '', config, accum);
+	}
+
+	/** @override */
+	cloneNode() {
+		const tags = this.getAttribute('tags'),
+			config = this.getAttribute('config'),
+			inner = this.selfClosing ? undefined : String(this.lastChild),
+			closing = this.selfClosing || !this.closed ? undefined : tags[1],
+			token = Parser.run(() => new IncludeToken(tags[0], String(this.firstChild), inner, closing, config));
+		return token;
+	}
+
+	/**
+	 * @override
+	 * @param {string} str 新文本
+	 */
+	setText(str) {
+		return super.setText(str, 1);
+	}
+
+	/** 清除标签属性 */
+	removeAttr() {
+		super.setText('', 0);
+	}
+}
+
+Parser.classes.IncludeToken = __filename;
+module.exports = IncludeToken;

package/src/tagPair/index.js

@@ -0,0 +1,126 @@
+'use strict';
+
+const Parser = require('../..'),
+	fixedToken = require('../../mixin/fixedToken'),
+	Token = require('..');
+
+/**
+ * 成对标签
+ * @classdesc `{childNodes: [AstText|AttributesToken, AstText|Token]}`
+ */
+class TagPairToken extends fixedToken(Token) {
+	#selfClosing;
+	#closed;
+	#tags;
+
+	/** getter */
+	get closed() {
+		return this.#closed;
+	}
+
+	set closed(value) {
+		this.#closed ||= Boolean(value);
+	}
+
+	/** getter */
+	get selfClosing() {
+		return this.#selfClosing;
+	}
+
+	set selfClosing(value) {
+		value = Boolean(value);
+		if (value !== this.#selfClosing && this.lastChild.text()) {
+			Parser.warn(`<${this.name}>标签内部的${value ? '文本将被隐藏' : '原有文本将再次可见'}！`);
+		}
+		this.#selfClosing = value;
+	}
+
+	/** 内部wikitext */
+	get innerText() {
+		return this.#selfClosing ? undefined : this.lastChild.text();
+	}
+
+	/**
+	 * @param {string} name 标签名
+	 * @param {string|Token} attr 标签属性
+	 * @param {string|Token} inner 内部wikitext
+	 * @param {string|undefined} closed 是否封闭；约定`undefined`表示自闭合，`''`表示未闭合
+	 * @param {accum} accum
+	 */
+	constructor(name, attr, inner, closed, config = Parser.getConfig(), accum = []) {
+		super(undefined, config, true);
+		this.setAttribute('name', name.toLowerCase());
+		this.#tags = [name, closed || name];
+		this.#selfClosing = closed === undefined;
+		this.#closed = closed !== '';
+		this.append(attr, inner);
+		let index = accum.indexOf(attr);
+		if (index === -1) {
+			index = accum.indexOf(inner);
+		}
+		if (index === -1) {
+			index = Infinity;
+		}
+		accum.splice(index, 0, this);
+	}
+
+	/**
+	 * @override
+	 * @param {string} selector
+	 */
+	toString(selector) {
+		const {firstChild, lastChild, nextSibling, name} = this,
+			[opening, closing] = this.#tags;
+		if (selector && this.matches(selector)) {
+			return '';
+		} else if (!this.#closed && nextSibling) {
+			Parser.error(`自动闭合 <${name}>`, lastChild);
+			this.#closed = true;
+		}
+		return this.#selfClosing
+			? `<${opening}${String(firstChild)}/>`
+			: `<${opening}${String(firstChild)}>${String(lastChild)}${this.#closed ? `</${closing}>` : ''}`;
+	}
+
+	/**
+	 * @override
+	 * @returns {string}
+	 */
+	text() {
+		const [opening, closing] = this.#tags;
+		return this.#selfClosing
+			? `<${opening}${this.firstChild.text()}/>`
+			: `<${opening}${super.text('>')}${this.#closed ? `</${closing}>` : ''}`;
+	}
+
+	/** @override */
+	getPadding() {
+		return this.#tags[0].length + 1;
+	}
+
+	/** @override */
+	getGaps() {
+		return 1;
+	}
+
+	/** @override */
+	print() {
+		const [opening, closing] = this.#tags;
+		return super.print(this.#selfClosing
+			? {pre: `&lt;${opening}`, post: '/&gt;'}
+			: {pre: `&lt;${opening}`, sep: '&gt;', post: this.#closed ? `&lt;/${closing}&gt;` : ''});
+	}
+
+	/**
+	 * @override
+	 * @template {string} T
+	 * @param {T} key 属性键
+	 * @returns {TokenAttribute<T>}
+	 */
+	getAttribute(key) {
+		return key === 'tags' ? [...this.#tags] : super.getAttribute(key);
+	}
+}
+
+Parser.classes.TagPairToken = __filename;
+module.exports = TagPairToken;