-
Notifications
You must be signed in to change notification settings - Fork 1
/
base.ts
212 lines (192 loc) · 3.94 KB
/
base.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
export interface Config {
ext: string[];
readonly html: [string[], string[], string[]];
readonly namespaces: Record<string, string>;
readonly nsid: Record<string, number>;
readonly parserFunction: [Record<string, string>, string[], string[], string[]];
readonly doubleUnderscore: [string[], string[], Record<string, string>?];
readonly protocol: string;
readonly img: Record<string, string>;
readonly redirection: string[];
readonly variants: string[];
readonly excludes?: string[];
/* NOT FOR BROWSER */
readonly interwiki: string[];
readonly conversionTable?: [string, string][];
readonly redirects?: [string, string][];
readonly articlePath?: string;
}
export type TokenTypes = 'root'
| 'plain'
| 'redirect'
| 'redirect-syntax'
| 'redirect-target'
| 'onlyinclude'
| 'noinclude'
| 'include'
| 'comment'
| 'ext'
| 'ext-attrs'
| 'ext-attr-dirty'
| 'ext-attr'
| 'attr-key'
| 'attr-value'
| 'ext-inner'
| 'arg'
| 'arg-name'
| 'arg-default'
| 'hidden'
| 'magic-word'
| 'magic-word-name'
| 'invoke-function'
| 'invoke-module'
| 'template'
| 'template-name'
| 'parameter'
| 'parameter-key'
| 'parameter-value'
| 'heading'
| 'heading-title'
| 'heading-trail'
| 'html'
| 'html-attrs'
| 'html-attr-dirty'
| 'html-attr'
| 'table'
| 'tr'
| 'td'
| 'table-syntax'
| 'table-attrs'
| 'table-attr-dirty'
| 'table-attr'
| 'table-inter'
| 'td-inner'
| 'hr'
| 'double-underscore'
| 'link'
| 'link-target'
| 'link-text'
| 'category'
| 'file'
| 'gallery-image'
| 'imagemap-image'
| 'image-parameter'
| 'quote'
| 'ext-link'
| 'ext-link-text'
| 'ext-link-url'
| 'free-ext-link'
| 'magic-link'
| 'list'
| 'dd'
| 'list-range'
| 'converter'
| 'converter-flags'
| 'converter-flag'
| 'converter-rule'
| 'converter-rule-variant'
| 'converter-rule-to'
| 'converter-rule-from'
| 'param-line'
| 'imagemap-link';
export const rules = [
'bold-header',
'format-leakage',
'fostered-content',
'h1',
'illegal-attr',
'insecure-style',
'invalid-gallery',
'invalid-imagemap',
'invalid-invoke',
'invalid-isbn',
'lonely-apos',
'lonely-bracket',
'lonely-http',
'nested-link',
'no-arg',
'no-duplicate',
'no-ignored',
'obsolete-attr',
'obsolete-tag',
'parsing-order',
'pipe-like',
'table-layout',
'tag-like',
'unbalanced-header',
'unclosed-comment',
'unclosed-quote',
'unclosed-table',
'unescaped',
'unknown-page',
'unmatched-tag',
'unterminated-url',
'url-encoding',
'var-anchor',
'void-ext',
] as const;
Object.freeze(rules);
export namespace LintError {
export type Severity = 'error' | 'warning';
export type Rule = typeof rules[number];
export interface Fix {
readonly range: [number, number];
text: string;
}
}
export interface LintError {
rule: LintError.Rule;
message: string;
severity: LintError.Severity;
startIndex: number;
endIndex: number;
startLine: number;
startCol: number;
endLine: number;
endCol: number;
fix?: LintError.Fix;
suggestions?: (LintError.Fix & {desc: string})[];
}
export type AST = Record<string, string | number | boolean> & {
range: [number, number];
type?: TokenTypes;
name?: string;
childNodes?: AST[];
};
/** 类似Node */
export interface AstNode {
readonly childNodes: readonly AstNode[];
/** 节点类型 */
type: string;
/** @private */
getAttribute(key: string): unknown;
/** Linter */
lint(): LintError[];
/** 以HTML格式打印 */
print(): string;
}
/** 所有节点的基类 */
interface Token extends AstNode {
readonly name?: string;
/**
* 符合选择器的所有后代节点
* @param selector 选择器
*/
querySelectorAll<T = Token>(selector: string): T[];
/** 保存为JSON */
json(): AST;
}
export interface Parser {
config: Config | string;
i18n: Record<string, string>
| string
| undefined;
/** 获取当前的解析设置 */
getConfig(): Config;
/**
* 解析wikitext
* @param include 是否嵌入
* @param maxStage 最大解析层级
*/
parse(wikitext: string, include?: boolean, maxStage?: number, config?: Config): Token;
}