wikiparser-node 0.11.0 → 1.0.0-beta.0

package/dist/src/attributes.js

@@ -0,0 +1,371 @@
+"use strict";
+const lint_1 = require("../util/lint");
+const string_1 = require("../util/string");
+const Parser = require("../index");
+const Token = require(".");
+const AtomToken = require("./atom");
+const AttributeToken = require("./attribute");
+const stages = { 'ext-attrs': 0, 'html-attrs': 2, 'table-attrs': 3 };
+/**
+ * 扩展和HTML标签属性
+ * @classdesc `{childNodes: ...AtomToken|AttributeToken}`
+ */
+class AttributesToken extends Token {
+    /** 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;
+    }
+    /**
+     * @browser
+     * @param attr 标签属性
+     * @param type 标签类型
+     * @param name 标签名
+     */
+    constructor(attr, type, name, config = Parser.getConfig(), accum = []) {
+        super(undefined, config, true, accum, {
+            AtomToken: ':', AttributeToken: ':',
+        });
+        this.type = type;
+        this.setAttribute('name', name);
+        if (attr) {
+            const regex = new RegExp(`([^\\s/](?:(?!\0\\d+~\x7F)[^\\s/=])*)` // 属性名
+                + '(?:'
+                + '((?:\\s|\0\\d+c\x7F)*' // `=`前的空白字符
+                + '(?:=|\0\\d+~\x7F)' // `=`
+                + '(?:\\s|\0\\d+c\x7F)*)' // `=`后的空白字符
+                + `(?:(["'])(.*?)(\\3|$)|(\\S*))` // 属性值
+                + ')?', 'gsu');
+            let out = '', mt = regex.exec(attr), lastIndex = 0;
+            const insertDirty = /** 插入无效属性 */ () => {
+                if (out) {
+                    super.insertAt(new AtomToken(out, `${type.slice(0, -1)}-dirty`, config, accum, { [`Stage-${stages[type]}`]: ':' }));
+                    out = '';
+                }
+            };
+            while (mt) {
+                const { index, 0: full, 1: key, 2: equal, 3: quoteStart, 4: quoted, 5: quoteEnd, 6: unquoted, } = mt;
+                out += attr.slice(lastIndex, index);
+                if (/^(?:[\w:]|\0\d+[t!~{}+-]\x7F)(?:[\w:.-]|\0\d+[t!~{}+-]\x7F)*$/u.test((0, string_1.removeComment)(key).trim())) {
+                    const value = quoted ?? unquoted, quotes = [quoteStart, quoteEnd], 
+                    token = new AttributeToken(type.slice(0, -1), name, key, equal, value, quotes, config, accum);
+                    insertDirty();
+                    super.insertAt(token);
+                }
+                else {
+                    out += full;
+                }
+                ({ lastIndex } = regex);
+                mt = regex.exec(attr);
+            }
+            out += attr.slice(lastIndex);
+            insertDirty();
+        }
+    }
+    /** @private */
+    afterBuild() {
+        if (this.type === 'table-attrs') {
+            const { parentNode } = this;
+            this.setAttribute('name', parentNode?.type === 'td' && parentNode.subtype === 'caption' ? 'caption' : parentNode?.type);
+        }
+    }
+    /**
+     * 所有指定属性名的AttributeToken
+     * @browser
+     * @param key 属性名
+     */
+    getAttrTokens(key) {
+        return typeof key === 'string'
+            ? this.childNodes.filter(child => child instanceof AttributeToken && child.name === key.toLowerCase().trim())
+            : this.typeError('getAttrTokens', 'String');
+    }
+    /**
+     * 指定属性名的最后一个AttributeToken
+     * @browser
+     * @param key 属性名
+     */
+    getAttrToken(key) {
+        const tokens = this.getAttrTokens(key);
+        return tokens.at(-1);
+    }
+    /**
+     * 获取标签属性
+     * @browser
+     * @param key 属性键
+     */
+    getAttr(key) {
+        return this.getAttrToken(key)?.getValue();
+    }
+    /**
+     * @override
+     * @browser
+     */
+    lint(start = this.getAbsoluteIndex()) {
+        const errors = super.lint(start), { parentNode, length, childNodes } = this, attrs = {}, duplicated = new Set();
+        let rect;
+        if (parentNode?.type === 'html' && parentNode.closing && this.text().trim()) {
+            rect = { start, ...this.getRootNode().posFromIndex(start) };
+            errors.push((0, lint_1.generateForSelf)(this, rect, 'attributes of a closing tag'));
+        }
+        for (let i = 0; i < length; i++) {
+            const attr = childNodes[i];
+            if (attr instanceof AtomToken && attr.text().trim()) {
+                rect ??= { start, ...this.getRootNode().posFromIndex(start) };
+                errors.push({
+                    ...(0, lint_1.generateForChild)(attr, rect, 'containing invalid attribute'),
+                    excerpt: childNodes.slice(i).map(String).join('').slice(0, 50),
+                });
+            }
+            else if (attr instanceof AttributeToken) {
+                const { name } = attr;
+                if (Object.hasOwn(attrs, name)) {
+                    duplicated.add(name);
+                    attrs[name].push(attr);
+                }
+                else if (name !== 'class') {
+                    attrs[name] = [attr];
+                }
+            }
+        }
+        if (duplicated.size > 0) {
+            rect ??= { start, ...this.getRootNode().posFromIndex(start) };
+            for (const key of duplicated) {
+                errors.push(...attrs[key].map(attr => (0, lint_1.generateForChild)(attr, rect, Parser.msg('duplicated $1 attribute', key))));
+            }
+        }
+        return errors;
+    }
+    /**
+     * @override
+     * @browser
+     */
+    print() {
+        return String(this)
+            ? `<span class="wpb-${this.type}">${this.childNodes.map(child => child.print(child instanceof AtomToken && child.text().trim() ? { class: 'hidden' } : undefined)).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;
+        });
+    }
+    /** 所有无效属性 */
+    getDirtyAttrs() {
+        return this.childNodes.filter(child => child instanceof AtomToken && child.text().trim());
+    }
+    /**
+     * @override
+     * @param token 待插入的子节点
+     * @param 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 key 属性键
+     * @param 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('扩展标签属性不能包含 ">"！');
+        }
+        const k = key.toLowerCase().trim(), attr = this.getAttrToken(k);
+        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'
+            ? k
+            : Parser.run(() => String(new Token(k, config).parseOnce(0, include).parseOnce()));
+        if (!/^(?:[\w:]|\0\d+[t!~{}+-]\x7F)(?:[\w:.-]|\0\d+[t!~{}+-]\x7F)*$/u.test(parsedKey)) {
+            throw new RangeError(`无效的属性名：${k}！`);
+        }
+        const newAttr = Parser.run(() => new AttributeToken(this.type.slice(0, -1), this.name, k, value === true ? '' : '=', value === true ? '' : value, ['"', '"'], config));
+        this.insertAt(newAttr);
+    }
+    /** @private */
+    matchesAttr(key, equal, val = '', i) {
+        if (!equal) {
+            return this.hasAttr(key);
+        }
+        else if (!this.hasAttr(key)) {
+            return equal === '!=';
+        }
+        const v = (0, string_1.toCase)(val, i), attr = this.getAttr(key), thisVal = (0, string_1.toCase)(attr === true ? '' : attr, i);
+        switch (equal) {
+            case '~=':
+                return attr !== true && thisVal.split(/\s/u).includes(v);
+            case '|=': // 允许`val === ''`
+                return thisVal === v || thisVal.startsWith(`${v}-`);
+            case '^=':
+                return attr !== true && thisVal.startsWith(v);
+            case '$=':
+                return attr !== true && thisVal.endsWith(v);
+            case '*=':
+                return attr !== true && thisVal.includes(v);
+            case '!=':
+                return thisVal !== v;
+            default: // `=`
+                return thisVal === v;
+        }
+    }
+    /**
+     * 标签是否具有某属性
+     * @param 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 attrs = this.childNodes.filter(child => child instanceof AttributeToken);
+        return Object.fromEntries(attrs.map(({ name, value }) => [name, value]));
+    }
+    /**
+     * 移除标签属性
+     * @param key 属性键
+     */
+    removeAttr(key) {
+        for (const attr of this.getAttrTokens(key)) {
+            attr.remove();
+        }
+    }
+    /**
+     * 开关标签属性
+     * @param key 属性键
+     * @param force 强制开启或关闭
+     * @throws `RangeError` 不为Boolean类型的属性值
+     */
+    toggleAttr(key, force) {
+        if (typeof key !== 'string') {
+            this.typeError('toggleAttr', 'String');
+        }
+        const k = key.toLowerCase().trim(), attr = this.getAttrToken(k);
+        if (attr && attr.getValue() !== true) {
+            throw new RangeError(`${k} 属性的值不为 Boolean！`);
+        }
+        else if (attr) {
+            attr.setValue(force === true);
+        }
+        else if (force !== false) {
+            this.setAttr(k, true);
+        }
+    }
+    /**
+     * 生成引导空格
+     * @param str 属性字符串
+     */
+    #leadingSpace(str) {
+        const { type } = this, leadingRegex = { 'ext-attrs': /^\s/u, 'html-attrs': /^[/\s]/u };
+        return str && type !== 'table-attrs' && !leadingRegex[type].test(str) ? ' ' : '';
+    }
+    /** @override */
+    toString(selector) {
+        if (this.type === 'table-attrs') {
+            (0, string_1.normalizeSpace)(this);
+        }
+        const str = super.toString(selector);
+        return `${this.#leadingSpace(str)}${str}`;
+    }
+    /** @private */
+    getPadding() {
+        return this.#leadingSpace(super.toString()).length;
+    }
+    /** @override */
+    text() {
+        if (this.type === 'table-attrs') {
+            (0, string_1.normalizeSpace)(this);
+        }
+        const str = (0, string_1.text)(this.childNodes.filter(child => child instanceof AttributeToken), ' ');
+        return `${this.#leadingSpace(str)}${str}`;
+    }
+}
+Parser.classes['AttributesToken'] = __filename;
+module.exports = AttributesToken;

package/dist/src/converter.d.ts

@@ -1,103 +1,77 @@
-export = ConverterToken;
+import * as Parser from '../index';
+import Token = require('.');
+import ConverterFlagsToken = require('./converterFlags');
+import ConverterRuleToken = require('./converterRule');
 /**
  * 转换
  * @classdesc `{childNodes: [ConverterFlagsToken, ...ConverterRuleToken]}`
  */
-declare class ConverterToken extends Token {
-    /**
-     * @param {string[]} flags 转换类型标记
-     * @param {string[]} rules 转换规则
-     * @param {import('../../typings/token').accum} accum
-     */
-    constructor(flags: string[], rules: string[], config?: import("../../typings/token").ParserConfig, accum?: import('../../typings/token').accum);
-    /**
-     * 是否无转换
-     * @this {ConverterToken & {lastChild: ConverterRuleToken}}
-     */
+declare abstract class ConverterToken extends Token {
+    /** @browser */
+    readonly type = "converter";
+    childNodes: [ConverterFlagsToken, ...ConverterRuleToken[]];
+    abstract get children(): [ConverterFlagsToken, ...ConverterRuleToken[]];
+    abstract get firstChild(): ConverterFlagsToken;
+    abstract get firstElementChild(): ConverterFlagsToken;
+    abstract get lastChild(): ConverterFlagsToken | ConverterRuleToken;
+    abstract get lastElementChild(): ConverterFlagsToken | ConverterRuleToken;
+    /** 是否不转换 */
     get noConvert(): boolean;
-    /** flags */
+    /** 所有转换类型标记 */
     get flags(): Set<string>;
     /**
-     * @override
-     * @param {string} selector
-     * @returns {string}
+     * @browser
+     * @param flags 转换类型标记
+     * @param rules 转换规则
      */
-    override toString(selector: string): string;
+    constructor(flags: string[], rules: [string, ...string[]], config?: Parser.Config, accum?: Token[]);
     /**
      * @override
-     * @returns {string}
+     * @browser
      */
-    override text(): string;
+    toString(selector?: string): string;
     /**
      * @override
-     * @param {number} i 子节点位置
+     * @browser
      */
-    override getGaps(i?: number): 1 | 0;
-    /** @override */
-    override print(): string;
-    /** @override */
-    override cloneNode(): ConverterToken;
+    text(): string;
     /**
-     * 获取所有转换类型标记
-     * @this {{firstChild: ConverterFlagsToken}}
-     */
-    getAllFlags(this: {
-        firstChild: ConverterFlagsToken;
-    }): Set<string>;
-    /**
-     * 获取有效的转换类型标记
-     * @this {{firstChild: ConverterFlagsToken}}
-     */
-    getEffectiveFlags(this: {
-        firstChild: ConverterFlagsToken;
-    }): Set<string>;
-    /**
-     * 获取未知的转换类型标记
-     * @this {{firstChild: ConverterFlagsToken}}
+     * @override
+     * @browser
      */
-    getUnknownFlags(this: {
-        firstChild: ConverterFlagsToken;
-    }): Set<string>;
+    print(): string;
+    /** @override */
+    cloneNode(): this;
+    /** 获取所有转换类型标记 */
+    getAllFlags(): Set<string>;
+    /** 获取有效的转换类型标记 */
+    getEffectiveFlags(): Set<string>;
+    /** 获取未知的转换类型标记 */
+    getUnknownFlags(): Set<string>;
     /**
      * 是否具有某转换类型标记
-     * @this {{firstChild: ConverterFlagsToken}}
-     * @param {string} flag 转换类型标记
+     * @param flag 转换类型标记
      */
-    hasFlag(this: {
-        firstChild: ConverterFlagsToken;
-    }, flag: string): boolean;
+    hasFlag(flag: string): boolean;
     /**
      * 是否具有某有效的转换类型标记
-     * @this {{firstChild: ConverterFlagsToken}}
-     * @param {string} flag 转换类型标记
+     * @param flag 转换类型标记
      */
-    hasEffectiveFlag(this: {
-        firstChild: ConverterFlagsToken;
-    }, flag: string): boolean;
+    hasEffectiveFlag(flag: string): boolean;
     /**
      * 移除转换类型标记
-     * @this {{firstChild: ConverterFlagsToken}}
-     * @param {string} flag 转换类型标记
+     * @param flag 转换类型标记
      */
-    removeFlag(this: {
-        firstChild: ConverterFlagsToken;
-    }, flag: string): void;
+    removeFlag(flag: string): void;
     /**
      * 设置转换类型标记
-     * @this {{firstChild: ConverterFlagsToken}}
-     * @param {string} flag 转换类型标记
+     * @param flag 转换类型标记
      */
-    setFlag(this: {
-        firstChild: ConverterFlagsToken;
-    }, flag: string): void;
+    setFlag(flag: string): void;
     /**
      * 开关某转换类型标记
-     * @this {{firstChild: ConverterFlagsToken}}
-     * @param {string} flag 转换类型标记
+     * @param flag 转换类型标记
      */
-    toggleFlag(this: {
-        firstChild: ConverterFlagsToken;
-    }, flag: string): void;
+    toggleFlag(flag: string): void;
 }
-import Token = require(".");
-import ConverterFlagsToken = require("./converterFlags");
+export = ConverterToken;

package/dist/src/converter.js

@@ -0,0 +1,135 @@
+"use strict";
+const string_1 = require("../util/string");
+const Parser = require("../index");
+const Token = require(".");
+const ConverterFlagsToken = require("./converterFlags");
+const ConverterRuleToken = require("./converterRule");
+/**
+ * 转换
+ * @classdesc `{childNodes: [ConverterFlagsToken, ...ConverterRuleToken]}`
+ */
+class ConverterToken extends Token {
+    /** @browser */
+    type = 'converter';
+    /** 是否不转换 */
+    get noConvert() {
+        return this.hasFlag('R') || this.length === 2 && this.lastChild.length === 1;
+    }
+    /** 所有转换类型标记 */
+    get flags() {
+        return this.getAllFlags();
+    }
+    /**
+     * @browser
+     * @param flags 转换类型标记
+     * @param rules 转换规则
+     */
+    constructor(flags, rules, config = Parser.getConfig(), accum = []) {
+        super(undefined, config, true, accum);
+        this.append(new ConverterFlagsToken(flags, config, accum));
+        const [firstRule] = rules, hasColon = firstRule.includes(':'), 
+        firstRuleToken = new ConverterRuleToken(firstRule, hasColon, config, accum);
+        if (hasColon && firstRuleToken.length === 1) {
+            this.insertAt(new ConverterRuleToken(rules.join(';'), false, config, accum));
+        }
+        else {
+            this.append(firstRuleToken, 
+            ...rules.slice(1).map(rule => new ConverterRuleToken(rule, true, config, accum)));
+        }
+        this.protectChildren(0);
+    }
+    /**
+     * @override
+     * @browser
+     */
+    toString(selector) {
+        const { childNodes: [flags, ...rules] } = this;
+        return selector && this.matches(selector)
+            ? ''
+            : `-{${flags.toString(selector)}${flags.length > 0 ? '|' : ''}${rules.map(rule => rule.toString(selector)).join(';')}}-`;
+    }
+    /**
+     * @override
+     * @browser
+     */
+    text() {
+        const { childNodes: [flags, ...rules] } = this;
+        return `-{${flags.text()}|${(0, string_1.text)(rules, ';')}}-`;
+    }
+    /** @private */
+    getPadding() {
+        return 2;
+    }
+    /** @private */
+    getGaps(i = 0) {
+        const j = i < 0 ? i + this.length : i;
+        return j || this.firstChild.length > 0 ? 1 : 0;
+    }
+    /**
+     * @override
+     * @browser
+     */
+    print() {
+        const { childNodes: [flags, ...rules] } = this;
+        return `<span class="wpb-converter">-{${flags.print()}${flags.length > 0 ? '|' : ''}${(0, string_1.print)(rules, { sep: ';' })}}-</span>`;
+    }
+    /** @override */
+    cloneNode() {
+        const [flags, ...rules] = this.cloneChildNodes();
+        return Parser.run(() => {
+            const token = new ConverterToken([], [], this.getAttribute('config'));
+            token.firstChild.safeReplaceWith(flags);
+            token.append(...rules);
+            return token;
+        });
+    }
+    /** 获取所有转换类型标记 */
+    getAllFlags() {
+        return this.firstChild.getAllFlags();
+    }
+    /** 获取有效的转换类型标记 */
+    getEffectiveFlags() {
+        return this.firstChild.getEffectiveFlags();
+    }
+    /** 获取未知的转换类型标记 */
+    getUnknownFlags() {
+        return this.firstChild.getUnknownFlags();
+    }
+    /**
+     * 是否具有某转换类型标记
+     * @param flag 转换类型标记
+     */
+    hasFlag(flag) {
+        return this.firstChild.hasFlag(flag);
+    }
+    /**
+     * 是否具有某有效的转换类型标记
+     * @param flag 转换类型标记
+     */
+    hasEffectiveFlag(flag) {
+        return this.firstChild.hasEffectiveFlag(flag);
+    }
+    /**
+     * 移除转换类型标记
+     * @param flag 转换类型标记
+     */
+    removeFlag(flag) {
+        this.firstChild.removeFlag(flag);
+    }
+    /**
+     * 设置转换类型标记
+     * @param flag 转换类型标记
+     */
+    setFlag(flag) {
+        this.firstChild.setFlag(flag);
+    }
+    /**
+     * 开关某转换类型标记
+     * @param flag 转换类型标记
+     */
+    toggleFlag(flag) {
+        this.firstChild.toggleFlag(flag);
+    }
+}
+Parser.classes['ConverterToken'] = __filename;
+module.exports = ConverterToken;