wikiparser-node 1.5.2-b → 1.5.2

package/dist/src/html.d.ts

@@ -0,0 +1,65 @@
+import Parser from '../index';
+import { Token } from './index';
+import type { LintError, AST } from '../base';
+import type { AttributesParentBase } from '../mixin/attributesParent';
+import type { AttributesToken } from '../internal';
+export interface HtmlToken extends AttributesParentBase {
+}
+/**
+ * HTML标签
+ * @classdesc `{childNodes: [AttributesToken]}`
+ */
+export declare abstract class HtmlToken extends Token {
+    #private;
+    readonly type = "html";
+    readonly name: string;
+    readonly childNodes: readonly [AttributesToken];
+    abstract get firstChild(): AttributesToken;
+    abstract get lastChild(): AttributesToken;
+    abstract get children(): [AttributesToken];
+    abstract get firstElementChild(): AttributesToken;
+    abstract get lastElementChild(): AttributesToken;
+    /** 是否自封闭 */
+    get selfClosing(): boolean;
+    /** 是否是闭合标签 */
+    get closing(): boolean;
+    /** @throws `Error` 自封闭标签或空标签 */
+    set closing(value: boolean);
+    /** @throws `Error` 闭合标签或无效自封闭标签 */
+    set selfClosing(value: boolean);
+    /**
+     * @param name 标签名
+     * @param attr 标签属性
+     * @param closing 是否闭合
+     * @param selfClosing 是否自封闭
+     */
+    constructor(name: string, attr: AttributesToken, closing: boolean, selfClosing: boolean, config?: Parser.Config, accum?: Token[]);
+    /** @override */
+    text(): string;
+    /** @override */
+    lint(start?: number): LintError[];
+    /**
+     * 搜索匹配的标签
+     * @throws `SyntaxError` 同时闭合和自封闭的标签
+     * @throws `SyntaxError` 无效自封闭标签
+     * @throws `SyntaxError` 未匹配的标签
+     */
+    findMatchingTag(): this | undefined;
+    /** @override */
+    print(): string;
+    /** @override */
+    json(): AST;
+    /** @override */
+    cloneNode(): this;
+    /**
+     * 更换标签名
+     * @param tag 标签名
+     * @throws `RangeError` 非法的HTML标签
+     */
+    replaceTag(tag: string): void;
+    /**
+     * 修复无效自封闭标签
+     * @throws `Error` 无法修复无效自封闭标签
+     */
+    fix(): void;
+}

package/dist/src/html.js

@@ -0,0 +1,358 @@
+"use strict";
+var __esDecorate = (this && this.__esDecorate) || function (ctor, descriptorIn, decorators, contextIn, initializers, extraInitializers) {
+    function accept(f) { if (f !== void 0 && typeof f !== "function") throw new TypeError("Function expected"); return f; }
+    var kind = contextIn.kind, key = kind === "getter" ? "get" : kind === "setter" ? "set" : "value";
+    var target = !descriptorIn && ctor ? contextIn["static"] ? ctor : ctor.prototype : null;
+    var descriptor = descriptorIn || (target ? Object.getOwnPropertyDescriptor(target, contextIn.name) : {});
+    var _, done = false;
+    for (var i = decorators.length - 1; i >= 0; i--) {
+        var context = {};
+        for (var p in contextIn) context[p] = p === "access" ? {} : contextIn[p];
+        for (var p in contextIn.access) context.access[p] = contextIn.access[p];
+        context.addInitializer = function (f) { if (done) throw new TypeError("Cannot add initializers after decoration has completed"); extraInitializers.push(accept(f || null)); };
+        var result = (0, decorators[i])(kind === "accessor" ? { get: descriptor.get, set: descriptor.set } : descriptor[key], context);
+        if (kind === "accessor") {
+            if (result === void 0) continue;
+            if (result === null || typeof result !== "object") throw new TypeError("Object expected");
+            if (_ = accept(result.get)) descriptor.get = _;
+            if (_ = accept(result.set)) descriptor.set = _;
+            if (_ = accept(result.init)) initializers.unshift(_);
+        }
+        else if (_ = accept(result)) {
+            if (kind === "field") initializers.unshift(_);
+            else descriptor[key] = _;
+        }
+    }
+    if (target) Object.defineProperty(target, contextIn.name, descriptor);
+    done = true;
+};
+var __runInitializers = (this && this.__runInitializers) || function (thisArg, initializers, value) {
+    var useValue = arguments.length > 2;
+    for (var i = 0; i < initializers.length; i++) {
+        value = useValue ? initializers[i].call(thisArg, value) : initializers[i].call(thisArg);
+    }
+    return useValue ? value : void 0;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HtmlToken = void 0;
+const lint_1 = require("../util/lint");
+const string_1 = require("../util/string");
+const debug_1 = require("../util/debug");
+const constants_1 = require("../util/constants");
+const fixed_1 = require("../mixin/fixed");
+const attributesParent_1 = require("../mixin/attributesParent");
+const index_1 = require("../index");
+const index_2 = require("./index");
+const magicWords = new Set(['if', 'ifeq', 'ifexpr', 'ifexist', 'iferror', 'switch']), formattingTags = new Set([
+    'b',
+    'big',
+    'center',
+    'cite',
+    'code',
+    'del',
+    'dfn',
+    'em',
+    'font',
+    'i',
+    'ins',
+    'kbd',
+    'mark',
+    'pre',
+    'q',
+    's',
+    'samp',
+    'small',
+    'strike',
+    'strong',
+    'sub',
+    'sup',
+    'tt',
+    'u',
+    'var',
+]), obsoleteTags = new Set(['strike', 'big', 'center', 'font', 'tt']);
+/* NOT FOR BROWSER END */
+/**
+ * HTML标签
+ * @classdesc `{childNodes: [AttributesToken]}`
+ */
+let HtmlToken = (() => {
+    let _classDecorators = [fixed_1.fixedToken, (0, attributesParent_1.attributesParent)()];
+    let _classDescriptor;
+    let _classExtraInitializers = [];
+    let _classThis;
+    let _classSuper = index_2.Token;
+    var HtmlToken = class extends _classSuper {
+        static { _classThis = this; }
+        static {
+            const _metadata = typeof Symbol === "function" && Symbol.metadata ? Object.create(_classSuper[Symbol.metadata] ?? null) : void 0;
+            __esDecorate(null, _classDescriptor = { value: _classThis }, _classDecorators, { kind: "class", name: _classThis.name, metadata: _metadata }, null, _classExtraInitializers);
+            HtmlToken = _classThis = _classDescriptor.value;
+            if (_metadata) Object.defineProperty(_classThis, Symbol.metadata, { enumerable: true, configurable: true, writable: true, value: _metadata });
+            __runInitializers(_classThis, _classExtraInitializers);
+        }
+        type = 'html';
+        #closing;
+        #selfClosing;
+        #tag;
+        /* NOT FOR BROWSER END */
+        /** 是否自封闭 */
+        get selfClosing() {
+            return this.#selfClosing;
+        }
+        /** 是否是闭合标签 */
+        get closing() {
+            return this.#closing;
+        }
+        /* NOT FOR BROWSER */
+        /** @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;
+        }
+        /** @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;
+        }
+        /* NOT FOR BROWSER END */
+        /**
+         * @param name 标签名
+         * @param attr 标签属性
+         * @param closing 是否闭合
+         * @param selfClosing 是否自封闭
+         */
+        constructor(name, attr, closing, selfClosing, config = index_1.default.getConfig(), accum = []) {
+            super(undefined, config, accum);
+            this.insertAt(attr);
+            this.setAttribute('name', name.toLowerCase());
+            this.#closing = closing;
+            this.#selfClosing = selfClosing;
+            this.#tag = name;
+        }
+        /** @private */
+        toString() {
+            return `<${this.closing ? '/' : ''}${this.#tag}${super.toString()}${this.#selfClosing ? '/' : ''}>`;
+        }
+        /** @override */
+        text() {
+            const { closing, 
+            /* NOT FOR BROWSER */
+            name, } = this, { html: [, , voidTags] } = this.getAttribute('config'), tag = `${this.#tag}${closing ? '' : super.text()}`;
+            /* NOT FOR BROWSER */
+            if (voidTags.includes(name)) {
+                return closing && name !== 'br' ? '' : `<${tag}/>`;
+            }
+            /* NOT FOR BROWSER END */
+            return `<${closing ? '/' : ''}${tag}${this.#selfClosing ? '/' : ''}>`;
+        }
+        /** @private */
+        getAttribute(key) {
+            /* NOT FOR BROWSER */
+            if (key === 'tag') {
+                return this.#tag;
+            }
+            /* NOT FOR BROWSER END */
+            return key === 'padding'
+                ? this.#tag.length + (this.closing ? 2 : 1)
+                : super.getAttribute(key);
+        }
+        /** @override */
+        lint(start = this.getAbsoluteIndex()) {
+            const errors = super.lint(start);
+            let refError;
+            if (this.name === 'h1' && !this.closing) {
+                refError = (0, lint_1.generateForSelf)(this, { start }, 'h1', '<h1>');
+                errors.push(refError);
+            }
+            if (this.closest('table-attrs')) {
+                refError ??= (0, lint_1.generateForSelf)(this, { start }, 'h1', '');
+                errors.push({
+                    ...refError,
+                    rule: 'parsing-order',
+                    message: index_1.default.msg('HTML tag in table attributes'),
+                });
+            }
+            try {
+                this.findMatchingTag();
+            }
+            catch (e) {
+                if (e instanceof SyntaxError) {
+                    const { message } = e;
+                    refError ??= (0, lint_1.generateForSelf)(this, { start }, 'h1', '');
+                    const [msg] = message.split(':'), error = { ...refError, rule: 'unmatched-tag', message: index_1.default.msg(msg) };
+                    if (msg === 'unclosed tag' && !this.closest('heading-title')) {
+                        if (formattingTags.has(this.name)) {
+                            const childNodes = this.parentNode?.childNodes, i = childNodes?.indexOf(this);
+                            if (!childNodes?.slice(0, i).some(({ type, name }) => type === 'html' && name === this.name)) {
+                                error.severity = 'warning';
+                            }
+                        }
+                        else {
+                            error.severity = 'warning';
+                        }
+                    }
+                    else if (msg === 'unmatched closing tag') {
+                        const ancestor = this.closest('magic-word');
+                        if (ancestor && magicWords.has(ancestor.name)) {
+                            error.severity = 'warning';
+                        }
+                        else {
+                            error.suggestions = [
+                                {
+                                    desc: 'remove',
+                                    range: [start, error.endIndex],
+                                    text: '',
+                                },
+                            ];
+                        }
+                    }
+                    else if (msg === 'tag that is both closing and self-closing') {
+                        const { html: [, , voidTags] } = this.getAttribute('config');
+                        if (voidTags.includes(this.name)) {
+                            error.fix = {
+                                range: [start + 1, start + 2],
+                                text: '',
+                            };
+                        }
+                    }
+                    errors.push(error);
+                }
+            }
+            if (obsoleteTags.has(this.name)) {
+                refError ??= (0, lint_1.generateForSelf)(this, { start }, 'h1', '');
+                errors.push({
+                    ...refError,
+                    rule: 'obsolete-tag',
+                    message: index_1.default.msg('obsolete HTML tag'),
+                    severity: 'warning',
+                });
+            }
+            if ((this.name === 'b' || this.name === 'strong') && this.closest('heading-title')) {
+                refError ??= (0, lint_1.generateForSelf)(this, { start }, 'h1', '');
+                errors.push({
+                    ...refError,
+                    rule: 'bold-header',
+                    message: index_1.default.msg('bold in section header'),
+                    severity: 'warning',
+                });
+            }
+            return errors;
+        }
+        /**
+         * 搜索匹配的标签
+         * @throws `SyntaxError` 同时闭合和自封闭的标签
+         * @throws `SyntaxError` 无效自封闭标签
+         * @throws `SyntaxError` 未匹配的标签
+         */
+        findMatchingTag() {
+            const { html: [normalTags, flexibleTags, voidTags] } = this.getAttribute('config'), { name: tagName, parentNode, closing } = this, string = (0, string_1.noWrap)(String(this));
+            if (closing && (this.#selfClosing || voidTags.includes(tagName))) {
+                throw new SyntaxError(`tag that is both closing and self-closing: ${string}`);
+            }
+            else if (voidTags.includes(tagName) || this.#selfClosing && flexibleTags.includes(tagName)) { // 自封闭标签
+                return this;
+            }
+            else if (this.#selfClosing && normalTags.includes(tagName)) {
+                throw new SyntaxError(`invalid self-closing tag: ${string}`);
+            }
+            else if (!parentNode) {
+                return undefined;
+            }
+            const { childNodes } = parentNode, i = childNodes.indexOf(this), siblings = (closing ? childNodes.slice(0, i).reverse() : childNodes.slice(i + 1))
+                .filter((child) => child.type === 'html' && child.name === tagName);
+            let imbalance = closing ? -1 : 1;
+            for (const token of siblings) {
+                if (token.#closing) {
+                    imbalance--;
+                }
+                else {
+                    imbalance++;
+                }
+                if (imbalance === 0) {
+                    return token;
+                }
+            }
+            throw new SyntaxError(`${closing ? 'unmatched closing' : 'unclosed'} tag: ${string}`);
+        }
+        /** @override */
+        print() {
+            return super.print({
+                pre: `&lt;${this.closing ? '/' : ''}${this.#tag}`,
+                post: `${this.#selfClosing ? '/' : ''}&gt;`,
+            });
+        }
+        /** @override */
+        json() {
+            const json = super.json();
+            Object.assign(json, { closing: this.closing, selfClosing: this.#selfClosing });
+            return json;
+        }
+        /* NOT FOR BROWSER */
+        /** @override */
+        cloneNode() {
+            const [attr] = this.cloneChildNodes(), config = this.getAttribute('config');
+            // @ts-expect-error abstract class
+            return debug_1.Shadow.run(() => new HtmlToken(this.#tag, attr, this.closing, this.selfClosing, config));
+        }
+        /**
+         * 更换标签名
+         * @param tag 标签名
+         * @throws `RangeError` 非法的HTML标签
+         */
+        replaceTag(tag) {
+            const name = tag.toLowerCase();
+            if (!this.getAttribute('config').html.flat().includes(name)) {
+                throw new RangeError(`非法的HTML标签：${tag}`);
+            }
+            this.setAttribute('name', name);
+            this.#tag = tag;
+        }
+        /**
+         * 修复无效自封闭标签
+         * @throws `Error` 无法修复无效自封闭标签
+         */
+        fix() {
+            const { html: [normalTags] } = this.getAttribute('config'), { parentNode, name: tagName, firstChild, selfClosing } = this;
+            if (!parentNode || !selfClosing || !normalTags.includes(tagName)) {
+                return;
+            }
+            else if (firstChild.text().trim()) {
+                this.#selfClosing = false;
+                this.after(index_1.default.parse(`</${this.name}>`, false, 3, this.getAttribute('config')).firstChild);
+                return;
+            }
+            const { childNodes } = parentNode, i = childNodes.indexOf(this), prevSiblings = childNodes.slice(0, i)
+                .filter((child) => child.type === 'html' && child.name === tagName), imbalance = prevSiblings.reduce((acc, { closing }) => acc + (closing ? 1 : -1), 0);
+            if (imbalance < 0) {
+                this.#selfClosing = false;
+                this.#closing = true;
+            }
+            else {
+                throw new Error(`无法修复无效自封闭标签：前文共有 ${imbalance} 个未匹配的闭合标签`);
+            }
+        }
+    };
+    return HtmlToken = _classThis;
+})();
+exports.HtmlToken = HtmlToken;
+constants_1.classes['HtmlToken'] = __filename;

package/dist/src/imageParameter.d.ts

@@ -0,0 +1,65 @@
+import Parser from '../index';
+import { Token } from './index';
+import type { LintError } from '../base';
+import type { Title } from '../lib/title';
+import type { AtomToken, FileToken, AstNodes, AstText } from '../internal';
+export declare const galleryParams: Set<string>;
+/** 图片参数 */
+export declare abstract class ImageParameterToken extends Token {
+    #private;
+    readonly type = "image-parameter";
+    readonly name: string;
+    abstract get parentNode(): FileToken | undefined;
+    abstract get nextSibling(): this | undefined;
+    abstract get previousSibling(): AtomToken | this;
+    abstract get parentElement(): FileToken | undefined;
+    abstract get nextElementSibling(): this | undefined;
+    abstract get previousElementSibling(): AtomToken | this;
+    /** 图片链接 */
+    get link(): string | Title | undefined;
+    set link(value: string);
+    /** getValue()的getter */
+    get value(): string | true;
+    set value(value: string | true);
+    /** 图片大小 */
+    get size(): {
+        width: string;
+        height: string;
+    } | undefined;
+    set size(size: {
+        width: string;
+        height: string;
+    } | undefined);
+    /** 图片宽度 */
+    get width(): string | undefined;
+    set width(width: string | undefined);
+    /** 图片高度 */
+    get height(): string | undefined;
+    set height(height: string | undefined);
+    /** @param str 图片参数 */
+    constructor(str: string, extension: string | undefined, config?: Parser.Config, accum?: Token[]);
+    /** @override */
+    text(): string;
+    /** @override */
+    lint(start?: number): LintError[];
+    /** 获取参数值 */
+    getValue(): string | true;
+    /** @override */
+    print(): string;
+    /** @override */
+    cloneNode(): this;
+    /**
+     * @override
+     * @param token 待插入的子节点
+     * @param i 插入位置
+     * @throws `Error` 不接受自定义输入的图片参数
+     */
+    insertAt(token: string, i?: number): AstText;
+    insertAt<T extends AstNodes>(token: T, i?: number): T;
+    /**
+     * 设置参数值
+     * @param value 参数值
+     * @throws `Error` 无效参数
+     */
+    setValue(value?: string | boolean): void;
+}