wikiparser-node 0.10.0 → 0.11.0-m

package/src/attribute.js

@@ -1,16 +1,14 @@
 'use strict';
 
+/** @typedef {import('../typings/token').ParserConfig} ParserConfig */
+
 const {generateForChild} = require('../util/lint'),
-	{noWrap, removeComment} = require('../util/string'),
-	fixedToken = require('../mixin/fixedToken'),
+	{removeComment} = require('../util/string'),
 	Parser = require('..'),
 	Token = require('.'),
 	AtomToken = require('./atom');
 
-const stages = {'ext-attr': 0, 'html-attr': 2, 'table-attr': 3},
-	pre = {'ext-attr': '<pre ', 'html-attr': '<p ', 'table-attr': '{|'},
-	post = {'ext-attr': '/>', 'html-attr': '>', 'table-attr': ''},
-	commonHtmlAttrs = new Set([
+const commonHtmlAttrs = new Set([
 		'id',
 		'class',
 		'style',
@@ -109,37 +107,6 @@ const stages = {'ext-attr': 0, 'html-attr': 2, 'table-attr': 3},
 		poll: new Set(['id', 'show-results-before-voting']),
 		sm2: typeAttrs,
 		flashmp3: typeAttrs,
-		score: new Set([
-			'line_width_inches',
-			'lang',
-			'override_midi',
-			'raw',
-			'note-language',
-			'override_audio',
-			'override_ogg',
-			'sound',
-			'vorbis',
-		]),
-		seo: new Set([
-			'title',
-			'title_mode',
-			'title_separator',
-			'keywords',
-			'description',
-			'robots',
-			'google_bot',
-			'image',
-			'image_width',
-			'image_height',
-			'image_alt',
-			'type',
-			'site_name',
-			'locale',
-			'section',
-			'author',
-			'published_time',
-			'twitter_site',
-		]),
 		tab: new Set([
 			'nested',
 			'name',
@@ -177,7 +144,7 @@ const stages = {'ext-attr': 0, 'html-attr': 2, 'table-attr': 3},
  * 扩展和HTML标签属性
  * @classdesc `{childNodes: [AtomToken, Token|AtomToken]}`
  */
-class AttributeToken extends fixedToken(Token) {
+class AttributeToken extends Token {
 	#equal;
 	#quotes;
 	#tag;
@@ -192,10 +159,6 @@ class AttributeToken extends fixedToken(Token) {
 		return this.getValue();
 	}
 
-	set value(value) {
-		this.setValue(value);
-	}
-
 	/** 标签名 */
 	get tag() {
 		return this.#tag;
@@ -208,40 +171,27 @@ class AttributeToken extends fixedToken(Token) {
 	 * @param {string} equal 等号
 	 * @param {string} value 属性值
 	 * @param {string[]} quotes 引号
-	 * @param {accum} accum
+	 * @param {import('../typings/token').accum} accum
 	 */
 	constructor(type, tag, key, equal = '', value = '', quotes = [], config = Parser.getConfig(), accum = []) {
 		const keyToken = new AtomToken(key, 'attr-key', config, accum, {
-			[type === 'ext-attr' ? 'AstText' : 'Stage-1']: ':', ArgToken: ':', TranscludeToken: ':',
 		});
 		let valueToken;
 		if (key === 'title') {
 			valueToken = new Token(value, config, true, accum, {
-				[`Stage-${stages[type]}`]: ':', ConverterToken: ':',
 			}).setAttribute('type', 'attr-value').setAttribute('stage', Parser.MAX_STAGE - 1);
 		} else if (tag === 'gallery' && key === 'caption') {
 			/** @type {ParserConfig} */
 			const newConfig = {...config, excludes: [...config.excludes, 'quote', 'extLink', 'magicLink', 'list']};
 			valueToken = new Token(value, newConfig, true, accum, {
-				AstText: ':', LinkToken: ':', FileToken: ':', CategoryToken: ':', ConverterToken: ':',
 			}).setAttribute('type', 'attr-value').setAttribute('stage', 5);
 		} else if (tag === 'choose' && (key === 'before' || key === 'after')) {
 			/** @type {ParserConfig} */
 			const newConfig = {...config, excludes: [...config.excludes, 'heading', 'html', 'table', 'hr', 'list']};
 			valueToken = new Token(value, newConfig, true, accum, {
-				ArgToken: ':',
-				TranscludeToken: ':',
-				LinkToken: ':',
-				FileToken: ':',
-				CategoryToken: ':',
-				QuoteToken: ':',
-				ExtLinkToken: ':',
-				MagicLinkToken: ':',
-				ConverterToken: ':',
 			}).setAttribute('type', 'attr-value').setAttribute('stage', 1);
 		} else {
 			valueToken = new AtomToken(value, 'attr-value', config, accum, {
-				[`Stage-${stages[type]}`]: ':',
 			});
 		}
 		super(undefined, config, true, accum);
@@ -266,13 +216,9 @@ class AttributeToken extends fixedToken(Token) {
 
 	/**
 	 * @override
-	 * @param {string} selector
 	 * @returns {string}
 	 */
 	toString(selector) {
-		if (selector && this.matches(selector)) {
-			return '';
-		}
 		const [quoteStart = '', quoteEnd = ''] = this.#quotes;
 		return this.#equal
 			? `${super.toString(selector, `${this.#equal}${quoteStart}`)}${quoteEnd}`
@@ -292,12 +238,6 @@ class AttributeToken extends fixedToken(Token) {
 		return this.#equal ? this.#equal.length + (this.#quotes[0]?.length ?? 0) : 0;
 	}
 
-	/** @override */
-	print() {
-		const [quoteStart = '', quoteEnd = ''] = this.#quotes;
-		return this.#equal ? super.print({sep: `${this.#equal}${quoteStart}`, post: quoteEnd}) : super.print();
-	}
-
 	/**
 	 * @override
 	 * @param {number} start 起始位置
@@ -341,130 +281,6 @@ class AttributeToken extends fixedToken(Token) {
 		}
 		return true;
 	}
-
-	/**
-	 * @override
-	 * @template {string} T
-	 * @param {T} key 属性键
-	 * @returns {TokenAttribute<T>}
-	 */
-	getAttribute(key) {
-		if (key === 'equal') {
-			return this.#equal;
-		}
-		return key === 'quotes' ? this.#quotes : super.getAttribute(key);
-	}
-
-	/**
-	 * @override
-	 * @param {PropertyKey} key 属性键
-	 */
-	hasAttribute(key) {
-		return key === 'equal' || key === 'quotes' || super.hasAttribute(key);
-	}
-
-	/** @override */
-	cloneNode() {
-		const [key, value] = this.cloneChildNodes(),
-			config = this.getAttribute('config');
-		return Parser.run(() => {
-			const token = new AttributeToken(this.type, this.#tag, '', this.#equal, '', this.#quotes, config);
-			token.firstChild.safeReplaceWith(key);
-			token.lastChild.safeReplaceWith(value);
-			token.afterBuild();
-			return token;
-		});
-	}
-
-	/** 转义等号 */
-	escape() {
-		this.#equal = '{{=}}';
-	}
-
-	/** 闭合引号 */
-	close() {
-		[this.#quotes[1]] = this.#quotes;
-	}
-
-	/**
-	 * 设置属性值
-	 * @param {string|boolean} value 参数值
-	 * @throws `SyntaxError` 非法的标签属性
-	 */
-	setValue(value) {
-		if (value === false) {
-			this.remove();
-			return;
-		} else if (value === true) {
-			this.#equal = '';
-			return;
-		}
-		value = String(value);
-		const {type} = this,
-			key = this.name === 'title' ? 'title' : 'data',
-			wikitext = `${pre[type]}${key}="${value}"${post[type]}`,
-			root = Parser.parse(wikitext, this.getAttribute('include'), stages[type] + 1, this.getAttribute('config')),
-			{length, firstChild: tag} = root;
-		let attrs;
-		if (length !== 1 || tag.type !== type.slice(0, -5)) {
-			throw new SyntaxError(`非法的标签属性：${noWrap(value)}`);
-		} else if (type === 'table-attr') {
-			if (tag.length !== 2) {
-				throw new SyntaxError(`非法的标签属性：${noWrap(value)}`);
-			}
-			attrs = tag.lastChild;
-		} else {
-			attrs = tag.firstChild;
-		}
-		const {length: attrsLength, firstChild} = attrs;
-		if (attrsLength !== 1 || firstChild.type !== this.type || firstChild.name !== key) {
-			throw new SyntaxError(`非法的标签属性：${noWrap(value)}`);
-		}
-		const {lastChild} = firstChild;
-		firstChild.destroy(true);
-		this.lastChild.safeReplaceWith(lastChild);
-		if (this.#quotes[0]) {
-			this.close();
-		} else {
-			this.#quotes = ['"', '"'];
-		}
-	}
-
-	/**
-	 * 修改属性名
-	 * @param {string} key 新属性名
-	 * @throws `Error` title属性不能更名
-	 * @throws `SyntaxError` 非法的模板参数名
-	 */
-	rename(key) {
-		if (this.name === 'title') {
-			throw new Error('title 属性不能更名！');
-		}
-		key = String(key);
-		const {type} = this,
-			wikitext = `${pre[type]}${key}${post[type]}`,
-			root = Parser.parse(wikitext, this.getAttribute('include'), stages[type] + 1, this.getAttribute('config')),
-			{length, firstChild: tag} = root;
-		let attrs;
-		if (length !== 1 || tag.type !== type.slice(0, -5)) {
-			throw new SyntaxError(`非法的标签属性名：${noWrap(key)}`);
-		} else if (type === 'table-attr') {
-			if (tag.length !== 2) {
-				throw new SyntaxError(`非法的标签属性名：${noWrap(key)}`);
-			}
-			attrs = tag.lastChild;
-		} else {
-			attrs = tag.firstChild;
-		}
-		const {length: attrsLength, firstChild: attr} = attrs;
-		if (attrsLength !== 1 || attr.type !== this.type || attr.value !== true) {
-			throw new SyntaxError(`非法的标签属性名：${noWrap(key)}`);
-		}
-		const {firstChild} = attr;
-		attr.destroy(true);
-		this.firstChild.safeReplaceWith(firstChild);
-	}
 }
 
-Parser.classes.AttributeToken = __filename;
 module.exports = AttributeToken;

package/src/attributes.js

@@ -1,97 +1,25 @@
 'use strict';
 
 const {generateForSelf, generateForChild} = require('../util/lint'),
-	{toCase, normalizeSpace, text, removeComment} = require('../util/string'),
+	{removeComment} = require('../util/string'),
 	Parser = require('..'),
 	Token = require('.'),
 	AtomToken = require('./atom'),
 	AttributeToken = require('./attribute');
 
-const stages = {'ext-attrs': 0, 'html-attrs': 2, 'table-attrs': 3};
-
 /**
  * 扩展和HTML标签属性
  * @classdesc `{childNodes: ...AtomToken|AttributeToken}`
  */
 class AttributesToken extends Token {
-	/**
-	 * @override
-	 * @param {string} key 属性键
-	 * @param {string|undefined} equal 属性规则运算符，`equal`存在时`val`和`i`也一定存在
-	 * @param {string|undefined} val 属性值
-	 * @param {string|undefined} i 是否对大小写不敏感
-	 */
-	#matchesAttr = (key, equal, val, i) => {
-		if (!equal) {
-			return this.hasAttr(key);
-		} else if (!this.hasAttr(key)) {
-			return equal === '!=';
-		}
-		val = toCase(val, i);
-		const attr = this.getAttr(key),
-			thisVal = toCase(attr === true ? '' : attr, i);
-		switch (equal) {
-			case '~=':
-				return attr !== true && thisVal.split(/\s/u).includes(val);
-			case '|=': // 允许`val === ''`
-				return thisVal === val || thisVal.startsWith(`${val}-`);
-			case '^=':
-				return attr !== true && thisVal.startsWith(val);
-			case '$=':
-				return attr !== true && thisVal.endsWith(val);
-			case '*=':
-				return attr !== true && thisVal.includes(val);
-			case '!=':
-				return thisVal !== val;
-			default: // `=`
-				return thisVal === val;
-		}
-	};
-
-	/** getAttrs()方法的getter写法 */
-	get attributes() {
-		return this.getAttrs();
-	}
-
-	/** 以字符串表示的class属性 */
-	get className() {
-		const attr = this.getAttr('class');
-		return typeof attr === 'string' ? attr : '';
-	}
-
-	set className(className) {
-		this.setAttr('class', className);
-	}
-
-	/** 以Set表示的class属性 */
-	get classList() {
-		return new Set(this.className.split(/\s/u));
-	}
-
-	/** id属性 */
-	get id() {
-		const attr = this.getAttr('id');
-		return typeof attr === 'string' ? attr : '';
-	}
-
-	set id(id) {
-		this.setAttr('id', id);
-	}
-
-	/** 是否含有无效属性 */
-	get sanitized() {
-		return this.getDirtyAttrs().length === 0;
-	}
-
 	/**
 	 * @param {string} attr 标签属性
 	 * @param {'ext-attrs'|'html-attrs'|'table-attrs'} type 标签类型
 	 * @param {string} name 标签名
-	 * @param {accum} accum
+	 * @param {import('../typings/token').accum} accum
 	 */
 	constructor(attr, type, name, config = Parser.getConfig(), accum = []) {
 		super(undefined, config, true, accum, {
-			AtomToken: ':', AttributeToken: ':',
 		});
 		this.type = type;
 		this.setAttribute('name', name);
@@ -112,7 +40,6 @@ class AttributesToken extends Token {
 			const insertDirty = /** 插入无效属性 */ () => {
 				if (out) {
 					super.insertAt(new AtomToken(out, `${type.slice(0, -1)}-dirty`, config, accum, {
-						[`Stage-${stages[type]}`]: ':',
 					}));
 					out = '';
 				}
@@ -154,11 +81,9 @@ class AttributesToken extends Token {
 	 * @returns {AttributeToken[]}
 	 */
 	getAttrTokens(key) {
-		return typeof key === 'string'
-			? this.childNodes.filter(
-				child => child instanceof AttributeToken && child.name === key.toLowerCase().trim(),
-			)
-			: this.typeError('getAttrTokens', 'String');
+		return this.childNodes.filter(
+			child => child instanceof AttributeToken && child.name === key.toLowerCase().trim(),
+		);
 	}
 
 	/**
@@ -220,234 +145,6 @@ class AttributesToken extends Token {
 		}
 		return errors;
 	}
-
-	/**
-	 * @override
-	 * @this {AttributesToken & {parentNode: HtmlToken}}
-	 */
-	print() {
-		const HtmlToken = require('./html');
-		return String(this)
-			? `<span class="wpb-${this.type}">${this.childNodes.map(child => child.print({
-				class: child instanceof AtomToken && child.text().trim() && 'hidden',
-			})).join('')}</span>`
-			: '';
-	}
-
-	/** 清理标签属性 */
-	sanitize() {
-		let dirty = false;
-		for (let i = this.length - 1; i >= 0; i--) {
-			const child = this.childNodes[i];
-			if (child instanceof AtomToken && child.text().trim()) {
-				dirty = true;
-				this.removeAt(i);
-			}
-		}
-		if (!Parser.running && dirty) {
-			Parser.warn(`${this.constructor.name}.sanitize 方法将清理无效属性！`);
-		}
-	}
-
-	/** @override */
-	cloneNode() {
-		const cloned = this.cloneChildNodes();
-		return Parser.run(() => {
-			const token = new AttributesToken(undefined, this.type, this.name, this.getAttribute('config'));
-			token.append(...cloned);
-			return token;
-		});
-	}
-
-	/**
-	 * 所有无效属性
-	 * @returns {AtomToken[]}
-	 */
-	getDirtyAttrs() {
-		return this.childNodes.filter(child => child instanceof AtomToken && child.text().trim());
-	}
-
-	/**
-	 * @override
-	 * @param {AttributeToken} token 待插入的子节点
-	 * @param {number} i 插入位置
-	 * @throws `RangeError` 不是AttributeToken或标签不匹配
-	 */
-	insertAt(token, i = this.length) {
-		if (!(token instanceof AttributeToken)) {
-			throw new RangeError(`${this.constructor.name}只能插入AttributeToken！`);
-		} else if (token.type !== this.type.slice(0, -1) || token.tag !== this.name) {
-			throw new RangeError(`待插入的AttributeToken只可用于${token.tag}标签！`);
-		} else if (i === this.length) {
-			const {lastChild} = this;
-			if (lastChild instanceof AttributeToken) {
-				lastChild.close();
-			}
-		} else {
-			token.close();
-		}
-		if (this.closest('parameter')) {
-			token.escape();
-		}
-		super.insertAt(token, i);
-		const {previousVisibleSibling, nextVisibleSibling} = token,
-			type = `${this.type.slice(0, -1)}-dirty`,
-			config = this.getAttribute('config'),
-			acceptable = {[`Stage-${stages[this.type]}`]: ':'};
-		if (nextVisibleSibling && !/^\s/u.test(String(nextVisibleSibling))) {
-			super.insertAt(Parser.run(() => new AtomToken(' ', type, config, [], acceptable)), i + 1);
-		}
-		if (previousVisibleSibling && !/\s$/u.test(String(previousVisibleSibling))) {
-			super.insertAt(Parser.run(() => new AtomToken(' ', type, config, [], acceptable)), i);
-		}
-		return token;
-	}
-
-	/**
-	 * 设置标签属性
-	 * @param {string} key 属性键
-	 * @param {string|boolean} value 属性值
-	 * @throws `RangeError` 扩展标签属性不能包含">"
-	 * @throws `RangeError` 无效的属性名
-	 */
-	setAttr(key, value) {
-		if (typeof key !== 'string' || typeof value !== 'string' && typeof value !== 'boolean') {
-			this.typeError('setAttr', 'String', 'Boolean');
-		} else if (this.type === 'ext-attrs' && typeof value === 'string' && value.includes('>')) {
-			throw new RangeError('扩展标签属性不能包含 ">"！');
-		}
-		key = key.toLowerCase().trim();
-		const attr = this.getAttrToken(key);
-		if (attr) {
-			attr.setValue(value);
-			return;
-		} else if (value === false) {
-			return;
-		}
-		const config = this.getAttribute('config'),
-			include = this.getAttribute('include'),
-			parsedKey = this.type === 'ext-attrs'
-				? key
-				: Parser.run(() => {
-					const token = new Token(key, config),
-						parseOnce = token.getAttribute('parseOnce');
-					parseOnce(0, include);
-					return String(parseOnce());
-				});
-		if (!/^(?:[\w:]|\0\d+[t!~{}+-]\x7F)(?:[\w:.-]|\0\d+[t!~{}+-]\x7F)*$/u.test(parsedKey)) {
-			throw new RangeError(`无效的属性名：${key}！`);
-		}
-		const newAttr = Parser.run(() => new AttributeToken(
-			this.type.slice(0, -1), this.name, key, value === true ? '' : '=', value, ['"', '"'], config,
-		));
-		this.insertAt(newAttr);
-	}
-
-	/**
-	 * @override
-	 * @template {string} T
-	 * @param {T} key 属性键
-	 * @returns {TokenAttribute<T>}
-	 */
-	getAttribute(key) {
-		return key === 'matchesAttr' ? this.#matchesAttr : super.getAttribute(key);
-	}
-
-	/**
-	 * 标签是否具有某属性
-	 * @param {string} key 属性键
-	 */
-	hasAttr(key) {
-		return typeof key === 'string'
-			? this.getAttrTokens(key).length > 0
-			: this.typeError('hasAttr', 'String');
-	}
-
-	/** 获取全部的标签属性名 */
-	getAttrNames() {
-		return new Set(this.childNodes.filter(child => child instanceof AttributeToken).map(({name}) => name));
-	}
-
-	/** 标签是否具有任意属性 */
-	hasAttrs() {
-		return this.getAttrNames().size > 0;
-	}
-
-	/** 获取全部标签属性 */
-	getAttrs() {
-		const /** @type {AttributeToken[]} */ attrs = this.childNodes.filter(child => child instanceof AttributeToken);
-		return Object.fromEntries(attrs.map(({name, value}) => [name, value]));
-	}
-
-	/**
-	 * 移除标签属性
-	 * @param {string} key 属性键
-	 */
-	removeAttr(key) {
-		for (const attr of this.getAttrTokens(key)) {
-			attr.remove();
-		}
-	}
-
-	/**
-	 * 开关标签属性
-	 * @param {string} key 属性键
-	 * @param {boolean|undefined} force 强制开启或关闭
-	 * @throws `RangeError` 不为Boolean类型的属性值
-	 */
-	toggleAttr(key, force) {
-		if (typeof key !== 'string') {
-			this.typeError('toggleAttr', 'String');
-		} else if (force !== undefined) {
-			force = Boolean(force);
-		}
-		key = key.toLowerCase().trim();
-		const attr = this.getAttrToken(key);
-		if (attr && attr.getValue() !== true) {
-			throw new RangeError(`${key} 属性的值不为 Boolean！`);
-		} else if (attr) {
-			attr.setValue(force === true);
-		} else if (force !== false) {
-			this.setAttr(key, true);
-		}
-	}
-
-	/**
-	 * 生成引导空格
-	 * @param {string} str 属性字符串
-	 */
-	#leadingSpace(str = super.toString()) {
-		const {type} = this,
-			leadingRegex = {'ext-attrs': /^\s/u, 'html-attrs': /^[/\s]/u};
-		return str && type !== 'table-attrs' && !leadingRegex[type].test(str) ? ' ' : '';
-	}
-
-	/**
-	 * @override
-	 * @param {string} selector
-	 */
-	toString(selector) {
-		if (this.type === 'table-attrs') {
-			normalizeSpace(this);
-		}
-		const str = super.toString(selector);
-		return `${this.#leadingSpace(str)}${str}`;
-	}
-
-	/** @override */
-	getPadding() {
-		return this.#leadingSpace().length;
-	}
-
-	/** @override */
-	text() {
-		if (this.type === 'table-attrs') {
-			normalizeSpace(this);
-		}
-		const str = text(this.childNodes.filter(child => child instanceof AttributeToken), ' ');
-		return `${this.#leadingSpace(str)}${str}`;
-	}
 }
 
-Parser.classes.AttributesToken = __filename;
 module.exports = AttributesToken;