wikiparser-node 1.16.3 → 1.16.5

package/dist/base.d.ts

@@ -74,28 +74,54 @@ export type AST = Record<string, string | number | boolean> & {
     childNodes?: AST[];
     data?: string;
 };
-/** 类似Node */
+/**
+ * Node-like
+ *
+ * 类似Node
+ */
 export interface AstNode {
     readonly childNodes: readonly AstNode[];
-    /** 节点类型 */
+    /**
+     * node type
+     *
+     * 节点类型
+     */
     type: string;
     toString(...args: unknown[]): string;
     /** Linter */
     lint(): LintError[];
-    /** 以HTML格式打印 */
+    /**
+     * print in HTML
+     *
+     * 以HTML格式打印
+     */
     print(): string;
 }
-/** 所有节点的基类 */
+/**
+ * base class for all tokens
+ *
+ * 所有节点的基类
+ */
 interface Token extends AstNode {
     readonly name?: string;
     /**
+     * Get all descendants that match the selector
+     *
      * 符合选择器的所有后代节点
      * @param selector 选择器
      */
     querySelectorAll<T = Token>(selector: string): T[];
-    /** 保存为JSON */
+    /**
+     * Save in JSON format
+     *
+     * 保存为JSON
+     */
     json(): AST;
-    /** 生成HTML */
+    /**
+     * Generate HTML
+     *
+     * 生成HTML
+     */
     toHtml(): string;
 }
 interface SignatureParameter {
@@ -116,91 +142,126 @@ export type CompletionItem = Omit<CompletionItemBase, 'kind'> & {
     kind: keyof typeof CompletionItemKind;
 };
 export interface LanguageService {
-    /** 销毁实例 */
+    /**
+     * Destroy the instance
+     *
+     * 销毁实例
+     */
     destroy(): void;
     /**
+     * Provide color decorators
+     *
      * 提供颜色指示
-     * @param rgba 颜色解析函数
-     * @param text 源代码
-     * @param hsl 是否允许HSL颜色
+     * @param rgba color parser / 颜色解析函数
+     * @param text source Wikitext / 源代码
+     * @param hsl whether HSL colors are treated / 是否允许HSL颜色
      */
     provideDocumentColors(rgba: (s: string) => [number, number, number, number] | [], text: string, hsl?: boolean): Promise<ColorInformation[]>;
     /**
+     * Provide color pickers
+     *
      * 颜色选择器
-     * @param color 颜色信息
+     * @param color color information / 颜色信息
      */
     provideColorPresentations(color: ColorInformation): ColorPresentation[];
     /**
+     * Provide auto-completion
+     *
      * 提供自动补全
-     * @param text 源代码
+     * @param text source Wikitext / 源代码
      * @param position 位置
      */
     provideCompletionItems(text: string, position: Position): Promise<CompletionItem[] | undefined>;
     /**
+     * Provide grammar check
+     *
      * 提供语法检查
-     * @param wikitext 源代码
+     * @param text source Wikitext / 源代码
+     * @param warning whether to include warnings / 是否包含警告
      */
-    provideDiagnostics(wikitext: string, warning?: boolean): Promise<Diagnostic[]>;
+    provideDiagnostics(text: string, warning?: boolean): Promise<Diagnostic[]>;
     /**
+     * Provide folding ranges
+     *
      * 提供折叠范围
-     * @param text 源代码
+     * @param text source Wikitext / 源代码
      */
     provideFoldingRanges(text: string): Promise<FoldingRange[]>;
     /**
+     * Provide links
+     *
      * 提供链接
-     * @param text 源代码
+     * @param text source Wikitext / 源代码
      */
     provideLinks(text: string): Promise<DocumentLink[]>;
     /**
+     * Provide references
+     *
      * 提供引用
-     * @param text 源代码
+     * @param text source Wikitext / 源代码
      * @param position 位置
      */
     provideReferences(text: string, position: Position): Promise<Omit<Location, 'uri'>[] | undefined>;
     /**
+     * Provide definitions
+     *
      * 提供定义
-     * @param text 源代码
+     * @param text source Wikitext / 源代码
      * @param position 位置
      */
     provideDefinition(text: string, position: Position): Promise<Omit<Location, 'uri'>[] | undefined>;
     /**
+     * Provide locations for renaming
+     *
      * 提供变量更名准备
-     * @param text 源代码
+     * @param text source Wikitext / 源代码
      * @param position 位置
      */
     resolveRenameLocation(text: string, position: Position): Promise<Range | undefined>;
     /**
+     * Provide rename edits
+     *
      * 变量更名
-     * @param text 源代码
+     * @param text source Wikitext / 源代码
      * @param position 位置
-     * @param newName 新名称
+     * @param newName new name / 新名称
      */
     provideRenameEdits(text: string, position: Position, newName: string): Promise<WorkspaceEdit | undefined>;
     /**
+     * Provide hover information
+     *
      * 提供悬停信息
-     * @param text 源代码
+     * @param text source Wikitext / 源代码
      * @param position 位置
      */
     provideHover(text: string, position: Position): Promise<Hover | undefined>;
     /**
+     * Provide signature help for magic words
+     *
      * 提供魔术字帮助
-     * @param text 源代码
+     * @param text source Wikitext / 源代码
      * @param position 位置
      */
     provideSignatureHelp(text: string, position: Position): Promise<SignatureHelp | undefined>;
     /**
+     * Provide CodeLens
+     *
      * 提供 CodeLens
-     * @param text 源代码
+     * @param text source Wikitext / 源代码
      */
     provideInlayHints(text: string): Promise<InlayHint[]>;
     /**
+     * Provide quick fixes
+     *
      * 提供快速修复建议
-     * @param diagnostics 语法诊断信息
+     * @param diagnostics grammar diagnostics / 语法诊断信息
      */
     provideCodeAction(diagnostics: Diagnostic[]): CodeAction[];
     /**
+     * Provide document sections
+     *
      * 提供章节
-     * @param text 源代码
+     * @param text source Wikitext / 源代码
      */
     provideDocumentSymbols(text: string): Promise<DocumentSymbol[]>;
 }
@@ -208,17 +269,25 @@ export interface Parser {
     config: Config | string;
     i18n: Record<string, string> | string | undefined;
     viewOnly: boolean;
-    /** 获取当前的解析设置 */
+    /**
+     * Get the current parser configuration
+     *
+     * 获取当前的解析设置
+     */
     getConfig(): Config;
     /**
+     * Parse wikitext
+     *
      * 解析wikitext
-     * @param include 是否嵌入
-     * @param maxStage 最大解析层级
+     * @param include whether to be transcluded / 是否嵌入
+     * @param maxStage max stage for parsing / 最大解析层级
      */
     parse(wikitext: string, include?: boolean, maxStage?: number | Stage | Stage[], config?: Config): Token;
     /**
+     * Create a language server
+     *
      * 创建语言服务
-     * @param uri 文档标识
+     * @param uri document URI / 文档标识
      */
     createLanguageService(uri: object): LanguageService;
 }

package/dist/index.d.ts

@@ -11,19 +11,25 @@ declare interface Parser extends ParserBase {
     warning: boolean;
     debugging: boolean;
     /**
+     * Normalize page title
+     *
      * 规范化页面标题
-     * @param title 标题（含或不含命名空间前缀）
-     * @param defaultNs 命名空间
-     * @param include 是否嵌入
+     * @param title title (with or without the namespace prefix) / 标题（含或不含命名空间前缀）
+     * @param defaultNs default namespace number / 命名空间
+     * @param include whether to be transcluded / 是否嵌入
      */
     normalizeTitle(title: string, defaultNs?: number, include?: boolean, config?: Config): Title;
     parse(wikitext: string, include?: boolean, maxStage?: number | Stage | Stage[], config?: Config): Token;
     /**
+     * Create a language server
+     *
      * 创建语言服务
-     * @param uri 文档标识
+     * @param uri document URI / 文档标识
      */
     createLanguageService(uri: object): LanguageService;
     /**
+     * Check if the title is an interwiki link
+     *
      * 是否是跨维基链接
      * @param title 链接标题
      */

package/dist/index.js

@@ -1,26 +1,32 @@
 "use strict";
 /* eslint n/exports-style: 0 */
-const fs = require("fs");
-const path = require("path");
 const base_1 = require("./base");
 const debug_1 = require("./util/debug");
 const constants_1 = require("./util/constants");
 const string_1 = require("./util/string");
-const diff_1 = require("./util/diff");
 /* NOT FOR BROWSER */
 const chalk = require("chalk");
+/* NOT FOR BROWSER END */
+/* NOT FOR BROWSER ONLY */
+const fs = require("fs");
+const path = require("path");
+const diff_1 = require("./util/diff");
+/* NOT FOR BROWSER ONLY */
 /**
  * 从根路径require
  * @param file 文件名
  * @param dir 子路径
  */
-const rootRequire = (file, dir) => require(path.isAbsolute(file) ? /* istanbul ignore next */ file : path.join('..', file.includes('/') ? '' : dir, file));
+const rootRequire = (file, dir) => require(path.isAbsolute(file)
+    ? /* istanbul ignore next */ file
+    : path.join('..', file.includes('/') ? '' : dir, file));
+/* NOT FOR BROWSER ONLY END */
 /* NOT FOR BROWSER */
 /**
  * 快速规范化页面标题
  * @param title 标题
  */
-const normalizeTitle = (title) => String(Parser.normalizeTitle(title));
+const normalizeTitle = (title) => String(Parser.normalizeTitle(title, 0, false, undefined, true));
 /** 重定向列表 */
 class RedirectMap extends Map {
     /** @ignore */
@@ -68,6 +74,7 @@ const Parser = {
     /* NOT FOR BROWSER END */
     /** @implements */
     getConfig() {
+        /* NOT FOR BROWSER ONLY */
         if (typeof this.config === 'string') {
             this.config = rootRequire(this.config, 'config');
             /* istanbul ignore if */
@@ -87,6 +94,7 @@ const Parser = {
             /* NOT FOR BROWSER END */
             return this.getConfig();
         }
+        /* NOT FOR BROWSER ONLY END */
         const { doubleUnderscore } = this.config;
         for (let i = 0; i < 2; i++) {
             if (doubleUnderscore.length > i + 2 && doubleUnderscore[i].length === 0) {
@@ -100,18 +108,20 @@ const Parser = {
     },
     /** @implements */
     msg(msg, arg = '') {
+        /* NOT FOR BROWSER ONLY */
         if (typeof this.i18n === 'string') {
             this.i18n = rootRequire(this.i18n, 'i18n');
             return this.msg(msg, arg);
         }
+        /* NOT FOR BROWSER ONLY END */
         return msg && (this.i18n?.[msg] ?? msg).replace('$1', this.msg(arg));
     },
     /** @implements */
-    normalizeTitle(title, defaultNs = 0, include, config = Parser.getConfig(), halfParsed, decode = false, selfLink = false) {
+    normalizeTitle(title, defaultNs = 0, include, config = Parser.getConfig(), temporary = false, halfParsed, decode = false, selfLink = false) {
         const { Title } = require('./lib/title');
         let titleObj;
         if (halfParsed) {
-            titleObj = new Title(title, defaultNs, config, decode, selfLink);
+            titleObj = new Title(title, defaultNs, config, temporary, decode, selfLink);
         }
         else {
             const { Token } = require('./src/index');
@@ -119,7 +129,7 @@ const Parser = {
                 const root = new Token(title, config);
                 root.type = 'root';
                 root.parseOnce(0, include).parseOnce();
-                const t = new Title(root.toString(), defaultNs, config, decode, selfLink);
+                const t = new Title(root.toString(), defaultNs, config, temporary, decode, selfLink);
                 for (const key of ['main', 'fragment']) {
                     const str = t[key];
                     if (str?.includes('\0')) {
@@ -154,6 +164,7 @@ const Parser = {
             token.type = 'root';
             try {
                 return token.parse(maxStage, include);
+                /* NOT FOR BROWSER ONLY */
             }
             catch (e) /* istanbul ignore next */ {
                 if (e instanceof Error) {
@@ -169,6 +180,7 @@ const Parser = {
                 }
                 throw e;
             }
+            /* NOT FOR BROWSER ONLY END */
         });
         /* NOT FOR BROWSER */
         /* istanbul ignore if */
@@ -192,13 +204,46 @@ const Parser = {
         return root;
     },
     /** @implements */
+    async partialParse(wikitext, watch, include, config = Parser.getConfig()) {
+        const { Token } = require('./src/index');
+        const set = typeof setImmediate === 'function' ? setImmediate : /* istanbul ignore next */ setTimeout, { running } = debug_1.Shadow;
+        debug_1.Shadow.running = true;
+        const token = new Token((0, string_1.tidy)(wikitext), config);
+        token.type = 'root';
+        let i = 0;
+        await new Promise(resolve => {
+            const /** @ignore */ check = () => {
+                if (watch() === wikitext) {
+                    i++;
+                    set(parseOnce, 0);
+                }
+                else {
+                    resolve();
+                }
+            }, 
+            /** @ignore */ parseOnce = () => {
+                if (i === constants_1.MAX_STAGE + 1) {
+                    token.afterBuild();
+                    resolve();
+                }
+                else {
+                    token[i === constants_1.MAX_STAGE ? 'build' : 'parseOnce'](i, include);
+                    check();
+                }
+            };
+            set(parseOnce, 0);
+        });
+        debug_1.Shadow.running = running;
+        return token;
+    },
+    /** @implements */
     createLanguageService(uri) {
-        let mod;
-        // eslint-disable-next-line no-unused-labels
-        LSP: mod = require('./lib/lsp');
-        const { LanguageService, tasks } = mod;
-        Parser.viewOnly = true;
-        return tasks.get(uri) ?? new LanguageService(uri);
+        LSP: { // eslint-disable-line no-unused-labels
+            const mod = require('./lib/lsp');
+            const { LanguageService, tasks } = mod;
+            Parser.viewOnly = true;
+            return tasks.get(uri) ?? new LanguageService(uri);
+        }
     },
     /* NOT FOR BROWSER */
     /** @implements */

package/dist/lib/attributes.js

@@ -26,8 +26,8 @@ class Attributes {
         return this.#link;
     }
     get invalid() {
-        this.#invalid ??= this.type === 'table-inter'
-            || this.type === 'image-parameter' && this.token.name === 'invalid';
+        const { type, token: { name } } = this;
+        this.#invalid ??= type === 'table-inter' || type === 'image-parameter' && name === 'invalid';
         return this.#invalid;
     }
     get siblings() {

package/dist/lib/element.d.ts

@@ -1,125 +1,224 @@
 import { AstNode } from './node';
 import type { LintError, AST } from '../base';
-import type { AstNodes, AstText, Token } from '../internal';
-/** 类似HTMLElement */
+import type { AstNodes, AstText, Token, FileToken, LinkToken, RedirectTargetToken, ExtLinkToken, MagicLinkToken, ImageParameterToken, TranscludeToken } from '../internal';
+declare type LinkTokens = LinkToken | RedirectTargetToken | ExtLinkToken | MagicLinkToken | ImageParameterToken;
+export interface CaretPosition {
+    readonly offsetNode: AstNodes;
+    readonly offset: number;
+}
+/**
+ * HTMLElement-like
+ *
+ * 类似HTMLElement
+ */
 export declare abstract class AstElement extends AstNode {
     #private;
     readonly name?: string;
     readonly data: undefined;
-    /** 子节点总数 */
+    /** number of child nodes / 子节点总数 */
     get length(): number;
     set length(n: number);
-    /** 全部非文本子节点 */
+    /** all child elements / 全部非文本子节点 */
     get children(): Token[];
-    /** 首位非文本子节点 */
+    /** first child element / 首位非文本子节点 */
     get firstElementChild(): Token | undefined;
-    /** 末位非文本子节点 */
+    /** last child element / 末位非文本子节点 */
     get lastElementChild(): Token | undefined;
-    /** 非文本子节点总数 */
+    /** number of child elements / 非文本子节点总数 */
     get childElementCount(): number;
-    /** 父节点 */
+    /** parent node / 父节点 */
     get parentElement(): Token | undefined;
-    /** AstElement.prototype.text()的getter写法 */
+    /** visible text / 可见部分 */
     get outerText(): string;
-    /** 不可见 */
+    /** invisible / 不可见 */
     get hidden(): boolean;
-    /** 内部高度 */
+    /** height of the inner / 内部高度 */
     get clientHeight(): number | undefined;
-    /** 内部宽度 */
+    /** width of the inner / 内部宽度 */
     get clientWidth(): number | undefined;
+    /** all images, including gallery images / 所有图片，包括图库 */
+    get images(): FileToken[];
+    /** all internal, external and free external links / 所有内链、外链和自由外链 */
+    get links(): LinkTokens[];
+    /** all templates and modules / 所有模板和模块 */
+    get embeds(): TranscludeToken[];
     constructor();
-    /** 合并相邻的文本子节点 */
+    /**
+     * Merge adjacent text child nodes
+     *
+     * 合并相邻的文本子节点
+     */
     normalize(): void;
     /**
+     * Remove a child node
+     *
      * 移除子节点
-     * @param i 移除位置
+     * @param i position of the child node / 移除位置
      */
     removeAt(i: number): AstNodes;
     /**
+     * Insert a child node
+     *
      * 插入子节点
-     * @param node 待插入的子节点
-     * @param i 插入位置
+     * @param node node to be inserted / 待插入的子节点
+     * @param i position to be inserted at / 插入位置
      * @throws `RangeError` 不能插入祖先或子节点
      */
     insertAt<T extends AstNodes>(node: T, i?: number): T;
     /**
-     * 最近的祖先节点
+     * Get the closest ancestor node that matches the selector
+     *
+     * 最近的符合选择器的祖先节点
      * @param selector 选择器
      */
     closest<T = Token>(selector: string): T | undefined;
     /**
+     * Get the first descendant that matches the selector
+     *
      * 符合选择器的第一个后代节点
      * @param selector 选择器
      */
     querySelector<T = Token>(selector: string): T | undefined;
     /**
+     * Get all descendants that match the selector
+     *
      * 符合选择器的所有后代节点
      * @param selector 选择器
      */
     querySelectorAll<T = Token>(selector: string): T[];
     /**
+     * Insert a batch of child nodes at the end
+     *
      * 在末尾批量插入子节点
-     * @param elements 插入节点
+     * @param elements nodes to be inserted / 插入节点
      */
     append(...elements: (AstNodes | string)[]): void;
     /**
+     * Replace all child nodes
+     *
      * 批量替换子节点
-     * @param elements 新的子节点
+     * @param elements nodes to be inserted / 新的子节点
      */
     replaceChildren(...elements: (AstNodes | string)[]): void;
     /**
+     * Modify the text child node
+     *
      * 修改文本子节点
-     * @param str 新文本
-     * @param i 子节点位置
+     * @param str new text / 新文本
+     * @param i position of the text child node / 子节点位置
      * @throws `RangeError` 对应位置的子节点不是文本节点
      */
     setText(str: string, i?: number): string;
     /**
+     * Get the caret position from the character index
+     *
+     * 找到给定位置
+     * @param index character index / 位置
+     */
+    caretPositionFromIndex(index?: number): CaretPosition | undefined;
+    /**
+     * Get the closest ancestor element from the character index
+     *
+     * 找到给定位置所在的最内层非文本节点
+     * @param index character index / 位置
+     */
+    elementFromIndex(index?: number): Token | undefined;
+    /**
+     * Get the closest ancestor element from the position
+     *
+     * 找到给定位置所在的最内层非文本节点
+     * @param x column number / 列数
+     * @param y line number / 行数
+     */
+    elementFromPoint(x: number, y: number): Token | undefined;
+    /**
+     * Save in JSON format
+     *
      * 保存为JSON
-     * @param file 文件名
+     * @param file file name / 文件名
      * @param start
      */
     json(file?: string, start?: number): AST;
     /**
+     * Check if the current element matches the selector
+     *
      * 检查是否符合选择器
      * @param selector 选择器
      */
     matches<T>(selector?: string): this is T;
     /**
+     * Get all descendants of the types
+     *
      * 类型选择器
-     * @param types
+     * @param types token types / 节点类型
      */
     getElementByTypes<T = Token>(types: string): T | undefined;
     /**
+     * Get the first descendant with the id
+     *
      * id选择器
      * @param id id名
      */
     getElementById<T = Token>(id: string): T | undefined;
     /**
+     * Get all descendants with the class
+     *
      * 类选择器
-     * @param className 类名之一
+     * @param className class name / 类名之一
      */
     getElementsByClassName<T = Token>(className: string): T[];
     /**
+     * Get all descendants with the tag name
+     *
      * 标签名选择器
-     * @param tag 标签名
+     * @param tag tag name / 标签名
      */
     getElementsByTagName<T = Token>(tag: string): T[];
     /**
+     * Insert a batch of child nodes at the start
+     *
      * 在开头批量插入子节点
-     * @param elements 插入节点
+     * @param elements nodes to be inserted / 插入节点
      */
     prepend(...elements: (AstNodes | string)[]): void;
     /**
+     * Remove a child node
+     *
      * 移除子节点
-     * @param node 子节点
+     * @param node child node to be removed / 子节点
      */
     removeChild<T extends AstNodes>(node: T): T;
     /**
+     * Insert a child node before the reference node
+     *
      * 在指定位置前插入子节点
-     * @param child 插入节点
-     * @param reference 指定位置处的子节点
+     * @param child node to be inserted / 插入节点
+     * @param reference reference child node / 指定位置处的子节点
      */
     insertBefore(child: string, reference?: AstNodes): AstText;
     insertBefore<T extends AstNodes>(child: T, reference?: AstNodes): T;
+    /**
+     * Get the caret position from the point
+     *
+     * 找到给定位置
+     * @param x column number / 列数
+     * @param y line number / 行数
+     */
+    caretPositionFromPoint(x: number, y: number): CaretPosition | undefined;
+    /**
+     * Get all ancestor elements from the character index
+     *
+     * 找到给定位置所在的所有节点
+     * @param index character index / 位置
+     */
+    elementsFromIndex(index?: number): Token[];
+    /**
+     * Get all ancestor elements from the position
+     *
+     * 找到给定位置所在的所有节点
+     * @param x column number / 列数
+     * @param y line number / 行数
+     */
+    elementsFromPoint(x: number, y: number): Token[];
 }
+export {};