-
-
Notifications
You must be signed in to change notification settings - Fork 6
/
index.d.ts
242 lines (212 loc) · 4.96 KB
/
index.d.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
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
import type {
Data,
Parent,
BlockContent,
DefinitionContent,
PhrasingContent
} from 'mdast'
export {directiveFromMarkdown, directiveToMarkdown} from './lib/index.js'
/**
* Fields shared by directives.
*/
interface DirectiveFields {
/**
* Directive name.
*/
name: string
/**
* Directive attributes.
*/
attributes?: Record<string, string | null | undefined> | null | undefined
}
/**
* Markdown directive (container form).
*/
export interface ContainerDirective extends Parent, DirectiveFields {
/**
* Node type of container directive.
*/
type: 'containerDirective'
/**
* Children of container directive.
*/
children: Array<BlockContent | DefinitionContent>
/**
* Data associated with the mdast container directive.
*/
data?: ContainerDirectiveData | undefined
}
/**
* Info associated with mdast container directive nodes by the ecosystem.
*/
export interface ContainerDirectiveData extends Data {}
/**
* Markdown directive (leaf form).
*/
export interface LeafDirective extends Parent, DirectiveFields {
/**
* Node type of leaf directive.
*/
type: 'leafDirective'
/**
* Children of leaf directive.
*/
children: PhrasingContent[]
/**
* Data associated with the mdast leaf directive.
*/
data?: LeafDirectiveData | undefined
}
/**
* Info associated with mdast leaf directive nodes by the ecosystem.
*/
export interface LeafDirectiveData extends Data {}
/**
* Markdown directive (text form).
*/
export interface TextDirective extends Parent, DirectiveFields {
/**
* Node type of text directive.
*/
type: 'textDirective'
/**
* Children of text directive.
*/
children: PhrasingContent[]
/**
* Data associated with the text leaf directive.
*/
data?: TextDirectiveData | undefined
}
/**
* Info associated with mdast text directive nodes by the ecosystem.
*/
export interface TextDirectiveData extends Data {}
/**
* Union of registered mdast directive nodes.
*
* It is not possible to register custom mdast directive node types.
*/
export type Directives = ContainerDirective | LeafDirective | TextDirective
// Add custom data tracked to turn markdown into a tree.
declare module 'mdast-util-from-markdown' {
interface CompileData {
/**
* Attributes for current directive.
*/
directiveAttributes?: Array<[string, string]> | undefined
}
}
// Add custom data tracked to turn a syntax tree into markdown.
declare module 'mdast-util-to-markdown' {
interface ConstructNameMap {
/**
* Whole container directive.
*
* ```markdown
* > | :::a
* ^^^^
* > | :::
* ^^^
* ```
*/
containerDirective: 'containerDirective'
/**
* Label of a container directive.
*
* ```markdown
* > | :::a[b]
* ^^^
* | :::
* ```
*/
containerDirectiveLabel: 'containerDirectiveLabel'
/**
* Whole leaf directive.
*
* ```markdown
* > | ::a
* ^^^
* ```
*/
leafDirective: 'leafDirective'
/**
* Label of a leaf directive.
*
* ```markdown
* > | ::a[b]
* ^^^
* ```
*/
leafDirectiveLabel: 'leafDirectiveLabel'
/**
* Whole text directive.
*
* ```markdown
* > | :a
* ^^
* ```
*/
textDirective: 'textDirective'
/**
* Label of a text directive.
*
* ```markdown
* > | :a[b]
* ^^^
* ```
*/
textDirectiveLabel: 'textDirectiveLabel'
}
}
// Add nodes to content, register `data` on paragraph.
declare module 'mdast' {
interface BlockContentMap {
/**
* Directive in flow content (such as in the root document, or block
* quotes), which contains further flow content.
*/
containerDirective: ContainerDirective
/**
* Directive in flow content (such as in the root document, or block
* quotes), which contains nothing.
*/
leafDirective: LeafDirective
}
interface ParagraphData {
/**
* Field set on the first paragraph which is a child of a container
* directive.
* When this is `true`, that means the paragraph represents the *label*:
*
* ```markdown
* :::a[This is the label]
* This is further things.
* :::
* ```
*/
directiveLabel?: boolean | null | undefined
}
interface PhrasingContentMap {
/**
* Directive in phrasing content (such as in paragraphs, headings).
*/
textDirective: TextDirective
}
interface RootContentMap {
/**
* Directive in flow content (such as in the root document, or block
* quotes), which contains further flow content.
*/
containerDirective: ContainerDirective
/**
* Directive in flow content (such as in the root document, or block
* quotes), which contains nothing.
*/
leafDirective: LeafDirective
/**
* Directive in phrasing content (such as in paragraphs, headings).
*/
textDirective: TextDirective
}
}