wikilint 1.0.1 → 1.1.0

package/README.md

@@ -7,7 +7,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
-wikilint --config zhwiki --include *.wiki
+npx wikilint --config zhwiki --include *.wiki
 ```
 
 ## CLI Options

package/dist/index.d.ts

@@ -0,0 +1,110 @@
+import AstElement = require("./lib/element.js")
+import AstNode = require("./lib/node.js")
+import AstText = require("./lib/text.js")
+import Title = require("./lib/title.js")
+import ArgToken = require("./src/arg.js")
+import HiddenToken = require("./src/atom/hidden.js")
+import AtomToken = require("./src/atom/index.js")
+import AttributeToken = require("./src/attribute.js")
+import AttributesToken = require("./src/attributes.js")
+import ConverterToken = require("./src/converter.js")
+import ConverterFlagsToken = require("./src/converterFlags.js")
+import ConverterRuleToken = require("./src/converterRule.js")
+import ExtLinkToken = require("./src/extLink.js")
+import GalleryToken = require("./src/gallery.js")
+import HasNowikiToken = require("./src/hasNowiki/index.js")
+import PreToken = require("./src/hasNowiki/pre.js")
+import HeadingToken = require("./src/heading.js")
+import HtmlToken = require("./src/html.js")
+import ImageParameterToken = require("./src/imageParameter.js")
+import ImagemapToken = require("./src/imagemap.js")
+import ImagemapLinkToken = require("./src/imagemapLink.js")
+import Token = require("./src/index.js")
+import CategoryToken = require("./src/link/category.js")
+import FileToken = require("./src/link/file.js")
+import GalleryImageToken = require("./src/link/galleryImage.js")
+import LinkToken = require("./src/link/index.js")
+import MagicLinkToken = require("./src/magicLink.js")
+import ChooseToken = require("./src/nested/choose.js")
+import ComboboxToken = require("./src/nested/combobox.js")
+import NestedToken = require("./src/nested/index.js")
+import ReferencesToken = require("./src/nested/references.js")
+import CommentToken = require("./src/nowiki/comment.js")
+import DdToken = require("./src/nowiki/dd.js")
+import DoubleUnderscoreToken = require("./src/nowiki/doubleUnderscore.js")
+import HrToken = require("./src/nowiki/hr.js")
+import NowikiToken = require("./src/nowiki/index.js")
+import ListToken = require("./src/nowiki/list.js")
+import NoincludeToken = require("./src/nowiki/noinclude.js")
+import QuoteToken = require("./src/nowiki/quote.js")
+import OnlyincludeToken = require("./src/onlyinclude.js")
+import ParamTagToken = require("./src/paramTag/index.js")
+import InputboxToken = require("./src/paramTag/inputbox.js")
+import ParameterToken = require("./src/parameter.js")
+import SyntaxToken = require("./src/syntax.js")
+import TableToken = require("./src/table/index.js")
+import TdToken = require("./src/table/td.js")
+import TrToken = require("./src/table/tr.js")
+import ExtToken = require("./src/tagPair/ext.js")
+import IncludeToken = require("./src/tagPair/include.js")
+import TagPairToken = require("./src/tagPair/index.js")
+import TranscludeToken = require("./src/transclude.js")
+
+export = Parser;
+declare const Parser: import('./../typings');
+
+declare namespace Parser {
+	export {
+		AstElement,
+		AstNode,
+		AstText,
+		Title,
+		ArgToken,
+		HiddenToken,
+		AtomToken,
+		AttributeToken,
+		AttributesToken,
+		ConverterToken,
+		ConverterFlagsToken,
+		ConverterRuleToken,
+		ExtLinkToken,
+		GalleryToken,
+		HasNowikiToken,
+		PreToken,
+		HeadingToken,
+		HtmlToken,
+		ImageParameterToken,
+		ImagemapToken,
+		ImagemapLinkToken,
+		Token,
+		CategoryToken,
+		FileToken,
+		GalleryImageToken,
+		LinkToken,
+		MagicLinkToken,
+		ChooseToken,
+		ComboboxToken,
+		NestedToken,
+		ReferencesToken,
+		CommentToken,
+		DdToken,
+		DoubleUnderscoreToken,
+		HrToken,
+		NowikiToken,
+		ListToken,
+		NoincludeToken,
+		QuoteToken,
+		OnlyincludeToken,
+		ParamTagToken,
+		InputboxToken,
+		ParameterToken,
+		SyntaxToken,
+		TableToken,
+		TdToken,
+		TrToken,
+		ExtToken,
+		IncludeToken,
+		TagPairToken,
+		TranscludeToken,
+	}
+}

package/dist/lib/element.d.ts

@@ -0,0 +1,42 @@
+export = AstElement;
+/** 类似HTMLElement */
+declare class AstElement extends AstNode {
+    /** @type {string} */ name: string;
+    /** 子节点总数 */
+    get length(): number;
+    /**
+     * 最近的祖先节点
+     * @param {string} selector
+     */
+    closest(selector: string): AstElement;
+    /**
+     * 在末尾批量插入子节点
+     * @param {...this} elements 插入节点
+     * @complexity `n`
+     */
+    append(...elements: AstElement[]): void;
+    /**
+     * 批量替换子节点
+     * @param {...this} elements 新的子节点
+     * @complexity `n`
+     */
+    replaceChildren(...elements: AstElement[]): void;
+    /**
+     * 修改文本子节点
+     * @param {string} str 新文本
+     * @param {number} i 子节点位置
+     */
+    setText(str: string, i?: number): string;
+    /**
+     * 还原为wikitext
+     * @param {string} separator 子节点间的连接符
+     * @returns {string}
+     */
+    toString(selector: any, separator?: string): string;
+    /**
+     * Linter
+     * @param {number} start 起始位置
+     */
+    lint(start?: number): import("../../typings/token").LintError[];
+}
+import AstNode = require("./node");

package/dist/lib/node.d.ts

@@ -0,0 +1,102 @@
+export = AstNode;
+/** 类似Node */
+declare class AstNode {
+    /** @type {string} */ type: string;
+    /** @type {this[]} */ childNodes: AstNode[];
+    /** 首位子节点 */
+    get firstChild(): AstNode;
+    /** 末位子节点 */
+    get lastChild(): AstNode;
+    /** 父节点 */
+    get parentNode(): AstNode;
+    /**
+     * 后一个兄弟节点
+     * @complexity `n`
+     */
+    get nextSibling(): AstNode;
+    /**
+     * 前一个兄弟节点
+     * @complexity `n`
+     */
+    get previousSibling(): AstNode;
+    /**
+     * 是否具有某属性
+     * @param {PropertyKey} key 属性键
+     */
+    hasAttribute(key: PropertyKey): boolean;
+    /**
+     * 获取属性值。除非用于私有属性，否则总是返回字符串。
+     * @template {string} T
+     * @param {T} key 属性键
+     * @returns {TokenAttribute<T>}
+     */
+    getAttribute<T extends string>(key: T): import("../../typings/node").TokenAttribute<T>;
+    /**
+     * 设置属性
+     * @template {string} T
+     * @param {T} key 属性键
+     * @param {TokenAttribute<T>} value 属性值
+     */
+    setAttribute<T_1 extends string>(key: T_1, value: import("../../typings/node").TokenAttribute<T_1>): AstNode;
+    /**
+     * 可见部分
+     * @param {string} separator 子节点间的连接符
+     * @returns {string}
+     * @complexity `n`
+     */
+    text(separator?: string): string;
+    /**
+     * 移除子节点
+     * @param {number} i 移除位置
+     */
+    removeAt(i: number): AstNode;
+    /**
+     * 插入子节点
+     * @template {this} T
+     * @param {T} node 待插入的子节点
+     * @param {number} i 插入位置
+     * @complexity `n`
+     */
+    insertAt<T_2 extends AstNode>(node: T_2, i?: number): T_2;
+    /**
+     * 合并相邻的文本子节点
+     * @complexity `n`
+     */
+    normalize(): void;
+    /** 获取根节点 */
+    getRootNode(): AstNode;
+    /**
+     * 将字符位置转换为行列号
+     * @param {number} index 字符位置
+     * @complexity `n`
+     */
+    posFromIndex(index: number): {
+        top: number;
+        left: number;
+    };
+    /** 第一个子节点前的间距 */
+    getPadding(): number;
+    /** 子节点间距 */
+    getGaps(): number;
+    /**
+     * 获取当前节点的相对字符位置，或其第`j`个子节点的相对字符位置
+     * @param {number|undefined} j 子节点序号
+     * @complexity `n`
+     */
+    getRelativeIndex(j: number | undefined): number;
+    /**
+     * 行数
+     * @complexity `n`
+     */
+    get offsetHeight(): number;
+    /**
+     * 最后一行的列数
+     * @complexity `n`
+     */
+    get offsetWidth(): number;
+    #private;
+}
+declare namespace AstNode {
+    export { TokenAttribute };
+}
+type TokenAttribute<T> = import('../../typings/node').TokenAttribute<T>;

package/dist/lib/text.d.ts

@@ -0,0 +1,30 @@
+export = AstText;
+/** 文本节点 */
+declare class AstText extends AstNode {
+    /** @param {string} text 包含文本 */
+    constructor(text?: string);
+    /** @type {string} */ data: string;
+    /** @override */
+    override text(): string;
+    /**
+     * Linter
+     * @this {AstText & {parentNode: AstElement}}
+     * @param {number} start 起始位置
+     * @returns {LintError[]}
+     */
+    lint(this: import("./text") & {
+        parentNode: AstElement;
+    }, start: number): LintError[];
+    /**
+     * 替换字符串
+     * @param {string} text 替换的字符串
+     */
+    replaceData(text?: string): void;
+    #private;
+}
+declare namespace AstText {
+    export { LintError };
+}
+import AstNode = require("./node");
+import AstElement = require("./element");
+type LintError = import('../../typings/token').LintError;

package/dist/lib/title.d.ts

@@ -0,0 +1,15 @@
+export = Title;
+/** MediaWiki页面标题对象 */
+declare class Title {
+    /**
+     * @param {string} title 标题（含或不含命名空间前缀）
+     * @param {number} defaultNs 命名空间
+     * @param {boolean} decode 是否需要解码
+     * @param {boolean} selfLink 是否允许selfLink
+     */
+    constructor(title: string, defaultNs?: number, config?: import("../../typings/token").ParserConfig, decode?: boolean, selfLink?: boolean);
+    valid: boolean;
+    ns: number;
+    fragment: string;
+    encoded: boolean;
+}

package/dist/mixin/hidden.d.ts

@@ -0,0 +1,8 @@
+export = hidden;
+/**
+ * 解析后不可见的类
+ * @template T
+ * @param {T} Constructor 基类
+ * @returns {T}
+ */
+declare function hidden<T>(Constructor: T): T;

package/dist/parser/brackets.d.ts

@@ -0,0 +1,12 @@
+export = parseBrackets;
+/**
+ * 解析花括号
+ * @param {string} text wikitext
+ * @param {import('../../typings/token').accum} accum
+ * @throws TranscludeToken.constructor()
+ */
+declare function parseBrackets(text: string, config?: import("../../typings/token").ParserConfig, accum?: import('../../typings/token').accum): string;
+declare namespace parseBrackets {
+    export { BracketExecArray };
+}
+type BracketExecArray = import('../../typings/parser').BracketExecArray;

package/dist/parser/commentAndExt.d.ts

@@ -0,0 +1,8 @@
+export = parseCommentAndExt;
+/**
+ * 解析HTML注释和扩展标签
+ * @param {string} text wikitext
+ * @param {import('../../typings/token').accum} accum
+ * @param {boolean} includeOnly 是否嵌入
+ */
+declare function parseCommentAndExt(text: string, config?: import("../../typings/token").ParserConfig, accum?: import('../../typings/token').accum, includeOnly?: boolean): string;

package/dist/parser/converter.d.ts

@@ -0,0 +1,7 @@
+export = parseConverter;
+/**
+ * 解析语言变体转换
+ * @param {string} wikitext wikitext
+ * @param {import('../../typings/token').accum} accum
+ */
+declare function parseConverter(wikitext: string, config?: import("../../typings/token").ParserConfig, accum?: import('../../typings/token').accum): string;

package/dist/parser/externalLinks.d.ts

@@ -0,0 +1,7 @@
+export = parseExternalLinks;
+/**
+ * 解析外部链接
+ * @param {string} wikitext wikitext
+ * @param {import('../../typings/token').accum} accum
+ */
+declare function parseExternalLinks(wikitext: string, config?: import("../../typings/token").ParserConfig, accum?: import('../../typings/token').accum): string;

package/dist/parser/hrAndDoubleUnderscore.d.ts

@@ -0,0 +1,11 @@
+export = parseHrAndDoubleUnderscore;
+/**
+ * 解析\<hr\>和状态开关
+ * @param {Token & {firstChild: AstText}} root 根节点
+ * @param {import('../../typings/token').accum} accum
+ */
+declare function parseHrAndDoubleUnderscore({ firstChild: { data }, type, name }: Token & {
+    firstChild: AstText;
+}, config?: import("../../typings/token").ParserConfig, accum?: import('../../typings/token').accum): string;
+import Token = require("../src");
+import AstText = require("../lib/text");

package/dist/parser/html.d.ts

@@ -0,0 +1,7 @@
+export = parseHtml;
+/**
+ * 解析HTML标签
+ * @param {string} wikitext wikitext
+ * @param {import('../../typings/token').accum} accum
+ */
+declare function parseHtml(wikitext: string, config?: import("../../typings/token").ParserConfig, accum?: import('../../typings/token').accum): string;

package/dist/parser/links.d.ts

@@ -0,0 +1,7 @@
+export = parseLinks;
+/**
+ * 解析内部链接
+ * @param {string} wikitext wikitext
+ * @param {import('../../typings/token').accum} accum
+ */
+declare function parseLinks(wikitext: string, config?: import("../../typings/token").ParserConfig, accum?: import('../../typings/token').accum): string;

package/dist/parser/list.d.ts

@@ -0,0 +1,7 @@
+export = parseList;
+/**
+ * 解析列表
+ * @param {string} text wikitext
+ * @param {import('../../typings/token').accum} accum
+ */
+declare function parseList(text: string, config?: import("../../typings/token").ParserConfig, accum?: import('../../typings/token').accum): string;

package/dist/parser/magicLinks.d.ts

@@ -0,0 +1,7 @@
+export = parseMagicLinks;
+/**
+ * 解析自由外链
+ * @param {string} wikitext wikitext
+ * @param {import('../../typings/token').accum} accum
+ */
+declare function parseMagicLinks(wikitext: string, config?: import("../../typings/token").ParserConfig, accum?: import('../../typings/token').accum): string;

package/dist/parser/quotes.d.ts

@@ -0,0 +1,7 @@
+export = parseQuotes;
+/**
+ * 解析单引号
+ * @param {string} text wikitext
+ * @param {import('../../typings/token').accum} accum
+ */
+declare function parseQuotes(text: string, config?: import("../../typings/token").ParserConfig, accum?: import('../../typings/token').accum): string;

package/dist/parser/table.d.ts

@@ -0,0 +1,11 @@
+export = parseTable;
+/**
+ * 解析表格，注意`tr`和`td`包含开头的换行
+ * @param {Token & {firstChild: AstText}} root 根节点
+ * @param {import('../../typings/token').accum} accum
+ */
+declare function parseTable({ firstChild: { data }, type, name }: Token & {
+    firstChild: AstText;
+}, config?: import("../../typings/token").ParserConfig, accum?: import('../../typings/token').accum): string;
+import Token = require("../src");
+import AstText = require("../lib/text");

package/dist/src/arg.d.ts

@@ -0,0 +1,31 @@
+export = ArgToken;
+/**
+ * `{{{}}}`包裹的参数
+ * @classdesc `{childNodes: [AtomToken, ?Token, ...HiddenToken]}`
+ */
+declare class ArgToken extends Token {
+    /**
+     * @param {string[]} parts 以'|'分隔的各部分
+     * @param {import('../../typings/token').accum} accum
+     * @complexity `n`
+     */
+    constructor(parts: string[], config?: import("../../typings/token").ParserConfig, accum?: import('../../typings/token').accum);
+    /** default */
+    get default(): string | false;
+    /**
+     * @override
+     */
+    override toString(selector: any): string;
+    /**
+     * @override
+     * @returns {string}
+     */
+    override text(): string;
+    /**
+     * @override
+     * @param {number} start 起始位置
+     * @returns {import('../../typings/token').LintError[]}
+     */
+    override lint(start: number): import('../../typings/token').LintError[];
+}
+import Token = require(".");

package/dist/src/atom/hidden.d.ts

@@ -0,0 +1,5 @@
+export = HiddenToken;
+/** 不可见的节点 */
+declare class HiddenToken extends AtomToken {
+}
+import AtomToken = require(".");

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

@@ -0,0 +1,14 @@
+export = AtomToken;
+/**
+ * 不会被继续解析的plain Token
+ * @classdesc `{childNodes: ...AstText|Token}`
+ */
+declare class AtomToken extends Token {
+    /**
+     * @param {string} wikitext wikitext
+     * @param {string|undefined} type Token.type
+     * @param {import('../../../typings/token').accum} accum
+     */
+    constructor(wikitext: string, type: string | undefined, config?: import("../../../typings/token").ParserConfig, accum?: import('../../../typings/token').accum, acceptable?: any);
+}
+import Token = require("..");

package/dist/src/attribute.d.ts

@@ -0,0 +1,47 @@
+export = AttributeToken;
+/**
+ * 扩展和HTML标签属性
+ * @classdesc `{childNodes: [AtomToken, Token|AtomToken]}`
+ */
+declare class AttributeToken extends Token {
+    /**
+     * @param {'ext-attr'|'html-attr'|'table-attr'} type 标签类型
+     * @param {string} tag 标签名
+     * @param {string} key 属性名
+     * @param {string} equal 等号
+     * @param {string} value 属性值
+     * @param {string[]} quotes 引号
+     * @param {import('../../typings/token').accum} accum
+     */
+    constructor(type: 'ext-attr' | 'html-attr' | 'table-attr', tag: string, key: string, equal?: string, value?: string, quotes?: string[], config?: import("../../typings/token").ParserConfig, accum?: import('../../typings/token').accum);
+    /** 引号是否匹配 */
+    get balanced(): boolean;
+    /** getValue()的getter */
+    get value(): string | true;
+    /** 标签名 */
+    get tag(): string;
+    type: "ext-attr" | "html-attr" | "table-attr";
+    /**
+     * @override
+     * @returns {string}
+     */
+    override toString(selector: any): string;
+    /**
+     * @override
+     * @returns {string}
+     */
+    override text(): string;
+    /**
+     * @override
+     * @param {number} start 起始位置
+     */
+    override lint(start: number): import("../../typings/token").LintError[];
+    /** 获取属性值 */
+    getValue(): string | true;
+    #private;
+}
+declare namespace AttributeToken {
+    export { ParserConfig };
+}
+import Token = require(".");
+type ParserConfig = import('../../typings/token').ParserConfig;

package/dist/src/attributes.d.ts

@@ -0,0 +1,41 @@
+export = AttributesToken;
+/**
+ * 扩展和HTML标签属性
+ * @classdesc `{childNodes: ...AtomToken|AttributeToken}`
+ */
+declare class AttributesToken extends Token {
+    /**
+     * @param {string} attr 标签属性
+     * @param {'ext-attrs'|'html-attrs'|'table-attrs'} type 标签类型
+     * @param {string} name 标签名
+     * @param {import('../../typings/token').accum} accum
+     */
+    constructor(attr: string, type: 'ext-attrs' | 'html-attrs' | 'table-attrs', name: string, config?: import("../../typings/token").ParserConfig, accum?: import('../../typings/token').accum);
+    type: "ext-attrs" | "html-attrs" | "table-attrs";
+    /**
+     * 所有指定属性名的AttributeToken
+     * @param {string} key 属性名
+     * @returns {AttributeToken[]}
+     */
+    getAttrTokens(key: string): AttributeToken[];
+    /**
+     * 制定属性名的最后一个AttributeToken
+     * @param {string} key 属性名
+     */
+    getAttrToken(key: string): AttributeToken;
+    /**
+     * 获取标签属性
+     * @param {string} key 属性键
+     */
+    getAttr(key: string): string | true;
+    /**
+     * @override
+     * @this {AttributesToken & {parentNode: HtmlToken}}
+     * @param {number} start 起始位置
+     */
+    override lint(this: AttributesToken & {
+        parentNode: import("./html");
+    }, start: number): import("../../typings/token").LintError[];
+}
+import Token = require(".");
+import AttributeToken = require("./attribute");

package/dist/src/converter.d.ts

@@ -0,0 +1,29 @@
+export = ConverterToken;
+/**
+ * 转换
+ * @classdesc `{childNodes: [ConverterFlagsToken, ...ConverterRuleToken]}`
+ */
+declare class ConverterToken extends Token {
+    /**
+     * @param {string[]} flags 转换类型标记
+     * @param {string[]} rules 转换规则
+     * @param {import('../../typings/token').accum} accum
+     */
+    constructor(flags: string[], rules: string[], config?: import("../../typings/token").ParserConfig, accum?: import('../../typings/token').accum);
+    /**
+     * @override
+     * @returns {string}
+     */
+    override toString(selector: any): string;
+    /**
+     * @override
+     * @returns {string}
+     */
+    override text(): string;
+    /**
+     * @override
+     * @param {number} i 子节点位置
+     */
+    override getGaps(i?: number): 1 | 0;
+}
+import Token = require(".");

package/dist/src/converterFlags.d.ts

@@ -0,0 +1,32 @@
+export = ConverterFlagsToken;
+/**
+ * 转换flags
+ * @classdesc `{childNodes: ...AtomToken}`
+ */
+declare class ConverterFlagsToken extends Token {
+    /**
+     * @param {string[]} flags 转换类型标记
+     * @param {import('../../typings/token').accum} accum
+     */
+    constructor(flags: string[], config?: import("../../typings/token").ParserConfig, accum?: import('../../typings/token').accum);
+    /**
+     * @override
+     */
+    override toString(selector: any): string;
+    /** @override */
+    override text(): string;
+    /**
+     * @override
+     * @param {number} start 起始位置
+     */
+    override lint(start: number): import("../../typings/token").LintError[];
+    /**
+     * 获取未知转换类型标记
+     * @complexity `n`
+     */
+    getUnknownFlags(): Set<string>;
+    /** 获取指定语言变体的转换标记 */
+    getVariantFlags(): Set<string>;
+    #private;
+}
+import Token = require(".");

package/dist/src/converterRule.d.ts

@@ -0,0 +1,29 @@
+export = ConverterRuleToken;
+/**
+ * 转换规则
+ * @classdesc `{childNodes: ...AtomToken)}`
+ */
+declare class ConverterRuleToken extends Token {
+    /**
+     * @param {string} rule 转换规则
+     * @param {boolean} hasColon 是否带有":"
+     * @param {import('../../typings/token').accum} accum
+     */
+    constructor(rule: string, hasColon?: boolean, config?: import("../../typings/token").ParserConfig, accum?: import('../../typings/token').accum);
+    /**
+     * @override
+     * @returns {string}
+     */
+    override toString(selector: any): string;
+    /**
+     * @override
+     * @returns {string}
+     */
+    override text(): string;
+    /**
+     * @override
+     * @param {number} i 子节点序号
+     */
+    override getGaps(i?: number): 1 | 2;
+}
+import Token = require(".");