wikilint 2.0.0-beta.1 → 2.0.0-beta.2

package/README.md

@@ -1,5 +1,6 @@
 [![npm version](https://badge.fury.io/js/wikilint.svg)](https://www.npmjs.com/package/wikilint)
-[![CodeQL](https://github.com/bhsd-harry/wikiparser-node/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/bhsd-harry/wikiparser-node/actions/workflows/github-code-scanning/codeql)
+[![CodeQL](https://github.com/bhsd-harry/wikiparser-node/actions/workflows/codeql.yml/badge.svg)](https://github.com/bhsd-harry/wikiparser-node/actions/workflows/codeql.yml)
+[![CI](https://github.com/bhsd-harry/wikiparser-node/actions/workflows/node.js.yml/badge.svg)](https://github.com/bhsd-harry/wikiparser-node/actions/workflows/node.js.yml)
 
 # wikilint
 This is a minimal version of [wikiparser-node](https://www.npmjs.com/package/wikiparser-node) customized for [eslint-plugin-wikitext](https://www.npmjs.com/package/eslint-plugin-wikitext).
@@ -7,7 +8,7 @@ This is a minimal version of [wikiparser-node](https://www.npmjs.com/package/wik
 You can also directly lint Wikitext articles in the command line using this package:
 
 ```sh
-npx wikilint --config zhwiki --include *.wiki
+npx wikilint --config zhwiki --include --lang zh-hans *.wiki
 ```
 
 ## CLI Options

package/bin/cli.js

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+'use strict';
+require('../dist/bin/cli.js');

package/dist/index.d.ts

@@ -23,13 +23,10 @@ export interface LintError {
     endCol: number;
 }
 declare interface Parser {
-    /** @browser */
     config: string | Config;
-    /** @browser */
     i18n?: string | Record<string, string>;
     /**
      * 规范化页面标题
-     * @browser
      * @param title 标题（含或不含命名空间前缀）
      * @param defaultNs 命名空间
      * @param include 是否嵌入
@@ -40,7 +37,6 @@ declare interface Parser {
     normalizeTitle(title: string, defaultNs?: number, include?: boolean, config?: Config, halfParsed?: boolean, decode?: boolean, selfLink?: boolean): Title;
     /**
      * 解析wikitext
-     * @browser
      * @param include 是否嵌入
      * @param maxStage 最大解析层级
      */

package/dist/index.js

@@ -34,13 +34,13 @@ const Parser = {
         if (halfParsed) {
             return new Title(title, defaultNs, config, decode, selfLink);
         }
-        const { Token } = require('./src');
+        const { Token } = require('./src/index');
         const token = this.run(() => new Token(title, config).parseOnce(0, include).parseOnce()), titleObj = new Title(String(token), defaultNs, config, decode, selfLink);
         return titleObj;
     },
     /** @implements */
     parse(wikitext, include, maxStage = Parser.MAX_STAGE, config = Parser.getConfig()) {
-        const { Token } = require('./src');
+        const { Token } = require('./src/index');
         let token;
         this.run(() => {
             token = new Token(wikitext.replace(/[\0\x7F]/gu, ''), config);

package/dist/internal.d.ts

@@ -1,6 +1,6 @@
 export type { AstNodes, } from './lib/node';
 export type * from './lib/text';
-export type * from './src';
+export type * from './src/index';
 export type * from './src/onlyinclude';
 export type * from './src/nowiki/noinclude';
 export type * from './src/tagPair/include';
@@ -18,10 +18,10 @@ export type * from './src/heading';
 export type * from './src/html';
 export type { TdToken } from './src/table/td';
 export type * from './src/table/tr';
-export type * from './src/table';
+export type * from './src/table/index';
 export type * from './src/nowiki/hr';
 export type * from './src/nowiki/doubleUnderscore';
-export type * from './src/link';
+export type * from './src/link/index';
 export type * from './src/link/category';
 export type * from './src/imageParameter';
 export type * from './src/link/file';
@@ -34,9 +34,9 @@ export type * from './src/nowiki/list';
 export type * from './src/converterFlags';
 export type * from './src/converterRule';
 export type * from './src/converter';
-export type * from './src/nowiki';
+export type * from './src/nowiki/index';
 export type * from './src/pre';
-export type * from './src/paramTag';
+export type * from './src/paramTag/index';
 export type * from './src/paramTag/inputbox';
 export type * from './src/nested';
 export type * from './src/gallery';

package/dist/lib/element.d.ts

@@ -3,33 +3,23 @@ import type { LintError } from '../index';
 import type { AstNodes, Token } from '../internal';
 /** 类似HTMLElement */
 export declare abstract class AstElement extends AstNode {
-    /** @browser */
     name?: string;
-    /**
-     * 子节点总数
-     * @browser
-     */
+    /** 子节点总数 */
     get length(): number;
     /**
      * 可见部分
-     * @browser
      * @param separator 子节点间的连接符
      */
     text(separator?: string): string;
-    /**
-     * 合并相邻的文本子节点
-     * @browser
-     */
+    /** 合并相邻的文本子节点 */
     normalize(): void;
     /**
      * 移除子节点
-     * @browser
      * @param i 移除位置
      */
     removeAt(i: number): AstNodes;
     /**
      * 插入子节点
-     * @browser
      * @param node 待插入的子节点
      * @param i 插入位置
      * @throws `RangeError` 不能插入祖先节点
@@ -37,40 +27,28 @@ export declare abstract class AstElement extends AstNode {
     insertAt<T extends AstNodes>(node: T, i?: number): T;
     /**
      * 最近的祖先节点
-     * @browser
      * @param selector 选择器
      */
     closest(selector: string): Token | undefined;
     /**
      * 在末尾批量插入子节点
-     * @browser
      * @param elements 插入节点
      */
     append(...elements: (AstNodes | string)[]): void;
     /**
      * 批量替换子节点
-     * @browser
      * @param elements 新的子节点
      */
     replaceChildren(...elements: (AstNodes | string)[]): void;
     /**
      * 修改文本子节点
-     * @browser
      * @param str 新文本
      * @param i 子节点位置
      * @throws `RangeError` 对应位置的子节点不是文本节点
      */
     setText(str: string, i?: number): string;
-    /**
-     * 还原为wikitext
-     * @browser
-     * @param omit 忽略的节点类型
-     * @param separator 子节点间的连接符
-     */
-    toString(omit?: Set<string>, separator?: string): string;
     /**
      * Linter
-     * @browser
      * @param start
      */
     lint(start?: number): LintError[];

package/dist/lib/element.js

@@ -22,27 +22,19 @@ const lintIgnoredExt = new Set([
 ]);
 /** 类似HTMLElement */
 class AstElement extends node_1.AstNode {
-    /** @browser */
     name;
-    /**
-     * 子节点总数
-     * @browser
-     */
+    /** 子节点总数 */
     get length() {
         return this.childNodes.length;
     }
     /**
      * 可见部分
-     * @browser
      * @param separator 子节点间的连接符
      */
     text(separator) {
         return (0, string_1.text)(this.childNodes, separator);
     }
-    /**
-     * 合并相邻的文本子节点
-     * @browser
-     */
+    /** 合并相邻的文本子节点 */
     normalize() {
         const { childNodes } = this;
         for (let i = childNodes.length - 1; i >= 0; i--) {
@@ -61,7 +53,6 @@ class AstElement extends node_1.AstNode {
     }
     /**
      * 移除子节点
-     * @browser
      * @param i 移除位置
      */
     removeAt(i) {
@@ -70,7 +61,6 @@ class AstElement extends node_1.AstNode {
     }
     /**
      * 插入子节点
-     * @browser
      * @param node 待插入的子节点
      * @param i 插入位置
      * @throws `RangeError` 不能插入祖先节点
@@ -83,7 +73,6 @@ class AstElement extends node_1.AstNode {
     }
     /**
      * 最近的祖先节点
-     * @browser
      * @param selector 选择器
      */
     closest(selector) {
@@ -101,7 +90,6 @@ class AstElement extends node_1.AstNode {
     }
     /**
      * 在末尾批量插入子节点
-     * @browser
      * @param elements 插入节点
      */
     append(...elements) {
@@ -111,7 +99,6 @@ class AstElement extends node_1.AstNode {
     }
     /**
      * 批量替换子节点
-     * @browser
      * @param elements 新的子节点
      */
     replaceChildren(...elements) {
@@ -120,28 +107,21 @@ class AstElement extends node_1.AstNode {
     }
     /**
      * 修改文本子节点
-     * @browser
      * @param str 新文本
      * @param i 子节点位置
      * @throws `RangeError` 对应位置的子节点不是文本节点
      */
     setText(str, i = 0) {
-        const oldText = this.childNodes[i], { data } = oldText;
+        const oldText = this.childNodes.at(i), { data } = oldText;
         oldText.replaceData(str);
         return data;
     }
-    /**
-     * 还原为wikitext
-     * @browser
-     * @param omit 忽略的节点类型
-     * @param separator 子节点间的连接符
-     */
+    /** @private */
     toString(omit, separator = '') {
         return this.childNodes.map(child => child.toString()).join(separator);
     }
     /**
      * Linter
-     * @browser
      * @param start
      */
     lint(start = this.getAbsoluteIndex()) {

package/dist/lib/node.d.ts

@@ -16,65 +16,34 @@ export interface CaretPosition {
 /** 类似Node */
 export declare abstract class AstNode {
     #private;
-    /** @browser */
     type: TokenTypes | 'text';
-    /** @browser */
     readonly childNodes: AstNodes[];
-    /**
-     * 首位子节点
-     * @browser
-     */
+    /** 首位子节点 */
     get firstChild(): AstNodes | undefined;
-    /**
-     * 末位子节点
-     * @browser
-     */
+    /** 末位子节点 */
     get lastChild(): AstNodes | undefined;
-    /**
-     * 父节点
-     * @browser
-     */
+    /** 父节点 */
     get parentNode(): Token | undefined;
-    /**
-     * 后一个兄弟节点
-     * @browser
-     */
+    /** 后一个兄弟节点 */
     get nextSibling(): AstNodes | undefined;
-    /**
-     * 前一个兄弟节点
-     * @browser
-     */
+    /** 前一个兄弟节点 */
     get previousSibling(): AstNodes | undefined;
-    /**
-     * 行数
-     * @browser
-     */
+    /** 行数 */
     get offsetHeight(): number;
-    /**
-     * 最后一行的列数
-     * @browser
-     */
+    /** 最后一行的列数 */
     get offsetWidth(): number;
-    /**
-     * 获取根节点
-     * @browser
-     */
+    /** 获取根节点 */
     getRootNode(): Token | this;
     /**
      * 将字符位置转换为行列号
-     * @browser
      * @param index 字符位置
      */
     posFromIndex(index: number): Position | undefined;
     /**
      * 获取当前节点的相对字符位置，或其第`j`个子节点的相对字符位置
-     * @browser
      * @param j 子节点序号
      */
     getRelativeIndex(j?: number): number;
-    /**
-     * 获取当前节点的绝对位置
-     * @browser
-     */
+    /** 获取当前节点的绝对位置 */
     getAbsoluteIndex(): number;
 }

package/dist/lib/node.js

@@ -3,60 +3,36 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.AstNode = void 0;
 /** 类似Node */
 class AstNode {
-    /** @browser */
     type;
-    /** @browser */
     childNodes = [];
-    /** @browser */
     #parentNode;
-    /**
-     * 首位子节点
-     * @browser
-     */
+    /** 首位子节点 */
     get firstChild() {
         return this.childNodes[0];
     }
-    /**
-     * 末位子节点
-     * @browser
-     */
+    /** 末位子节点 */
     get lastChild() {
         return this.childNodes.at(-1);
     }
-    /**
-     * 父节点
-     * @browser
-     */
+    /** 父节点 */
     get parentNode() {
         return this.#parentNode;
     }
-    /**
-     * 后一个兄弟节点
-     * @browser
-     */
+    /** 后一个兄弟节点 */
     get nextSibling() {
         const childNodes = this.#parentNode?.childNodes;
         return childNodes && childNodes[childNodes.indexOf(this) + 1];
     }
-    /**
-     * 前一个兄弟节点
-     * @browser
-     */
+    /** 前一个兄弟节点 */
     get previousSibling() {
         const childNodes = this.#parentNode?.childNodes;
         return childNodes && childNodes[childNodes.indexOf(this) - 1];
     }
-    /**
-     * 行数
-     * @browser
-     */
+    /** 行数 */
     get offsetHeight() {
         return this.#getDimension().height;
     }
-    /**
-     * 最后一行的列数
-     * @browser
-     */
+    /** 最后一行的列数 */
     get offsetWidth() {
         return this.#getDimension().width;
     }
@@ -80,12 +56,8 @@ class AstNode {
             // @ts-expect-error noImplicitAny
             this[key] = value;
         }
-        return this;
     }
-    /**
-     * 获取根节点
-     * @browser
-     */
+    /** 获取根节点 */
     getRootNode() {
         let { parentNode } = this;
         while (parentNode?.parentNode) {
@@ -95,7 +67,6 @@ class AstNode {
     }
     /**
      * 将字符位置转换为行列号
-     * @browser
      * @param index 字符位置
      */
     posFromIndex(index) {
@@ -106,10 +77,7 @@ class AstNode {
         }
         return undefined;
     }
-    /**
-     * 获取行数和最后一行的列数
-     * @browser
-     */
+    /** 获取行数和最后一行的列数 */
     #getDimension() {
         const lines = String(this).split('\n');
         return { height: lines.length, width: lines.at(-1).length };
@@ -119,13 +87,11 @@ class AstNode {
         return 0;
     }
     /** @private */
-    // eslint-disable-next-line no-unused-vars, @typescript-eslint/no-unused-vars
     getGaps(i) {
         return 0;
     }
     /**
      * 获取当前节点的相对字符位置，或其第`j`个子节点的相对字符位置
-     * @browser
      * @param j 子节点序号
      */
     getRelativeIndex(j) {
@@ -148,10 +114,7 @@ class AstNode {
         ({ childNodes } = this);
         return getIndex(j, this);
     }
-    /**
-     * 获取当前节点的绝对位置
-     * @browser
-     */
+    /** 获取当前节点的绝对位置 */
     getAbsoluteIndex() {
         const { parentNode } = this;
         return parentNode ? parentNode.getAbsoluteIndex() + this.getRelativeIndex() : 0;

package/dist/lib/text.d.ts

@@ -3,35 +3,20 @@ import type { LintError } from '../index';
 /** 文本节点 */
 export declare class AstText extends AstNode {
     #private;
-    /** @browser */
     readonly type = "text";
     name: undefined;
-    /** @browser */
     data: string;
-    /**
-     * @browser
-     * @param text 包含文本
-     */
+    /** @param text 包含文本 */
     constructor(text: string);
-    /**
-     * 输出字符串
-     * @browser
-     */
-    toString(): string;
-    /**
-     * 可见部分
-     * @browser
-     */
+    /** 可见部分 */
     text(): string;
     /**
      * Linter
-     * @browser
      * @param start
      */
     lint(start?: number): LintError[];
     /**
      * 替换字符串
-     * @browser
      * @param text 替换的字符串
      */
     replaceData(text: string): void;

package/dist/lib/text.js

@@ -32,35 +32,23 @@ const errorSyntax = /https?:\/\/|\{+|\}+|\[{2,}|\[(?![^[]*\])|(?<=^|\])([^[]*?)\
 ];
 /** 文本节点 */
 class AstText extends node_1.AstNode {
-    /** @browser */
     type = 'text';
-    /** @browser */
     data;
-    /**
-     * @browser
-     * @param text 包含文本
-     */
+    /** @param text 包含文本 */
     constructor(text) {
         super();
         this.data = text;
     }
-    /**
-     * 输出字符串
-     * @browser
-     */
+    /** @private */
     toString() {
         return this.data;
     }
-    /**
-     * 可见部分
-     * @browser
-     */
+    /** 可见部分 */
     text() {
         return this.data;
     }
     /**
      * Linter
-     * @browser
      * @param start
      */
     lint(start = this.getAbsoluteIndex()) {
@@ -100,7 +88,6 @@ class AstText extends node_1.AstNode {
     }
     /**
      * 修改内容
-     * @browser
      * @param text 新内容
      */
     #setData(text) {
@@ -108,7 +95,6 @@ class AstText extends node_1.AstNode {
     }
     /**
      * 替换字符串
-     * @browser
      * @param text 替换的字符串
      */
     replaceData(text) {

package/dist/lib/title.d.ts

@@ -1,16 +1,11 @@
 import * as Parser from '../index';
 /** MediaWiki页面标题对象 */
 export declare class Title {
-    /** @browser */
     valid: boolean;
-    /** @browser */
     ns: number;
-    /** @browser */
     fragment: string | undefined;
-    /** @browser */
     encoded: boolean;
     /**
-     * @browser
      * @param title 标题（含或不含命名空间前缀）
      * @param defaultNs 命名空间
      * @param decode 是否需要解码

package/dist/lib/title.js

@@ -5,16 +5,11 @@ const string_1 = require("../util/string");
 const Parser = require("../index");
 /** MediaWiki页面标题对象 */
 class Title {
-    /** @browser */
     valid;
-    /** @browser */
     ns;
-    /** @browser */
     fragment;
-    /** @browser */
     encoded = false;
     /**
-     * @browser
      * @param title 标题（含或不含命名空间前缀）
      * @param defaultNs 命名空间
      * @param decode 是否需要解码
@@ -22,7 +17,7 @@ class Title {
      */
     constructor(title, defaultNs = 0, config = Parser.getConfig(), decode = false, selfLink = false) {
         const { namespaces, nsid } = config;
-        let namespace = namespaces[defaultNs];
+        let namespace = namespaces[defaultNs] ?? '';
         title = (0, string_1.decodeHtml)(title);
         if (decode && title.includes('%')) {
             try {

package/dist/mixin/hidden.js

@@ -5,7 +5,6 @@ exports.hidden = void 0;
  * 解析后不可见的类
  * @param constructor 基类
  */
-// eslint-disable-next-line @typescript-eslint/explicit-function-return-type
 const hidden = (constructor) => {
     /** 解析后不可见的类 */
     class AnyHiddenToken extends constructor {

package/dist/parser/hrAndDoubleUnderscore.js

@@ -11,9 +11,8 @@ const heading_1 = require("../src/heading");
  * @param config
  * @param accum
  */
-const parseHrAndDoubleUnderscore = ({ firstChild, type, name }, config = Parser.getConfig(), accum = []) => {
+const parseHrAndDoubleUnderscore = ({ firstChild: { data }, type, name }, config = Parser.getConfig(), accum = []) => {
     const { doubleUnderscore } = config, insensitive = new Set(doubleUnderscore[0]), sensitive = new Set(doubleUnderscore[1]);
-    let { data } = firstChild;
     if (type !== 'root' && (type !== 'ext-inner' || name !== 'poem')) {
         data = `\0${data}`;
     }
@@ -21,8 +20,9 @@ const parseHrAndDoubleUnderscore = ({ firstChild, type, name }, config = Parser.
         new hr_1.HrToken(m, config, accum);
         return `${lead}\0${accum.length - 1}r\x7F`;
     }).replace(new RegExp(`__(${doubleUnderscore.flat().join('|')})__`, 'giu'), (m, p1) => {
-        if (insensitive.has(p1.toLowerCase()) || sensitive.has(p1)) {
-            new doubleUnderscore_1.DoubleUnderscoreToken(p1, config, accum);
+        const fixed = sensitive.has(p1);
+        if (fixed || insensitive.has(p1.toLowerCase())) {
+            new doubleUnderscore_1.DoubleUnderscoreToken(p1, fixed, config, accum);
             return `\0${accum.length - 1}u\x7F`;
         }
         return m;

package/dist/parser/links.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.parseLinks = void 0;
 const Parser = require("../index");
-const link_1 = require("../src/link");
+const index_1 = require("../src/link/index");
 const file_1 = require("../src/link/file");
 const category_1 = require("../src/link/category");
 /**
@@ -12,7 +12,7 @@ const category_1 = require("../src/link/category");
  * @param accum
  */
 const parseLinks = (wikitext, config = Parser.getConfig(), accum = []) => {
-    const { parseQuotes } = require('./quotes.js');
+    const { parseQuotes } = require('./quotes');
     const regex = /^((?:(?!\0\d+!\x7F)[^\n<>[\]{}|])+)(?:(\||\0\d+!\x7F)(.*?[^\]]))?\]\](.*)$/su, regexImg = /^((?:(?!\0\d+!\x7F)[^\n<>[\]{}|])+)(\||\0\d+!\x7F)(.*)$/su, regexExt = new RegExp(`^\\s*(?:${config.protocol})`, 'iu'), bits = wikitext.split('[[');
     let s = bits.shift();
     for (let i = 0; i < bits.length; i++) {
@@ -76,7 +76,7 @@ const parseLinks = (wikitext, config = Parser.getConfig(), accum = []) => {
         }
         text &&= parseQuotes(text, config, accum);
         s += `\0${accum.length}l\x7F${after}`;
-        let SomeLinkToken = link_1.LinkToken;
+        let SomeLinkToken = index_1.LinkToken;
         if (!force) {
             if (ns === 6) {
                 SomeLinkToken = file_1.FileToken;