wikiparser-node 1.22.1 → 1.24.0

package/dist/lib/lsp.js

@@ -5,6 +5,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.LanguageService = exports.isAttr = exports.tasks = void 0;
 const common_1 = require("@bhsd/common");
+const base_1 = require("../base");
 const sharable_1 = require("../util/sharable");
 const lint_1 = require("../util/lint");
 const string_1 = require("../util/string");
@@ -21,14 +22,11 @@ const crypto_1 = require("crypto");
 const stylelint_util_1 = require("@bhsd/stylelint-util");
 const document_1 = require("./document");
 /** @see https://www.npmjs.com/package/stylelint-config-recommended */
-const cssRules = {
-    'block-no-empty': null,
-    'property-no-unknown': null,
-}, jsonSelector = document_1.jsonTags.map(s => `ext#${s}`).join(), mathTags = ['math', 'chem', 'ce'], mathSelector = mathTags.map(s => `ext#${s}`).join(), scores = new Map();
+const cssRules = { 'block-no-empty': null }, jsonSelector = document_1.jsonTags.map(s => `ext#${s}`).join(), mathTags = ['math', 'chem', 'ce'], mathSelector = mathTags.map(s => `ext#${s}`).join(), scores = new Map();
 let colors;
 /* NOT FOR BROWSER ONLY END */
 exports.tasks = new WeakMap();
-const refTags = new Set(['ref']), referencesTags = new Set(['ref', 'references']), nameAttrs = new Set(['name', 'extends', 'follow']), groupAttrs = new Set(['group']), renameTypes = new Set([
+const refTags = new Set(['ref']), referencesTags = new Set(['ref', 'references']), nameAttrs = new Set(['name', 'follow']), groupAttrs = new Set(['group']), renameTypes = new Set([
     'arg-name',
     'template-name',
     'link-target',
@@ -204,6 +202,32 @@ const getQuickFix = (root, fix, preferred = false) => ({
     title: `${preferred ? 'Fix' : 'Suggestion'}: ${fix.desc}`,
     fix: preferred,
 });
+/**
+ * Get the fix-all data.
+ * @param root root token
+ * @param rule rule to be fixed
+ */
+const getFixAll = (root, rule) => {
+    const { lintConfig } = index_1.default;
+    if (rule) {
+        index_1.default.lintConfig = {};
+        for (const key of base_1.rules) {
+            index_1.default.lintConfig[key] = key === rule ? lintConfig[key] : 0;
+        }
+    }
+    const { output } = root.lint();
+    if (rule) {
+        index_1.default.lintConfig = lintConfig;
+    }
+    return output === undefined
+        ? []
+        : [
+            {
+                range: createNodeRange(root),
+                newText: output,
+            },
+        ];
+};
 /* NOT FOR BROWSER ONLY */
 /**
  * Correct the position of an error.
@@ -909,6 +933,27 @@ class LanguageService {
             mathDiagnostics,
         ].flat(2);
     }
+    /**
+     * Resolve fix-all code action
+     *
+     * 实现修复全部代码的操作
+     * @param action code action / 代码操作
+     * @since v1.24.0
+     */
+    resolveCodeAction(action) {
+        if (action.kind !== 'source.fixAll') {
+            return action;
+        }
+        const { rule } = action.data;
+        return {
+            ...action,
+            edit: {
+                changes: {
+                    '': getFixAll(this.#done, rule),
+                },
+            },
+        };
+    }
     /**
      * Provide folding ranges
      *
@@ -1344,6 +1389,54 @@ class LanguageService {
     findStyleTokens() {
         return this.#done.querySelectorAll(cssSelector).filter(({ lastChild }) => (0, exports.isAttr)(lastChild));
     }
+    /**
+     * Provide refactoring actions
+     *
+     * 提供重构操作
+     * @param text source Wikitext / 源代码
+     * @param range range of the refactoring / 重构范围
+     * @since v1.24.0
+     */
+    async provideRefactoringAction(text, range) {
+        let lines, selected;
+        if (range) {
+            const { start, end } = range;
+            if (start.line === end.line && start.character === end.character) {
+                return [];
+            }
+            lines = text.split(/\r?\n/u, end.line + 1);
+            selected = start.line === end.line
+                ? lines[end.line].slice(start.character, end.character)
+                : `${lines[start.line].slice(start.character)}\n${lines.slice(start.line + 1, end.line).join('\n')}${lines.length === 2 ? '' : '\n'}${lines[end.line].slice(0, end.character)}`;
+        }
+        else if (text) {
+            lines = text.split(/\r?\n/u);
+            selected = lines.join('\n');
+            range = {
+                start: { line: 0, character: 0 },
+                end: { line: lines.length - 1, character: lines[lines.length - 1].length },
+            };
+        }
+        else {
+            return [];
+        }
+        const root = await this.#queueSignature(selected);
+        const { viewOnly } = index_1.default;
+        index_1.default.viewOnly = false;
+        root.escape();
+        index_1.default.viewOnly = viewOnly;
+        return [
+            {
+                title: 'Escape with magic words',
+                kind: 'refactor.rewrite',
+                edit: {
+                    changes: {
+                        '': [{ range, newText: root.toString() }],
+                    },
+                },
+            },
+        ];
+    }
     /* NOT FOR BROWSER ONLY */
     /**
      * Provide quick fixes
@@ -1353,15 +1446,36 @@ class LanguageService {
      */
     // eslint-disable-next-line @typescript-eslint/class-methods-use-this
     provideCodeAction(diagnostics) {
-        return diagnostics.filter((diagnostic) => diagnostic.data).flatMap(diagnostic => diagnostic.data.map((data) => ({
-            title: data.title,
-            kind: 'quickfix',
-            diagnostics: [diagnostic],
-            isPreferred: data.fix,
-            edit: {
-                changes: { '': [data] },
-            },
-        })));
+        const actionable = diagnostics.filter((diagnostic) => diagnostic.data), fixable = actionable.filter(({ source, data }) => source === 'WikiLint' && data.some(({ fix }) => fix)), fixableRules = [...new Set(fixable.map(({ code }) => code))];
+        return [
+            ...actionable.flatMap(diagnostic => diagnostic.data.map((data) => ({
+                title: data.title,
+                kind: 'quickfix',
+                diagnostics: [diagnostic],
+                isPreferred: data.fix,
+                edit: {
+                    changes: { '': [data] },
+                },
+            }))),
+            ...fixable.length === 0
+                ? []
+                : [
+                    ...fixableRules.map((rule) => ({
+                        title: `Fix all: ${rule}`,
+                        kind: 'source.fixAll',
+                        diagnostics: fixable.filter(({ code }) => code === rule),
+                        isPreferred: true,
+                        data: { rule },
+                    })),
+                    {
+                        title: 'Fix all: WikiLint',
+                        kind: 'source.fixAll',
+                        diagnostics: fixable,
+                        isPreferred: true,
+                        data: {},
+                    },
+                ],
+        ];
     }
     /**
      * Provide document sections
@@ -1409,17 +1523,18 @@ class LanguageService {
      *
      * 设置目标维基百科
      * @param wiki Wikipedia URL / 维基百科网址
+     * @param user URI for wiki userpage or email address of the user / 维基用户页面地址或用户的电子邮件地址
      * @throws `RangeError` 不是有效的维基百科网址
      * @since v1.18.1
      */
-    async setTargetWikipedia(wiki) {
+    async setTargetWikipedia(wiki, user) {
         const [site, host] = index_1.default.getWMFSite(wiki);
         try {
             const config = require(path_1.default.join('..', '..', 'config', site));
             this.config = index_1.default.getConfig(config);
         }
         catch {
-            this.config = await index_1.default.fetchConfig(site, `${host}/w`);
+            this.config = await index_1.default.fetchConfig(site, `${host}/w`, user);
         }
         Object.assign(this.config, { articlePath: `${host}/wiki/` });
     }

package/dist/lib/node.d.ts

@@ -1,4 +1,5 @@
 import type { LintError, AstNode as AstNodeBase, TokenTypes } from '../base';
+import type { NodeLike } from '../mixin/nodeLike';
 import type { AstText, Token } from '../internal';
 export type AstNodes = AstText | Token;
 export interface Dimension {
@@ -17,6 +18,8 @@ export interface Font {
     bold: boolean;
     italic: boolean;
 }
+export interface AstNode extends NodeLike {
+}
 /**
  * Node-like
  *
@@ -38,20 +41,12 @@ export declare abstract class AstNode implements AstNodeBase {
         output?: string;
     };
     print(): string;
-    /** first child node / 首位子节点 */
-    get firstChild(): AstNodes | undefined;
-    /** last child node / 末位子节点 */
-    get lastChild(): AstNodes | undefined;
     /** parent node / 父节点 */
     get parentNode(): Token | undefined;
     /** next sibling node / 后一个兄弟节点 */
     get nextSibling(): AstNodes | undefined;
     /** previous sibling node / 前一个兄弟节点 */
     get previousSibling(): AstNodes | undefined;
-    /** number of lines / 行数 */
-    get offsetHeight(): number;
-    /** number of columns of the last line / 最后一行的列数 */
-    get offsetWidth(): number;
     /** next sibling element / 后一个非文本兄弟节点 */
     get nextElementSibling(): Token | undefined;
     /** previous sibling element / 前一个非文本兄弟节点 */
@@ -175,8 +170,9 @@ export declare abstract class AstNode implements AstNodeBase {
      * Remove the current node
      *
      * 移除当前节点
+     * @param ownLine whether to remove the current line if it is empty / 是否删除所在的空行
      */
-    remove(): void;
+    remove(ownLine?: boolean): void;
     /**
      * Replace the current node with new nodes
      *

package/dist/lib/node.js

@@ -42,6 +42,7 @@ exports.AstNode = void 0;
 const lint_1 = require("../util/lint");
 const debug_1 = require("../util/debug");
 const cached_1 = require("../mixin/cached");
+const nodeLike_1 = require("../mixin/nodeLike");
 /* PRINT ONLY */
 const index_1 = __importDefault(require("../index"));
 /* PRINT ONLY END */
@@ -55,14 +56,22 @@ const constants_1 = require("../util/constants");
  * 类似Node
  */
 let AstNode = (() => {
+    let _classDecorators = [nodeLike_1.nodeLike];
+    let _classDescriptor;
+    let _classExtraInitializers = [];
+    let _classThis;
     let _instanceExtraInitializers = [];
     let _getLines_decorators;
-    return class AstNode {
+    var AstNode = class {
+        static { _classThis = this; }
         static {
             const _metadata = typeof Symbol === "function" && Symbol.metadata ? Object.create(null) : void 0;
             _getLines_decorators = [(0, cached_1.cached)(false)];
             __esDecorate(this, null, _getLines_decorators, { kind: "method", name: "getLines", static: false, private: false, access: { has: obj => "getLines" in obj, get: obj => obj.getLines }, metadata: _metadata }, null, _instanceExtraInitializers);
-            if (_metadata) Object.defineProperty(this, Symbol.metadata, { enumerable: true, configurable: true, writable: true, value: _metadata });
+            __esDecorate(null, _classDescriptor = { value: _classThis }, _classDecorators, { kind: "class", name: _classThis.name, metadata: _metadata }, null, _classExtraInitializers);
+            AstNode = _classThis = _classDescriptor.value;
+            if (_metadata) Object.defineProperty(_classThis, Symbol.metadata, { enumerable: true, configurable: true, writable: true, value: _metadata });
+            __runInitializers(_classThis, _classExtraInitializers);
         }
         childNodes = (__runInitializers(this, _instanceExtraInitializers), []);
         #parentNode;
@@ -74,14 +83,6 @@ let AstNode = (() => {
         /* NOT FOR BROWSER */
         #optional = new Set();
         #events = new events_1.EventEmitter();
-        /** first child node / 首位子节点 */
-        get firstChild() {
-            return this.childNodes[0];
-        }
-        /** last child node / 末位子节点 */
-        get lastChild() {
-            return this.childNodes[this.childNodes.length - 1];
-        }
         /** parent node / 父节点 */
         get parentNode() {
             return this.#parentNode;
@@ -94,14 +95,6 @@ let AstNode = (() => {
         get previousSibling() {
             return this.#previousSibling;
         }
-        /** number of lines / 行数 */
-        get offsetHeight() {
-            return this.#getDimension().height;
-        }
-        /** number of columns of the last line / 最后一行的列数 */
-        get offsetWidth() {
-            return this.#getDimension().width;
-        }
         /* NOT FOR BROWSER */
         /** next sibling element / 后一个非文本兄弟节点 */
         get nextElementSibling() {
@@ -159,7 +152,7 @@ let AstNode = (() => {
         get style() {
             return {
                 ...this.#getPosition(),
-                ...this.#getDimension(),
+                ...this.getDimension(),
                 padding: this.getAttribute('padding'),
             };
         }
@@ -300,8 +293,8 @@ let AstNode = (() => {
             }
             return undefined;
         }
-        /** 获取行数和最后一行的列数 */
-        #getDimension() {
+        /** @private */
+        getDimension() {
             const lines = this.getLines(), last = lines[lines.length - 1];
             return { height: lines.length, width: last[2] - last[1] };
         }
@@ -360,7 +353,7 @@ let AstNode = (() => {
         getBoundingClientRect() {
             // eslint-disable-next-line no-unused-labels
             LSP: return {
-                ...this.#getDimension(),
+                ...this.getDimension(),
                 ...this.getRootNode().posFromIndex(this.getAbsoluteIndex()),
             };
         }
@@ -473,9 +466,17 @@ let AstNode = (() => {
          * Remove the current node
          *
          * 移除当前节点
+         * @param ownLine whether to remove the current line if it is empty / 是否删除所在的空行
          */
-        remove() {
-            this.parentNode?.removeChild(this);
+        remove(ownLine) {
+            const { parentNode, nextSibling, previousSibling } = this, i = parentNode?.childNodes.indexOf(this);
+            parentNode?.removeAt(i);
+            if (ownLine
+                && parentNode?.getGaps(i - 1) === 0
+                && nextSibling?.type === 'text' && previousSibling?.type === 'text'
+                && nextSibling.data.startsWith('\n') && previousSibling.data.endsWith('\n')) {
+                nextSibling.deleteData(0, 1);
+            }
         }
         /**
          * Replace the current node with new nodes
@@ -709,6 +710,7 @@ let AstNode = (() => {
             return { bold: Boolean(bold), italic: Boolean(italic), b, i };
         }
     };
+    return AstNode = _classThis;
 })();
 exports.AstNode = AstNode;
 constants_1.classes['AstNode'] = __filename;

package/dist/lib/range.d.ts

@@ -1,5 +1,9 @@
-import type { AstNodes } from '../internal';
+import type { NodeLike } from '../mixin/nodeLike';
+import type { ElementLike } from '../mixin/elementLike';
+import type { AstNodes, Token } from '../internal';
 import type { Dimension, Position } from './node';
+export interface AstRange extends NodeLike, ElementLike {
+}
 /**
  * Range-like
  *
@@ -27,6 +31,13 @@ export declare class AstRange {
     get collapsed(): boolean;
     /** closest common ancestor / 最近的公共祖先 */
     get commonAncestorContainer(): AstNodes;
+    /**
+     * nodes in the Range
+     *
+     * 范围内的节点
+     * @since v1.23.0
+     */
+    get childNodes(): AstNodes[];
     /**
      * Set the start
      *
@@ -129,6 +140,13 @@ export declare class AstRange {
      * 删除Range中的内容
      */
     deleteContents(): void;
+    /**
+     * Remove the contents of the Range
+     *
+     * 删除Range中的内容
+     * @since v1.23.0
+     */
+    remove(): void;
     /**
      * Get the position and dimension
      *
@@ -136,12 +154,44 @@ export declare class AstRange {
      */
     getBoundingClientRect(): Dimension & Position;
     /**
-     * Insert a node at the start
+     * Get the client rects of all nodes in the Range
      *
-     * 在起始位置插入节点
+     * 获取范围内所有节点的行列位置和大小
+     * @since v1.23.0
+     */
+    getClientRects(): (Dimension & Position)[];
+    /**
+     * Insert a node before or after the Range
+     *
+     * 在范围前或后插入节点
      * @param newNode node to be inserted / 插入的节点
+     * @param after whether to insert after the Range / 是否在范围后插入
+     */
+    insertNode(newNode: AstNodes | string, after?: boolean): void;
+    /**
+     * Insert nodes before the Range
+     *
+     * 在范围前插入节点
+     * @param nodes nodes to be inserted / 插入节点
+     * @since v1.23.0
+     */
+    before(...nodes: (AstNodes | string)[]): void;
+    /**
+     * Insert nodes after the Range
+     *
+     * 在范围后插入节点
+     * @param nodes nodes to be inserted / 插入节点
+     * @since v1.23.0
      */
-    insertNode(newNode: AstNodes | string): void;
+    after(...nodes: (AstNodes | string)[]): void;
+    /**
+     * Replace the Range with new nodes
+     *
+     * 将当前范围批量替换为新的节点
+     * @param nodes nodes to be inserted / 插入节点
+     * @since v1.23.0
+     */
+    replaceWith(...nodes: (AstNodes | string)[]): void;
     /**
      * Get the contents of the Range
      *
@@ -154,4 +204,40 @@ export declare class AstRange {
      * 拷贝范围内的全部节点
      */
     cloneContents(): AstNodes[];
+    /**
+     * Get the root node
+     *
+     * 获取根节点
+     * @since v1.23.0
+     */
+    getRootNode(): AstNodes;
+    /**
+     * Get the closest ancestor node that matches the selector
+     *
+     * 最近的符合选择器的祖先节点
+     * @param selector selector / 选择器
+     */
+    closest<T = Token>(selector: string): T | undefined;
+    /**
+     * Insert a batch of child nodes at the end
+     *
+     * 在末尾批量插入子节点
+     * @param elements nodes to be inserted / 插入节点
+     */
+    append(...elements: (AstNodes | string)[]): void;
+    /**
+     * Insert a batch of child nodes at the start
+     *
+     * 在开头批量插入子节点
+     * @param elements nodes to be inserted / 插入节点
+     */
+    prepend(...elements: (AstNodes | string)[]): void;
+    /**
+     * Remove a child node
+     *
+     * 移除子节点
+     * @param node child node to be removed / 子节点
+     * @throws `RangeError` 不是子节点
+     */
+    removeChild<T extends AstNodes>(node: T): T;
 }