wikilint 2.16.3 → 2.16.5

package/dist/src/index.js

@@ -50,8 +50,10 @@ const index_1 = require("../index");
 const element_1 = require("../lib/element");
 const text_1 = require("../lib/text");
 /**
+ * base class for all tokens
+ *
  * 所有节点的基类
- * @classdesc `{childNodes: ...(AstText|Token)}`
+ * @classdesc `{childNodes: (AstText|Token)[]}`
  */
 class Token extends element_1.AstElement {
     #type = 'plain';
@@ -80,7 +82,7 @@ class Token extends element_1.AstElement {
         accum.push(this);
     }
     /** @private */
-    parseOnce(n = this.#stage, include = false) {
+    parseOnce(n = this.#stage, include = false, tidy) {
         if (n < this.#stage || this.length === 0 || !this.getAttribute('plain')) {
             return this;
         }
@@ -110,10 +112,10 @@ class Token extends element_1.AstElement {
                 this.#parseHrAndDoubleUnderscore();
                 break;
             case 5:
-                this.#parseLinks();
+                this.#parseLinks(tidy);
                 break;
             case 6:
-                this.#parseQuotes();
+                this.#parseQuotes(tidy);
                 break;
             case 7:
                 this.#parseExternalLinks();
@@ -130,7 +132,7 @@ class Token extends element_1.AstElement {
         }
         if (this.type === 'root') {
             for (const token of this.#accum) {
-                token?.parseOnce(n, include); // eslint-disable-line @typescript-eslint/no-unnecessary-condition
+                token?.parseOnce(n, include, tidy); // eslint-disable-line @typescript-eslint/no-unnecessary-condition
             }
         }
         this.#stage++;
@@ -179,10 +181,10 @@ class Token extends element_1.AstElement {
         this.#built = true;
     }
     /** @private */
-    parse(n = constants_1.MAX_STAGE, include) {
+    parse(n = constants_1.MAX_STAGE, include, tidy) {
         n = Math.min(n, constants_1.MAX_STAGE);
         while (this.#stage < n) {
-            this.parseOnce(this.#stage, include);
+            this.parseOnce(this.#stage, include, tidy);
         }
         if (n) {
             this.build();
@@ -237,20 +239,26 @@ class Token extends element_1.AstElement {
         const { parseHrAndDoubleUnderscore } = require('../parser/hrAndDoubleUnderscore');
         this.setText(parseHrAndDoubleUnderscore(this, this.#config, this.#accum));
     }
-    /** 解析内部链接 */
-    #parseLinks() {
+    /**
+     * 解析内部链接
+     * @param tidy 是否整理
+     */
+    #parseLinks(tidy) {
         const { parseLinks } = require('../parser/links');
-        this.setText(parseLinks(this.firstChild.toString(), this.#config, this.#accum));
+        this.setText(parseLinks(this.firstChild.toString(), this.#config, this.#accum, tidy));
     }
-    /** 解析单引号 */
-    #parseQuotes() {
+    /**
+     * 解析单引号
+     * @param tidy 是否整理
+     */
+    #parseQuotes(tidy) {
         if (this.#config.excludes?.includes('quote')) {
             return;
         }
         const { parseQuotes } = require('../parser/quotes');
         const lines = this.firstChild.toString().split('\n');
         for (let i = 0; i < lines.length; i++) {
-            lines[i] = parseQuotes(lines[i], this.#config, this.#accum);
+            lines[i] = parseQuotes(lines[i], this.#config, this.#accum, tidy);
         }
         this.setText(lines.join('\n'));
     }
@@ -276,8 +284,8 @@ class Token extends element_1.AstElement {
             return;
         }
         const { parseList } = require('../parser/list');
-        const lines = this.firstChild.toString().split('\n'), state = { lastPrefix: '' };
-        let i = this.type === 'root' || this.type === 'ext-inner' && this.name === 'poem' ? 0 : 1;
+        const { firstChild, type, name } = this, lines = firstChild.toString().split('\n'), state = { lastPrefix: '' };
+        let i = type === 'root' || type === 'ext-inner' && name === 'poem' ? 0 : 1;
         for (; i < lines.length; i++) {
             lines[i] = parseList(lines[i], state, this.#config, this.#accum);
         }
@@ -323,14 +331,16 @@ class Token extends element_1.AstElement {
     insertAt(child, i = this.length) {
         const token = typeof child === 'string' ? new text_1.AstText(child) : child;
         super.insertAt(token, i);
-        if (token.type === 'root') {
+        const { type, } = token;
+        if (type === 'root') {
             token.type = 'plain';
         }
         return token;
     }
     /** @private */
-    normalizeTitle(title, defaultNs = 0, halfParsed, decode, selfLink) {
-        return index_1.default.normalizeTitle(title, defaultNs, this.#include, this.#config, halfParsed, decode, selfLink);
+    normalizeTitle(title, defaultNs = 0, temporary, halfParsed, decode, selfLink) {
+        return index_1.default
+            .normalizeTitle(title, defaultNs, this.#include, this.#config, temporary, halfParsed, decode, selfLink);
     }
     /** @private */
     lint(start = this.getAbsoluteIndex(), re) {
@@ -419,60 +429,5 @@ class Token extends element_1.AstElement {
                 }
             });
     }
-    /**
-     * 找到给定位置
-     * @param index 位置
-     */
-    caretPositionFromIndex(index) {
-        LSP: { // eslint-disable-line no-unused-labels
-            if (index === undefined) {
-                return undefined;
-            }
-            const { length } = this.toString();
-            if (index > length || index < -length) {
-                return undefined;
-            }
-            index += index < 0 ? length : 0;
-            let self = this, acc = 0, start = 0;
-            while (self.type !== 'text') {
-                const { childNodes } = self;
-                acc += self.getAttribute('padding');
-                for (let i = 0; acc < index && i < childNodes.length; i++) {
-                    const cur = childNodes[i], l = cur.toString().length;
-                    acc += l;
-                    if (acc >= index) {
-                        self = cur;
-                        acc -= l;
-                        start = acc;
-                        break;
-                    }
-                    acc += self.getGaps(i);
-                }
-                if (self.childNodes === childNodes) {
-                    return { offsetNode: self, offset: index - start };
-                }
-            }
-            return { offsetNode: self, offset: index - start };
-        }
-    }
-    /**
-     * 找到给定位置所在的最外层节点
-     * @param index 位置
-     */
-    elementFromIndex(index) {
-        LSP: { // eslint-disable-line no-unused-labels
-            const node = this.caretPositionFromIndex(index)?.offsetNode;
-            return node?.type === 'text' ? node.parentNode : node;
-        }
-    }
-    /**
-     * 找到给定位置所在的最外层节点
-     * @param x 列数
-     * @param y 行数
-     */
-    elementFromPoint(x, y) {
-        // eslint-disable-next-line no-unused-labels
-        LSP: return this.elementFromIndex(this.indexFromPos(y, x));
-    }
 }
 exports.Token = Token;

package/dist/src/link/base.d.ts

@@ -4,8 +4,10 @@ import { AtomToken } from '../atom';
 import type { LintError } from '../../base';
 import type { Title } from '../../lib/title';
 /**
+ * internal link
+ *
  * 内链
- * @classdesc `{childNodes: [AtomToken, ...Token]}`
+ * @classdesc `{childNodes: [AtomToken, ...Token[]]}`
  */
 export declare abstract class LinkBaseToken extends Token {
     #private;
@@ -14,6 +16,8 @@ export declare abstract class LinkBaseToken extends Token {
     readonly childNodes: readonly [AtomToken, ...Token[]];
     abstract get firstChild(): AtomToken;
     abstract get lastChild(): Token;
+    /** full link / 完整链接 */
+    get link(): string | Title;
     /**
      * @param link 链接标题
      * @param linkText 链接显示文字

package/dist/src/link/base.js

@@ -14,13 +14,20 @@ const atom_1 = require("../atom");
  */
 const isLink = (type) => type === 'redirect-target' || type === 'link';
 /**
+ * internal link
+ *
  * 内链
- * @classdesc `{childNodes: [AtomToken, ...Token]}`
+ * @classdesc `{childNodes: [AtomToken, ...Token[]]}`
  */
 class LinkBaseToken extends index_2.Token {
     #bracket = true;
     #delimiter;
     #title;
+    /** full link / 完整链接 */
+    get link() {
+        // eslint-disable-next-line no-unused-labels
+        LSP: return this.#title;
+    }
     /**
      * @param link 链接标题
      * @param linkText 链接显示文字
@@ -91,9 +98,9 @@ class LinkBaseToken extends index_2.Token {
             errors.push(e);
         }
         if (type === 'link' || type === 'category') {
-            const textNode = linkText?.childNodes.find((c) => c.type === 'text' && c.data.includes('|'));
+            const j = linkText?.childNodes.findIndex(c => c.type === 'text' && c.data.includes('|')), textNode = linkText?.childNodes[j];
             if (textNode) {
-                const e = (0, lint_1.generateForChild)(linkText, rect, 'pipe-like', 'additional "|" in the link text', 'warning'), i = e.startIndex + textNode.getRelativeIndex();
+                const e = (0, lint_1.generateForChild)(linkText, rect, 'pipe-like', 'additional "|" in the link text', 'warning'), i = e.startIndex + linkText.getRelativeIndex(j);
                 e.suggestions = [
                     {
                         desc: 'escape',
@@ -105,10 +112,13 @@ class LinkBaseToken extends index_2.Token {
             }
         }
         if (fragment !== undefined && !isLink(type)) {
-            const e = (0, lint_1.generateForChild)(target, rect, 'no-ignored', 'useless fragment'), textNode = target.childNodes.find((c) => c.type === 'text' && c.data.includes('#'));
+            const e = (0, lint_1.generateForChild)(target, rect, 'no-ignored', 'useless fragment'), j = target.childNodes.findIndex(c => c.type === 'text' && c.data.includes('#')), textNode = target.childNodes[j];
             if (textNode) {
                 e.fix = {
-                    range: [e.startIndex + textNode.getRelativeIndex() + textNode.data.indexOf('#'), e.endIndex],
+                    range: [
+                        e.startIndex + target.getRelativeIndex(j) + textNode.data.indexOf('#'),
+                        e.endIndex,
+                    ],
                     text: '',
                     desc: 'remove',
                 };
@@ -118,8 +128,8 @@ class LinkBaseToken extends index_2.Token {
         return errors;
     }
     /** @private */
-    getTitle(halfParsed) {
-        return this.normalizeTitle(this.firstChild.toString(true), 0, halfParsed, true, true);
+    getTitle(temporary, halfParsed) {
+        return this.normalizeTitle(this.firstChild.toString(true), 0, temporary, halfParsed, true, true);
     }
 }
 exports.LinkBaseToken = LinkBaseToken;

package/dist/src/link/category.d.ts

@@ -1,10 +1,14 @@
 import { LinkBaseToken } from './base';
+import type { Title } from '../../lib/title';
 import type { Token, AtomToken } from '../../internal';
 /**
+ * category
+ *
  * 分类
  * @classdesc `{childNodes: [AtomToken, ?Token]}`
  */
 export declare abstract class CategoryToken extends LinkBaseToken {
     readonly childNodes: readonly [AtomToken] | readonly [AtomToken, Token];
+    abstract get link(): Title;
     get type(): 'category';
 }

package/dist/src/link/category.js

@@ -3,6 +3,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.CategoryToken = void 0;
 const base_1 = require("./base");
 /**
+ * category
+ *
  * 分类
  * @classdesc `{childNodes: [AtomToken, ?Token]}`
  */

package/dist/src/link/file.d.ts

@@ -4,36 +4,46 @@ import { ImageParameterToken } from '../imageParameter';
 import type { LintError } from '../../base';
 import type { Token, AtomToken } from '../../internal';
 /**
+ * image
+ *
  * 图片
- * @classdesc `{childNodes: [AtomToken, ...ImageParameterToken]}`
+ * @classdesc `{childNodes: [AtomToken, ...ImageParameterToken[]]}`
  */
 export declare abstract class FileToken extends LinkBaseToken {
     readonly childNodes: readonly [AtomToken, ...ImageParameterToken[]];
     abstract get lastChild(): AtomToken | ImageParameterToken;
     get type(): 'file' | 'gallery-image' | 'imagemap-image';
-    /** 扩展名 */
-    get extension(): string | undefined;
     /**
      * @param link 文件名
      * @param text 图片参数
      * @param delimiter `|`
      */
     constructor(link: string, text?: string, config?: Parser.Config, accum?: Token[], delimiter?: string);
-    /** 获取所有图片参数节点 */
+    /**
+     * Get all image parameter tokens
+     *
+     * 获取所有图片参数节点
+     */
     getAllArgs(): ImageParameterToken[];
     /**
+     * Get image parameters with the specified name
+     *
      * 获取指定图片参数
-     * @param key 参数名
+     * @param key parameter name / 参数名
      */
     getArgs(key: string): ImageParameterToken[];
     /**
+     * Get the effective image parameter with the specified name
+     *
      * 获取生效的指定图片参数
-     * @param key 参数名
+     * @param key parameter name / 参数名
      */
     getArg(key: string): ImageParameterToken | undefined;
     /**
+     * Get the effective image parameter value
+     *
      * 获取生效的指定图片参数值
-     * @param key 参数名
+     * @param key parameter name / 参数名
      */
     getValue(key: string): string | true | undefined;
 }

package/dist/src/link/file.js

@@ -41,17 +41,15 @@ const explode = (start, end, separator, str) => {
     return exploded;
 };
 /**
+ * image
+ *
  * 图片
- * @classdesc `{childNodes: [AtomToken, ...ImageParameterToken]}`
+ * @classdesc `{childNodes: [AtomToken, ...ImageParameterToken[]]}`
  */
 class FileToken extends base_1.LinkBaseToken {
     get type() {
         return 'file';
     }
-    /** 扩展名 */
-    get extension() {
-        return this.getTitle().extension;
-    }
     /**
      * @param link 文件名
      * @param text 图片参数
@@ -59,7 +57,7 @@ class FileToken extends base_1.LinkBaseToken {
      */
     constructor(link, text, config = index_1.default.getConfig(), accum = [], delimiter = '|') {
         super(link, undefined, config, accum, delimiter);
-        const { extension } = this.getTitle(true);
+        const { extension } = this.getTitle(true, true);
         this.append(...explode('-{', '}-', '|', text).map(
         // @ts-expect-error abstract class
         (part) => new imageParameter_1.ImageParameterToken(part, extension, config, accum)));
@@ -70,7 +68,8 @@ class FileToken extends base_1.LinkBaseToken {
             const visibleNodes = childNodes.filter(node => node.text().trim());
             return visibleNodes.length !== 1 || visibleNodes[0].type !== 'arg';
         }), keys = [...new Set(args.map(({ name }) => name))], frameKeys = keys.filter(key => frame.has(key)), horizAlignKeys = keys.filter(key => horizAlign.has(key)), vertAlignKeys = keys.filter(key => vertAlign.has(key)), [fr] = frameKeys, unscaled = fr === 'framed' || fr === 'manualthumb', rect = new rect_1.BoundingRect(this, start);
-        if (this.closest('ext-link-text') && this.getValue('link')?.trim() !== '') {
+        if (this.closest('ext-link-text')
+            && this.getValue('link')?.trim() !== '') {
             errors.push((0, lint_1.generateForSelf)(this, rect, 'nested-link', 'internal link in an external link'));
         }
         if (unscaled) {
@@ -102,7 +101,10 @@ class FileToken extends base_1.LinkBaseToken {
             }
             let relevantArgs = args.filter(({ name }) => name === key);
             if (key === 'caption') {
-                relevantArgs = [...relevantArgs.slice(0, -1).filter(arg => arg.text()), ...relevantArgs.slice(-1)];
+                relevantArgs = [
+                    ...relevantArgs.slice(0, -1).filter(arg => arg.text()),
+                    ...relevantArgs.slice(-1),
+                ];
             }
             if (relevantArgs.length > 1) {
                 errors.push(...relevantArgs.map(generate('duplicated', key)));
@@ -112,35 +114,47 @@ class FileToken extends base_1.LinkBaseToken {
             errors.push(...args.filter(({ name }) => frame.has(name)).map(generate('conflicting', 'frame')));
         }
         if (horizAlignKeys.length > 1) {
-            errors.push(...args.filter(({ name }) => horizAlign.has(name)).map(generate('conflicting', 'horizontal-alignment')));
+            errors.push(...args.filter(({ name }) => horizAlign.has(name))
+                .map(generate('conflicting', 'horizontal-alignment')));
         }
         if (vertAlignKeys.length > 1) {
-            errors.push(...args.filter(({ name }) => vertAlign.has(name)).map(generate('conflicting', 'vertical-alignment')));
+            errors.push(...args.filter(({ name }) => vertAlign.has(name))
+                .map(generate('conflicting', 'vertical-alignment')));
         }
         return errors;
     }
-    /** 获取所有图片参数节点 */
+    /**
+     * Get all image parameter tokens
+     *
+     * 获取所有图片参数节点
+     */
     getAllArgs() {
         return this.childNodes.slice(1);
     }
     /**
+     * Get image parameters with the specified name
+     *
      * 获取指定图片参数
-     * @param key 参数名
+     * @param key parameter name / 参数名
      */
     getArgs(key) {
         return this.getAllArgs().filter(({ name }) => key === name);
     }
     /**
+     * Get the effective image parameter with the specified name
+     *
      * 获取生效的指定图片参数
-     * @param key 参数名
+     * @param key parameter name / 参数名
      */
     getArg(key) {
         const args = this.getArgs(key);
         return args[key === 'manualthumb' ? 0 : args.length - 1];
     }
     /**
+     * Get the effective image parameter value
+     *
      * 获取生效的指定图片参数值
-     * @param key 参数名
+     * @param key parameter name / 参数名
      */
     getValue(key) {
         return this.getArg(key)?.getValue();

package/dist/src/link/galleryImage.d.ts

@@ -4,7 +4,11 @@ import { FileToken } from './file';
 import type { Title } from '../../lib/title';
 import type { LintError } from '../../base';
 declare type GalleryTypes = 'gallery' | 'imagemap';
-/** 图库图片 */
+/**
+ * gallery image
+ *
+ * 图库图片
+ */
 export declare abstract class GalleryImageToken extends FileToken {
     get type(): `${GalleryTypes}-image`;
     /**

package/dist/src/link/galleryImage.js

@@ -6,7 +6,11 @@ const constants_1 = require("../../util/constants");
 const index_1 = require("../../index");
 const index_2 = require("../index");
 const file_1 = require("./file");
-/** 图库图片 */
+/**
+ * gallery image
+ *
+ * 图库图片
+ */
 class GalleryImageToken extends file_1.FileToken {
     /** @private */
     privateType = 'imagemap-image';
@@ -34,9 +38,9 @@ class GalleryImageToken extends file_1.FileToken {
         this.seal('privateType', true);
     }
     /** @private */
-    getTitle() {
+    getTitle(temporary) {
         const imagemap = this.type === 'imagemap-image';
-        return this.normalizeTitle(this.firstChild.toString(), imagemap ? 0 : 6, true, !imagemap);
+        return this.normalizeTitle(this.firstChild.toString(), imagemap ? 0 : 6, temporary, true, !imagemap);
     }
     /** @private */
     getAttribute(key) {
@@ -44,8 +48,8 @@ class GalleryImageToken extends file_1.FileToken {
     }
     /** @private */
     lint(start = this.getAbsoluteIndex(), re) {
-        const errors = super.lint(start, re), { ns, interwiki } = this.getAttribute('title');
-        if (interwiki || ns !== 6) {
+        const errors = super.lint(start, re), { ns, } = this.getAttribute('title');
+        if (ns !== 6) {
             const e = (0, lint_1.generateForSelf)(this, { start }, 'invalid-gallery', 'invalid gallery image');
             e.suggestions = [{ desc: 'prefix', range: [start, start], text: 'File:' }];
             errors.push(e);

package/dist/src/link/index.d.ts

@@ -1,11 +1,15 @@
 import { LinkBaseToken } from './base';
 import type { LintError } from '../../base';
+import type { Title } from '../../lib/title';
 import type { Token, AtomToken } from '../../internal';
 /**
+ * internal link
+ *
  * 内链
  * @classdesc `{childNodes: [AtomToken, ?Token]}`
  */
 export declare abstract class LinkToken extends LinkBaseToken {
     readonly childNodes: readonly [AtomToken] | readonly [AtomToken, Token];
+    abstract get link(): Title;
     get type(): 'link';
 }

package/dist/src/link/index.js

@@ -4,6 +4,8 @@ exports.LinkToken = void 0;
 const lint_1 = require("../../util/lint");
 const base_1 = require("./base");
 /**
+ * internal link
+ *
  * 内链
  * @classdesc `{childNodes: [AtomToken, ?Token]}`
  */

package/dist/src/link/redirectTarget.d.ts

@@ -4,17 +4,19 @@ import type { LintError, Config } from '../../base';
 import type { Title } from '../../lib/title';
 import type { Token, AtomToken } from '../../internal';
 /**
+ * target of a redirect
+ *
  * 重定向目标
  * @classdesc `{childNodes: [AtomToken, ?NoincludeToken]}`
  */
 export declare abstract class RedirectTargetToken extends LinkBaseToken {
     readonly childNodes: readonly [AtomToken] | readonly [AtomToken, NoincludeToken];
     abstract get lastChild(): AtomToken | NoincludeToken;
+    abstract get link(): Title;
     get type(): 'redirect-target';
     /**
      * @param link 链接标题
      * @param linkText 链接显示文字
-     * @param delimiter `|`
      */
     constructor(link: string, linkText?: string, config?: Config, accum?: Token[]);
 }

package/dist/src/link/redirectTarget.js

@@ -5,6 +5,8 @@ const lint_1 = require("../../util/lint");
 const base_1 = require("./base");
 const noinclude_1 = require("../nowiki/noinclude");
 /**
+ * target of a redirect
+ *
  * 重定向目标
  * @classdesc `{childNodes: [AtomToken, ?NoincludeToken]}`
  */
@@ -15,7 +17,6 @@ class RedirectTargetToken extends base_1.LinkBaseToken {
     /**
      * @param link 链接标题
      * @param linkText 链接显示文字
-     * @param delimiter `|`
      */
     constructor(link, linkText, config, accum) {
         super(link, undefined, config, accum);
@@ -26,7 +27,8 @@ class RedirectTargetToken extends base_1.LinkBaseToken {
     }
     /** @private */
     getTitle() {
-        return this.normalizeTitle(this.firstChild.toString(), 0, true, true);
+        return this
+            .normalizeTitle(this.firstChild.toString(), 0, false, true, true);
     }
     /** @private */
     lint(start = this.getAbsoluteIndex()) {

package/dist/src/magicLink.d.ts

@@ -4,8 +4,10 @@ import type { LintError } from '../base';
 import type { AstText, CommentToken, IncludeToken, NoincludeToken, TranscludeToken } from '../internal';
 declare type ExtLinkTypes = 'free-ext-link' | 'ext-link-url' | 'magic-link';
 /**
+ * free external link
+ *
  * 自由外链
- * @classdesc `{childNodes: ...AstText|CommentToken|IncludeToken|NoincludeToken}`
+ * @classdesc `{childNodes: (AstText|CommentToken|IncludeToken|NoincludeToken)[]}`
  */
 export declare abstract class MagicLinkToken extends Token {
     #private;
@@ -13,14 +15,21 @@ export declare abstract class MagicLinkToken extends Token {
     abstract get firstChild(): AstText | TranscludeToken;
     abstract get lastChild(): AstText | CommentToken | IncludeToken | NoincludeToken | TranscludeToken;
     get type(): ExtLinkTypes;
-    /** 链接显示文字 */
+    /** text of the link / 链接显示文字 */
     get innerText(): string;
-    /** 和内链保持一致 */
+    /** link / 链接 */
     get link(): string;
     /**
      * @param url 网址
      * @param type 类型
      */
     constructor(url?: string, type?: ExtLinkTypes, config?: Parser.Config, accum?: Token[]);
+    /**
+     * Get the URL
+     *
+     * 获取网址
+     * @param articlePath article path / 条目路径
+     */
+    getUrl(articlePath?: string): URL | string;
 }
 export {};