wikilint 2.5.7 → 2.6.0

package/dist/mixin/attributesParent.d.ts

@@ -0,0 +1,14 @@
+export interface AttributesParentBase {
+    /**
+     * 获取AttributesToken子节点的属性
+     * @param key 属性键
+     */
+    getAttr(key: string): string | true | undefined;
+}
+/**
+ * 子节点含有AttributesToken的类
+ * @param i AttributesToken子节点的位置
+ * @param constructor 基类
+ * @param _ context
+ */
+export declare const attributesParent: (i?: number) => <T extends AstConstructor>(constructor: T, _?: unknown) => T;

package/dist/mixin/attributesParent.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.attributesParent = void 0;
+/**
+ * 子节点含有AttributesToken的类
+ * @param i AttributesToken子节点的位置
+ * @param constructor 基类
+ * @param _ context
+ */
+const attributesParent = (i = 0) => (constructor, _) => {
+    /** 子节点含有AttributesToken的类 */
+    class AttributesParent extends constructor {
+        /** AttributesToken子节点 */
+        get #attributesChild() {
+            return this.childNodes[i];
+        }
+        /** @implements */
+        getAttr(key) {
+            return this.#attributesChild.getAttr(key);
+        }
+    }
+    Object.defineProperty(AttributesParent, 'name', { value: constructor.name });
+    return AttributesParent;
+};
+exports.attributesParent = attributesParent;

package/dist/mixin/hidden.d.ts

@@ -0,0 +1,5 @@
+/**
+ * 解析后不可见的类
+ * @param constructor 基类
+ */
+export declare const hiddenToken: <T extends AstConstructor>(constructor: T) => T;

package/dist/src/index.d.ts

@@ -2,6 +2,7 @@ import { BuildMethod } from '../util/constants';
 import Parser from '../index';
 import { AstElement } from '../lib/element';
 import { AstText } from '../lib/text';
+import type { LintError } from '../base';
 import type { Title } from '../lib/title';
 import type { AstNodes } from '../internal';
 import type { TokenTypes } from '../util/constants';
@@ -30,4 +31,6 @@ export declare class Token extends AstElement {
      * @param selfLink 是否允许selfLink
      */
     normalizeTitle(title: string, defaultNs?: number, halfParsed?: boolean, decode?: boolean, selfLink?: boolean): Title;
+    /** @override */
+    lint(start?: number, re?: RegExp): LintError[];
 }

package/dist/src/index.js

@@ -41,6 +41,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Token = void 0;
 const string_1 = require("../util/string");
 const constants_1 = require("../util/constants");
+const lint_1 = require("../util/lint");
 const index_1 = require("../index");
 const element_1 = require("../lib/element");
 const text_1 = require("../lib/text");
@@ -317,5 +318,74 @@ class Token extends element_1.AstElement {
     normalizeTitle(title, defaultNs = 0, halfParsed = false, decode = false, selfLink = false) {
         return index_1.default.normalizeTitle(title, defaultNs, this.#include, this.#config, halfParsed, decode, selfLink);
     }
+    /** @override */
+    lint(start = this.getAbsoluteIndex(), re) {
+        const errors = super.lint(start, re);
+        const record = {};
+        for (const cat of this.childNodes.filter((node) => node.type === 'category')) {
+            const thisCat = record[cat.name];
+            if (thisCat) {
+                thisCat.add(cat);
+            }
+            else {
+                record[cat.name] = new Set([cat]);
+            }
+        }
+        for (const value of Object.values(record)) {
+            if (value.size > 1) {
+                errors.push(...[...value].map(cat => {
+                    const e = (0, lint_1.generateForSelf)(cat, { start: cat.getAbsoluteIndex() }, 'no-duplicate', 'duplicated category');
+                    e.suggestions = [
+                        {
+                            desc: 'remove',
+                            range: [e.startIndex, e.endIndex],
+                            text: '',
+                        },
+                    ];
+                    return e;
+                }));
+            }
+        }
+        if (this.type === 'root') {
+            const regex = /<!--\s*lint-(disable(?:(?:-next)?-line)?|enable)(\s[\sa-z,-]*)?-->/gu, wikitext = String(this), ignores = [];
+            let mt = regex.exec(wikitext), last = 0, curLine = 0;
+            while (mt) {
+                const { 1: type, index } = mt, detail = mt[2]?.trim();
+                curLine += wikitext.slice(last, index).split('\n').length - 1;
+                last = index;
+                ignores.push({
+                    line: curLine + (type === 'disable-line' ? 0 : 1),
+                    from: type === 'disable' ? regex.lastIndex : undefined,
+                    to: type === 'enable' ? regex.lastIndex : undefined,
+                    rules: detail ? new Set(detail.split(',').map(r => r.trim())) : undefined,
+                });
+                mt = regex.exec(wikitext);
+            }
+            return errors.filter(({ rule, startLine, startIndex }) => {
+                const nearest = { pos: 0 };
+                for (const { line, from, to, rules } of ignores) {
+                    if (line > startLine + 1) {
+                        break;
+                    }
+                    else if (rules && !rules.has(rule)) {
+                        continue;
+                    }
+                    else if (line === startLine && from === undefined && to === undefined) {
+                        return false;
+                    }
+                    else if (from <= startIndex && from > nearest.pos) {
+                        nearest.pos = from;
+                        nearest.type = 'from';
+                    }
+                    else if (to <= startIndex && to > nearest.pos) {
+                        nearest.pos = to;
+                        nearest.type = 'to';
+                    }
+                }
+                return nearest.type !== 'from';
+            });
+        }
+        return errors;
+    }
 }
 exports.Token = Token;

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

@@ -10,6 +10,7 @@ import type { Title } from '../../lib/title';
 export declare abstract class LinkBaseToken extends Token {
     #private;
     type: 'link' | 'category' | 'file' | 'gallery-image' | 'imagemap-image';
+    readonly name: string;
     readonly childNodes: readonly [AtomToken, ...Token[]];
     abstract get firstChild(): AtomToken;
     abstract get lastChild(): Token;

package/dist/src/link/base.js

@@ -36,6 +36,7 @@ class LinkBaseToken extends index_2.Token {
         if (this.#delimiter.includes('\0')) {
             this.#delimiter = this.buildFromStr(this.#delimiter, constants_1.BuildMethod.String);
         }
+        this.setAttribute('name', this.#title.main);
     }
     /** @private */
     setAttribute(key, value) {

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

@@ -2,10 +2,9 @@ import Parser from '../../index';
 import { Token } from '../index';
 import { SyntaxToken } from '../syntax';
 import { AttributesToken } from '../attributes';
-/**
- * 表格行，含开头的换行，不含结尾的换行
- * @classdesc `{childNodes: [SyntaxToken, AttributesToken, ...Token]}`
- */
+import type { AttributesParentBase } from '../../mixin/attributesParent';
+export interface TableBaseToken extends AttributesParentBase {
+}
 export declare abstract class TableBaseToken extends Token {
     type: 'table' | 'tr' | 'td';
     readonly childNodes: readonly [SyntaxToken, AttributesToken, ...Token[]];
@@ -18,3 +17,4 @@ export declare abstract class TableBaseToken extends Token {
      */
     constructor(pattern: RegExp, syntax?: string, attr?: string, config?: Parser.Config, accum?: Token[], acceptable?: Acceptable);
 }
+export {};

package/dist/src/table/base.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TableBaseToken = void 0;
+const attributesParent_1 = require("../../mixin/attributesParent");
 const index_1 = require("../../index");
 const index_2 = require("../index");
 const syntax_1 = require("../syntax");
@@ -9,7 +10,7 @@ const attributes_1 = require("../attributes");
  * 表格行，含开头的换行，不含结尾的换行
  * @classdesc `{childNodes: [SyntaxToken, AttributesToken, ...Token]}`
  */
-class TableBaseToken extends index_2.Token {
+class TableBaseToken extends (0, attributesParent_1.attributesParent)(1)(index_2.Token) {
     /**
      * @param pattern 表格语法正则
      * @param syntax 表格语法

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

@@ -3,6 +3,15 @@ import { TrBaseToken } from './trBase';
 import { SyntaxToken } from '../syntax';
 import type { LintError } from '../../base';
 import type { AttributesToken, TdToken, TrToken, Token } from '../../internal';
+import type { TableCoords } from './trBase';
+/**
+ * 是否是行尾
+ * @param {Token} cell 表格单元格
+ */
+export declare const isRowEnd: ({ type }: Token) => boolean;
+/** @extends {Array<TableCoords[]>} */
+export declare class Layout extends Array<TableCoords[]> {
+}
 /**
  * 表格
  * @classdesc `{childNodes: [SyntaxToken, AttributesToken, ?Token, ...TdToken, ...TrToken, ?SyntaxToken]}`
@@ -20,4 +29,33 @@ export declare abstract class TableToken extends TrBaseToken {
     constructor(syntax: string, attr?: string, config?: Parser.Config, accum?: Token[]);
     /** @override */
     lint(start?: number, re?: RegExp): LintError[];
+    /**
+     * 获取表格布局
+     * @param stop 中止条件
+     * @param stop.row 中止行
+     * @param stop.column 中止列
+     * @param stop.x 中止行
+     * @param stop.y 中止列
+     */
+    getLayout(stop?: {
+        row?: number;
+        column?: number;
+        x?: number;
+        y?: number;
+    }): Layout;
+    /** 获取所有行 */
+    getAllRows(): (TrToken | this)[];
+    /**
+     * 获取指定坐标的单元格
+     * @param coords 表格坐标
+     */
+    getNthCell(coords: TableCoords): TdToken | undefined;
+    /**
+     * 获取第n行
+     * @param n 行号
+     * @param force 是否将表格自身视为第一行
+     * @param insert 是否用于判断插入新行的位置
+     * @throws `RangeError` 不存在该行
+     */
+    getNthRow(n: number, force?: boolean, insert?: false): TrToken | this | undefined;
 }

package/dist/src/table/index.js

@@ -1,12 +1,22 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TableToken = void 0;
+exports.TableToken = exports.Layout = exports.isRowEnd = void 0;
 const lint_1 = require("../../util/lint");
 const debug_1 = require("../../util/debug");
 const index_1 = require("../../index");
 const trBase_1 = require("./trBase");
 const syntax_1 = require("../syntax");
 const closingPattern = /^\n[^\S\n]*(?:\|\}|\{\{\s*!\s*\}\}\}|\{\{\s*!\)\s*\}\})$/u;
+/**
+ * 是否是行尾
+ * @param {Token} cell 表格单元格
+ */
+const isRowEnd = ({ type }) => type === 'tr' || type === 'table-syntax';
+exports.isRowEnd = isRowEnd;
+/** @extends {Array<TableCoords[]>} */
+class Layout extends Array {
+}
+exports.Layout = Layout;
 /**
  * 表格
  * @classdesc `{childNodes: [SyntaxToken, AttributesToken, ?Token, ...TdToken, ...TrToken, ?SyntaxToken]}`
@@ -30,6 +40,29 @@ class TableToken extends trBase_1.TrBaseToken {
         if (!this.closed) {
             errors.push((0, lint_1.generateForChild)(this.firstChild, { start }, 'unclosed-table', index_1.default.msg('unclosed $1', 'table')));
         }
+        const layout = this.getLayout(), { length } = layout;
+        if (length > 1) {
+            let low = 1, high = Infinity, j = 0;
+            for (; j < length; j++) {
+                const row = layout[j], max = row.length;
+                if (max < low) {
+                    break;
+                }
+                else if (max < high) {
+                    high = max;
+                }
+                const { colspan } = this.getNthCell(row[row.length - 1]), min = max - colspan + 1;
+                if (min > high) {
+                    break;
+                }
+                else if (min > low) {
+                    low = min;
+                }
+            }
+            if (j < length) {
+                errors.push((0, lint_1.generateForChild)(this.getNthRow(j), { start }, 'table-layout', 'inconsistent table layout', 'warning'));
+            }
+        }
         return errors;
     }
     /** @private */
@@ -41,5 +74,81 @@ class TableToken extends trBase_1.TrBaseToken {
         }
         this.lastChild.replaceChildren(...inner);
     }
+    /**
+     * 获取表格布局
+     * @param stop 中止条件
+     * @param stop.row 中止行
+     * @param stop.column 中止列
+     * @param stop.x 中止行
+     * @param stop.y 中止列
+     */
+    getLayout(stop) {
+        const rows = this.getAllRows(), { length } = rows, layout = new Layout(...(0, debug_1.emptyArray)(length, () => []));
+        for (let i = 0; i < length; i++) {
+            const rowLayout = layout[i];
+            let j = 0, k = 0, last;
+            for (const cell of rows[i].childNodes.slice(2)) {
+                if (cell.type === 'td') {
+                    if (cell.isIndependent()) {
+                        last = cell.subtype !== 'caption';
+                    }
+                    if (last) {
+                        const coords = { row: i, column: j }, { rowspan, colspan } = cell;
+                        j++;
+                        while (rowLayout[k]) {
+                            k++;
+                        }
+                        for (let y = i; y < Math.min(i + rowspan, length); y++) {
+                            for (let x = k; x < k + colspan; x++) {
+                                layout[y][x] = coords;
+                            }
+                        }
+                        k += colspan;
+                    }
+                }
+                else if ((0, exports.isRowEnd)(cell)) {
+                    break;
+                }
+            }
+        }
+        return layout;
+    }
+    /** 获取所有行 */
+    getAllRows() {
+        return [
+            ...super.getRowCount() ? [this] : [],
+            ...this.childNodes.slice(1)
+                .filter((child) => child.type === 'tr' && child.getRowCount() > 0),
+        ];
+    }
+    /**
+     * 获取指定坐标的单元格
+     * @param coords 表格坐标
+     */
+    getNthCell(coords) {
+        const rawCoords = coords;
+        // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+        return rawCoords && this.getNthRow(rawCoords.row, false, false)?.getNthCol(rawCoords.column);
+    }
+    getNthRow(n, force = false, insert = false) {
+        const isRow = super.getRowCount();
+        if (n === 0
+            // eslint-disable-next-line @stylistic/no-extra-parens
+            && (isRow)) {
+            return this;
+        }
+        else if (isRow) {
+            n--;
+        }
+        for (const child of this.childNodes.slice(2)) {
+            if (child.type === 'tr' && child.getRowCount()) {
+                n--;
+                if (n < 0) {
+                    return child;
+                }
+            }
+        }
+        return undefined;
+    }
 }
 exports.TableToken = TableToken;

package/dist/src/table/td.d.ts

@@ -8,7 +8,7 @@ export interface TdSpanAttrs {
     rowspan?: number;
     colspan?: number;
 }
-export type TdAttrs = Record<string, string | true> & TdSpanAttrs;
+declare type TdAttrGetter<T extends string> = T extends keyof TdSpanAttrs ? number : string | true | undefined;
 /**
  * `<td>`、`<th>`和`<caption>`
  * @classdesc `{childNodes: [SyntaxToken, AttributesToken, Token]}`
@@ -20,6 +20,10 @@ export declare abstract class TdToken extends TableBaseToken {
     abstract get parentNode(): TrToken | TableToken | undefined;
     abstract get nextSibling(): this | TrToken | SyntaxToken | undefined;
     abstract get previousSibling(): Token | undefined;
+    /** rowspan */
+    get rowspan(): number;
+    /** colspan */
+    get colspan(): number;
     /** 单元格类型 */
     get subtype(): TdSubtypes;
     /**
@@ -33,4 +37,10 @@ export declare abstract class TdToken extends TableBaseToken {
     lint(start?: number, re?: RegExp): LintError[];
     /** 是否位于行首 */
     isIndependent(): boolean;
+    /**
+     * @override
+     * @param key 属性键
+     */
+    getAttr<T extends string>(key: T): TdAttrGetter<T>;
 }
+export {};

package/dist/src/table/td.js

@@ -13,6 +13,14 @@ const base_1 = require("./base");
 class TdToken extends base_1.TableBaseToken {
     type = 'td';
     #innerSyntax = '';
+    /** rowspan */
+    get rowspan() {
+        return this.getAttr('rowspan');
+    }
+    /** colspan */
+    get colspan() {
+        return this.getAttr('colspan');
+    }
     /** 单元格类型 */
     get subtype() {
         return this.#getSyntax().subtype;
@@ -113,5 +121,13 @@ class TdToken extends base_1.TableBaseToken {
     isIndependent() {
         return this.firstChild.text().startsWith('\n');
     }
+    /**
+     * @override
+     * @param key 属性键
+     */
+    getAttr(key) {
+        const value = super.getAttr(key);
+        return (key === 'rowspan' || key === 'colspan' ? Number(value) || 1 : value);
+    }
 }
 exports.TdToken = TdToken;

package/dist/src/table/trBase.d.ts

@@ -1,4 +1,5 @@
 import { TableBaseToken } from './base';
+import { TdToken } from './td';
 import type { LintError } from '../../base';
 export interface TableCoords {
     readonly row: number;
@@ -12,4 +13,13 @@ export declare abstract class TrBaseToken extends TableBaseToken {
     type: 'table' | 'tr';
     /** @override */
     lint(start?: number, re?: RegExp): LintError[];
+    /** 获取行数 */
+    getRowCount(): number;
+    /**
+     * 获取第n列
+     * @param n 列号
+     * @param insert 是否用于判断插入新列的位置
+     * @throws `RangeError` 不存在对应单元格
+     */
+    getNthCol(n: number, insert?: false): TdToken | undefined;
 }

package/dist/src/table/trBase.js

@@ -4,6 +4,7 @@ exports.TrBaseToken = void 0;
 const lint_1 = require("../../util/lint");
 const debug_1 = require("../../util/debug");
 const base_1 = require("./base");
+const td_1 = require("./td");
 /** 表格行或表格 */
 class TrBaseToken extends base_1.TableBaseToken {
     /** @override */
@@ -34,5 +35,24 @@ class TrBaseToken extends base_1.TableBaseToken {
         errors.push(error);
         return errors;
     }
+    /** 获取行数 */
+    getRowCount() {
+        return Number(this.childNodes.some(child => child instanceof td_1.TdToken && child.isIndependent() && !child.firstChild.text().endsWith('+')));
+    }
+    getNthCol(n, insert = false) {
+        let last = 0;
+        for (const child of this.childNodes.slice(2)) {
+            if (child instanceof td_1.TdToken) {
+                if (child.isIndependent()) {
+                    last = Number(child.subtype !== 'caption');
+                }
+                n -= last;
+                if (n < 0) {
+                    return child;
+                }
+            }
+        }
+        return undefined;
+    }
 }
 exports.TrBaseToken = TrBaseToken;

package/dist/util/debug.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.setChildNodes = exports.isToken = exports.Shadow = void 0;
+exports.emptyArray = exports.setChildNodes = exports.isToken = exports.Shadow = void 0;
 exports.Shadow = {
     running: false,
     /** @private */
@@ -31,3 +31,10 @@ const setChildNodes = (parent, position, deleteCount, inserted = []) => {
     return removed;
 };
 exports.setChildNodes = setChildNodes;
+/**
+ * 生成一个指定长度的空数组
+ * @param n 数组长度
+ * @param callback 回调函数
+ */
+const emptyArray = (n, callback) => new Array(n).fill(undefined).map((_, i) => callback(i));
+exports.emptyArray = emptyArray;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "wikilint",
-	"version": "2.5.7",
+	"version": "2.6.0",
 	"description": "A Node.js linter for MediaWiki markup",
 	"keywords": [
 		"mediawiki",
@@ -33,7 +33,7 @@
 	},
 	"scripts": {
 		"declaration": "grep -rl --include='*.d.ts' '@private' dist/ | xargs bash sed.sh -i -E '/^\\s+\\/\\*\\* @private/,+1d'; node ./dist/bin/declaration.js",
-		"prepublishOnly": "npm run build && rm dist/internal.js dist/[bmpu]*/*.d.ts",
+		"prepublishOnly": "npm run build && rm dist/internal.js dist/[bpu]*/*.d.ts",
 		"build": "bash build.sh",
 		"diff": "bash diff.sh",
 		"diff:stat": "f() { git diff --stat --ignore-all-space --color=always $1 $2 -- . ':!extensions/' ':!bin/' | grep '\\.ts'; }; f",