@storybook/addon-docs 8.5.3 → 8.5.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/dist/mdx-loader.d.ts +1619 -455
  2. package/dist/mdx-loader.js +2 -2
  3. package/dist/mdx-loader.mjs +2 -2
  4. package/dist/preset.js +2 -2
  5. package/package.json +8 -8
package/dist/mdx-loader.d.ts CHANGED
@@ -1,43 +1,12 @@
1
1
  import { transformAsync } from '@babel/core';
2
2
  import * as unist from 'unist';
3
- import { Node as Node$3, Data as Data$7 } from 'unist';
3
+ import { Node as Node$2, Point as Point$2, Position as Position$2, Data as Data$6 } from 'unist';
4
4
  import * as hast from 'hast';
5
- import { ElementContent as ElementContent$1, Properties, Literal, Data as Data$5, Parent as Parent$1 } from 'hast';
5
+ import { ElementContent as ElementContent$1, Properties, Literal, Data as Data$4, Parent as Parent$1 } from 'hast';
6
6
  import * as mdast from 'mdast';
7
- import { Parent, BlockContent, DefinitionContent, Data as Data$6, PhrasingContent, Literal as Literal$1 } from 'mdast';
7
+ import { Parent, BlockContent, DefinitionContent, Data as Data$5, PhrasingContent, Literal as Literal$1 } from 'mdast';
8
8
  import { Program } from 'estree-jsx';
9
9
 
10
- /**
11
- * Contents of the file.
12
- *
13
- * Can either be text or a `Uint8Array` structure.
14
- */
15
- type Value$3 = Uint8Array | string
16
-
17
- /**
18
- * This map registers the type of the `data` key of a `VFile`.
19
- *
20
- * This type can be augmented to register custom `data` types.
21
- *
22
- * @example
23
- * declare module 'vfile' {
24
- * interface DataMap {
25
- * // `file.data.name` is typed as `string`
26
- * name: string
27
- * }
28
- * }
29
- */
30
-
31
- // eslint-disable-next-line @typescript-eslint/consistent-type-definitions, @typescript-eslint/no-empty-interface
32
- interface DataMap {}
33
-
34
- /**
35
- * Custom information.
36
- *
37
- * Known attributes can be added to @see {@link DataMap}
38
- */
39
- type Data$4 = Record<string, unknown> & Partial<DataMap>
40
-
41
10
  /**
42
11
  * Message.
43
12
  */
@@ -45,23 +14,23 @@ declare class VFileMessage extends Error {
45
14
  constructor(reason: string, options?: Options$5 | null | undefined)
46
15
  constructor(
47
16
  reason: string,
48
- parent: Node$2 | NodeLike$1 | null | undefined,
17
+ parent: Node$1 | NodeLike$1 | null | undefined,
49
18
  origin?: string | null | undefined
50
19
  )
51
20
  constructor(
52
21
  reason: string,
53
- place: Point$2 | Position$2 | null | undefined,
22
+ place: Point$1 | Position$1 | null | undefined,
54
23
  origin?: string | null | undefined
55
24
  )
56
25
  constructor(reason: string, origin?: string | null | undefined)
57
26
  constructor(
58
27
  cause: Error | VFileMessage,
59
- parent: Node$2 | NodeLike$1 | null | undefined,
28
+ parent: Node$1 | NodeLike$1 | null | undefined,
60
29
  origin?: string | null | undefined
61
30
  )
62
31
  constructor(
63
32
  cause: Error | VFileMessage,
64
- place: Point$2 | Position$2 | null | undefined,
33
+ place: Point$1 | Position$1 | null | undefined,
65
34
  origin?: string | null | undefined
66
35
  )
67
36
  constructor(cause: Error | VFileMessage, origin?: string | null | undefined)
@@ -70,7 +39,7 @@ declare class VFileMessage extends Error {
70
39
  *
71
40
  * @type {Array<Node> | undefined}
72
41
  */
73
- ancestors: Array<Node$2> | undefined
42
+ ancestors: Array<Node$1> | undefined
74
43
  /**
75
44
  * Starting column of message.
76
45
  *
@@ -104,7 +73,7 @@ declare class VFileMessage extends Error {
104
73
  *
105
74
  * @type {Point | Position | undefined}
106
75
  */
107
- place: Point$2 | Position$2 | undefined
76
+ place: Point$1 | Position$1 | undefined
108
77
  /**
109
78
  * Reason for message, should use markdown.
110
79
  *
@@ -152,12 +121,12 @@ declare class VFileMessage extends Error {
152
121
  */
153
122
  url: string | undefined
154
123
  }
155
- type Node$2 = unist.Node
156
- type Point$2 = unist.Point
157
- type Position$2 = unist.Position
124
+ type Node$1 = unist.Node
125
+ type Point$1 = unist.Point
126
+ type Position$1 = unist.Position
158
127
  type NodeLike$1 = object & {
159
128
  type: string
160
- position?: Position$2 | undefined
129
+ position?: Position$1 | undefined
161
130
  }
162
131
  /**
163
132
  * Configuration.
@@ -166,7 +135,7 @@ type Options$5 = {
166
135
  /**
167
136
  * Stack of (inclusive) ancestor nodes surrounding the message (optional).
168
137
  */
169
- ancestors?: Array<Node$2> | null | undefined
138
+ ancestors?: Array<Node$1> | null | undefined
170
139
  /**
171
140
  * Original error cause of the message (optional).
172
141
  */
@@ -174,7 +143,7 @@ type Options$5 = {
174
143
  /**
175
144
  * Place of message (optional).
176
145
  */
177
- place?: Point$2 | Position$2 | null | undefined
146
+ place?: Point$1 | Position$1 | null | undefined
178
147
  /**
179
148
  * Category of message (optional, example: `'my-rule'`).
180
149
  */
@@ -188,381 +157,1576 @@ type Options$5 = {
188
157
  type Options$4 = Options$5
189
158
 
190
159
  declare class VFile$1 {
191
- /**
192
- * Create a new virtual file.
193
- *
194
- * `options` is treated as:
195
- *
196
- * * `string` or `Uint8Array` — `{value: options}`
197
- * * `URL` — `{path: options}`
198
- * * `VFile` — shallow copies its data over to the new file
199
- * * `object` — all fields are shallow copied over to the new file
200
- *
201
- * Path related fields are set in the following order (least specific to
202
- * most specific): `history`, `path`, `basename`, `stem`, `extname`,
203
- * `dirname`.
204
- *
205
- * You cannot set `dirname` or `extname` without setting either `history`,
206
- * `path`, `basename`, or `stem` too.
207
- *
208
- * @param {Compatible | null | undefined} [value]
209
- * File value.
210
- * @returns
211
- * New instance.
212
- */
213
- constructor(value?: Compatible$2 | null | undefined)
214
- /**
215
- * Base of `path` (default: `process.cwd()` or `'/'` in browsers).
216
- *
217
- * @type {string}
218
- */
219
- cwd: string
220
- /**
221
- * Place to store custom info (default: `{}`).
222
- *
223
- * It’s OK to store custom data directly on the file but moving it to
224
- * `data` is recommended.
225
- *
226
- * @type {Data}
227
- */
228
- data: Data$3
229
- /**
230
- * List of file paths the file moved between.
231
- *
232
- * The first is the original path and the last is the current path.
233
- *
234
- * @type {Array<string>}
235
- */
236
- history: Array<string>
237
- /**
238
- * List of messages associated with the file.
239
- *
240
- * @type {Array<VFileMessage>}
241
- */
242
- messages: Array<VFileMessage>
243
- /**
244
- * Raw value.
245
- *
246
- * @type {Value}
247
- */
248
- value: Value$2
249
- /**
250
- * Source map.
251
- *
252
- * This type is equivalent to the `RawSourceMap` type from the `source-map`
253
- * module.
254
- *
255
- * @type {Map | null | undefined}
256
- */
257
- map: Map$1 | null | undefined
258
- /**
259
- * Custom, non-string, compiled, representation.
260
- *
261
- * This is used by unified to store non-string results.
262
- * One example is when turning markdown into React nodes.
263
- *
264
- * @type {unknown}
265
- */
266
- result: unknown
267
- /**
268
- * Whether a file was saved to disk.
269
- *
270
- * This is used by vfile reporters.
271
- *
272
- * @type {boolean}
273
- */
274
- stored: boolean
275
- /**
276
- * Set basename (including extname) (`'index.min.js'`).
277
- *
278
- * Cannot contain path separators (`'/'` on unix, macOS, and browsers, `'\'`
279
- * on windows).
280
- * Cannot be nullified (use `file.path = file.dirname` instead).
281
- *
282
- * @param {string} basename
283
- * Basename.
284
- * @returns {undefined}
285
- * Nothing.
286
- */
287
- set basename(arg: string | undefined)
288
- /**
289
- * Get the basename (including extname) (example: `'index.min.js'`).
290
- *
291
- * @returns {string | undefined}
292
- * Basename.
293
- */
294
- get basename(): string | undefined
295
- /**
296
- * Set the full path (example: `'~/index.min.js'`).
297
- *
298
- * Cannot be nullified.
299
- * You can set a file URL (a `URL` object with a `file:` protocol) which will
300
- * be turned into a path with `url.fileURLToPath`.
301
- *
302
- * @param {URL | string} path
303
- * Path.
304
- * @returns {undefined}
305
- * Nothing.
306
- */
307
- set path(arg: string)
308
- /**
309
- * Get the full path (example: `'~/index.min.js'`).
310
- *
311
- * @returns {string}
312
- * Path.
313
- */
314
- get path(): string
315
- /**
316
- * Set the parent path (example: `'~'`).
317
- *
318
- * Cannot be set if there’s no `path` yet.
319
- *
320
- * @param {string | undefined} dirname
321
- * Dirname.
322
- * @returns {undefined}
323
- * Nothing.
324
- */
325
- set dirname(arg: string | undefined)
326
- /**
327
- * Get the parent path (example: `'~'`).
328
- *
329
- * @returns {string | undefined}
330
- * Dirname.
331
- */
332
- get dirname(): string | undefined
333
- /**
334
- * Set the extname (including dot) (example: `'.js'`).
335
- *
336
- * Cannot contain path separators (`'/'` on unix, macOS, and browsers, `'\'`
337
- * on windows).
338
- * Cannot be set if there’s no `path` yet.
339
- *
340
- * @param {string | undefined} extname
341
- * Extname.
342
- * @returns {undefined}
343
- * Nothing.
344
- */
345
- set extname(arg: string | undefined)
346
- /**
347
- * Get the extname (including dot) (example: `'.js'`).
348
- *
349
- * @returns {string | undefined}
350
- * Extname.
351
- */
352
- get extname(): string | undefined
353
- /**
354
- * Set the stem (basename w/o extname) (example: `'index.min'`).
355
- *
356
- * Cannot contain path separators (`'/'` on unix, macOS, and browsers, `'\'`
357
- * on windows).
358
- * Cannot be nullified (use `file.path = file.dirname` instead).
359
- *
360
- * @param {string} stem
361
- * Stem.
362
- * @returns {undefined}
363
- * Nothing.
364
- */
365
- set stem(arg: string | undefined)
366
- /**
367
- * Get the stem (basename w/o extname) (example: `'index.min'`).
368
- *
369
- * @returns {string | undefined}
370
- * Stem.
371
- */
372
- get stem(): string | undefined
373
- fail(reason: string, options?: MessageOptions | null | undefined): never
374
- fail(
375
- reason: string,
376
- parent: Node$1 | NodeLike | null | undefined,
377
- origin?: string | null | undefined
378
- ): never
379
- fail(
380
- reason: string,
381
- place: Point$1 | Position$1 | null | undefined,
382
- origin?: string | null | undefined
383
- ): never
384
- fail(reason: string, origin?: string | null | undefined): never
385
- fail(
386
- cause: Error | VFileMessage,
387
- parent: Node$1 | NodeLike | null | undefined,
388
- origin?: string | null | undefined
389
- ): never
390
- fail(
391
- cause: Error | VFileMessage,
392
- place: Point$1 | Position$1 | null | undefined,
393
- origin?: string | null | undefined
394
- ): never
395
- fail(cause: Error | VFileMessage, origin?: string | null | undefined): never
396
- info(
397
- reason: string,
398
- options?: MessageOptions | null | undefined
399
- ): VFileMessage
400
- info(
401
- reason: string,
402
- parent: Node$1 | NodeLike | null | undefined,
403
- origin?: string | null | undefined
404
- ): VFileMessage
405
- info(
406
- reason: string,
407
- place: Point$1 | Position$1 | null | undefined,
408
- origin?: string | null | undefined
409
- ): VFileMessage
410
- info(reason: string, origin?: string | null | undefined): VFileMessage
411
- info(
412
- cause: Error | VFileMessage,
413
- parent: Node$1 | NodeLike | null | undefined,
414
- origin?: string | null | undefined
415
- ): VFileMessage
416
- info(
417
- cause: Error | VFileMessage,
418
- place: Point$1 | Position$1 | null | undefined,
419
- origin?: string | null | undefined
420
- ): VFileMessage
421
- info(
422
- cause: Error | VFileMessage,
423
- origin?: string | null | undefined
424
- ): VFileMessage
425
- message(
426
- reason: string,
427
- options?: MessageOptions | null | undefined
428
- ): VFileMessage
429
- message(
430
- reason: string,
431
- parent: Node$1 | NodeLike | null | undefined,
432
- origin?: string | null | undefined
433
- ): VFileMessage
434
- message(
435
- reason: string,
436
- place: Point$1 | Position$1 | null | undefined,
437
- origin?: string | null | undefined
438
- ): VFileMessage
439
- message(reason: string, origin?: string | null | undefined): VFileMessage
440
- message(
441
- cause: Error | VFileMessage,
442
- parent: Node$1 | NodeLike | null | undefined,
443
- origin?: string | null | undefined
444
- ): VFileMessage
445
- message(
446
- cause: Error | VFileMessage,
447
- place: Point$1 | Position$1 | null | undefined,
448
- origin?: string | null | undefined
449
- ): VFileMessage
450
- message(
451
- cause: Error | VFileMessage,
452
- origin?: string | null | undefined
453
- ): VFileMessage
454
- /**
455
- * Serialize the file.
456
- *
457
- * > **Note**: which encodings are supported depends on the engine.
458
- * > For info on Node.js, see:
459
- * > <https://nodejs.org/api/util.html#whatwg-supported-encodings>.
460
- *
461
- * @param {string | null | undefined} [encoding='utf8']
462
- * Character encoding to understand `value` as when it’s a `Uint8Array`
463
- * (default: `'utf-8'`).
464
- * @returns {string}
465
- * Serialized file.
466
- */
467
- toString(encoding?: string | null | undefined): string
468
- }
469
- type Node$1 = unist.Node
470
- type Point$1 = unist.Point
471
- type Position$1 = unist.Position
472
- type MessageOptions = Options$4
473
- type Data$3 = Data$4
474
- type Value$2 = Value$3
475
- type NodeLike = object & {
476
- type: string
477
- position?: Position$1 | undefined
478
- }
479
- /**
480
- * Things that can be passed to the constructor.
481
- */
482
- type Compatible$2 = Options$3 | URL | VFile$1 | Value$2
483
- /**
484
- * Set multiple values.
485
- */
486
- type VFileCoreOptions = {
487
- /**
488
- * Set `basename` (name).
489
- */
490
- basename?: string | null | undefined
491
- /**
492
- * Set `cwd` (working directory).
493
- */
494
- cwd?: string | null | undefined
495
- /**
496
- * Set `data` (associated info).
497
- */
498
- data?: Data$3 | null | undefined
499
- /**
500
- * Set `dirname` (path w/o basename).
501
- */
502
- dirname?: string | null | undefined
503
- /**
504
- * Set `extname` (extension with dot).
505
- */
506
- extname?: string | null | undefined
507
- /**
508
- * Set `history` (paths the file moved between).
509
- */
510
- history?: Array<string> | null | undefined
511
- /**
512
- * Set `path` (current path).
513
- */
514
- path?: URL | string | null | undefined
515
- /**
516
- * Set `stem` (name without extension).
517
- */
518
- stem?: string | null | undefined
519
- /**
520
- * Set `value` (the contents of the file).
521
- */
522
- value?: Value$2 | null | undefined
523
- }
524
- /**
525
- * Raw source map.
526
- *
527
- * See:
528
- * <https://github.com/mozilla/source-map/blob/60adcb0/source-map.d.ts#L15-L23>.
529
- */
530
- type Map$1 = {
531
- /**
532
- * Which version of the source map spec this map is following.
533
- */
534
- version: number
535
- /**
536
- * An array of URLs to the original source files.
537
- */
538
- sources: Array<string>
539
- /**
540
- * An array of identifiers which can be referenced by individual mappings.
541
- */
542
- names: Array<string>
543
- /**
544
- * The URL root from which all sources are relative.
545
- */
546
- sourceRoot?: string | undefined
547
- /**
548
- * An array of contents of the original source files.
549
- */
550
- sourcesContent?: Array<string> | undefined
551
- /**
552
- * A string of base64 VLQs which contain the actual mappings.
553
- */
554
- mappings: string
555
- /**
556
- * The generated file this source map is associated with.
557
- */
558
- file: string
559
- }
560
- /**
561
- * Configuration.
562
- *
563
- * A bunch of keys that will be shallow copied over to the new file.
564
- */
565
- type Options$3 = Record<string, unknown> & VFileCoreOptions
160
+ /**
161
+ * Create a new virtual file.
162
+ *
163
+ * `options` is treated as:
164
+ *
165
+ * * `string` or `Uint8Array` — `{value: options}`
166
+ * * `URL` — `{path: options}`
167
+ * * `VFile` — shallow copies its data over to the new file
168
+ * * `object` — all fields are shallow copied over to the new file
169
+ *
170
+ * Path related fields are set in the following order (least specific to
171
+ * most specific): `history`, `path`, `basename`, `stem`, `extname`,
172
+ * `dirname`.
173
+ *
174
+ * You cannot set `dirname` or `extname` without setting either `history`,
175
+ * `path`, `basename`, or `stem` too.
176
+ *
177
+ * @param {Compatible | null | undefined} [value]
178
+ * File value.
179
+ * @returns
180
+ * New instance.
181
+ */
182
+ constructor(value?: Compatible$2 | null | undefined);
183
+ /**
184
+ * Base of `path` (default: `process.cwd()` or `'/'` in browsers).
185
+ *
186
+ * @type {string}
187
+ */
188
+ cwd: string;
189
+ /**
190
+ * Place to store custom info (default: `{}`).
191
+ *
192
+ * It’s OK to store custom data directly on the file but moving it to
193
+ * `data` is recommended.
194
+ *
195
+ * @type {Data}
196
+ */
197
+ data: Data$3;
198
+ /**
199
+ * List of file paths the file moved between.
200
+ *
201
+ * The first is the original path and the last is the current path.
202
+ *
203
+ * @type {Array<string>}
204
+ */
205
+ history: Array<string>;
206
+ /**
207
+ * List of messages associated with the file.
208
+ *
209
+ * @type {Array<VFileMessage>}
210
+ */
211
+ messages: Array<VFileMessage>;
212
+ /**
213
+ * Raw value.
214
+ *
215
+ * @type {Value}
216
+ */
217
+ value: Value$1;
218
+ /**
219
+ * Source map.
220
+ *
221
+ * This type is equivalent to the `RawSourceMap` type from the `source-map`
222
+ * module.
223
+ *
224
+ * @type {Map | null | undefined}
225
+ */
226
+ map: Map$1 | null | undefined;
227
+ /**
228
+ * Custom, non-string, compiled, representation.
229
+ *
230
+ * This is used by unified to store non-string results.
231
+ * One example is when turning markdown into React nodes.
232
+ *
233
+ * @type {unknown}
234
+ */
235
+ result: unknown;
236
+ /**
237
+ * Whether a file was saved to disk.
238
+ *
239
+ * This is used by vfile reporters.
240
+ *
241
+ * @type {boolean}
242
+ */
243
+ stored: boolean;
244
+ /**
245
+ * Set basename (including extname) (`'index.min.js'`).
246
+ *
247
+ * Cannot contain path separators (`'/'` on unix, macOS, and browsers, `'\'`
248
+ * on windows).
249
+ * Cannot be nullified (use `file.path = file.dirname` instead).
250
+ *
251
+ * @param {string} basename
252
+ * Basename.
253
+ * @returns {undefined}
254
+ * Nothing.
255
+ */
256
+ set basename(basename: string);
257
+ /**
258
+ * Get the basename (including extname) (example: `'index.min.js'`).
259
+ *
260
+ * @returns {string | undefined}
261
+ * Basename.
262
+ */
263
+ get basename(): string | undefined;
264
+ /**
265
+ * Set the full path (example: `'~/index.min.js'`).
266
+ *
267
+ * Cannot be nullified.
268
+ * You can set a file URL (a `URL` object with a `file:` protocol) which will
269
+ * be turned into a path with `url.fileURLToPath`.
270
+ *
271
+ * @param {URL | string} path
272
+ * Path.
273
+ * @returns {undefined}
274
+ * Nothing.
275
+ */
276
+ set path(path: string | URL);
277
+ /**
278
+ * Get the full path (example: `'~/index.min.js'`).
279
+ *
280
+ * @returns {string}
281
+ * Path.
282
+ */
283
+ get path(): string;
284
+ /**
285
+ * Set the parent path (example: `'~'`).
286
+ *
287
+ * Cannot be set if there’s no `path` yet.
288
+ *
289
+ * @param {string | undefined} dirname
290
+ * Dirname.
291
+ * @returns {undefined}
292
+ * Nothing.
293
+ */
294
+ set dirname(dirname: string | undefined);
295
+ /**
296
+ * Get the parent path (example: `'~'`).
297
+ *
298
+ * @returns {string | undefined}
299
+ * Dirname.
300
+ */
301
+ get dirname(): string | undefined;
302
+ /**
303
+ * Set the extname (including dot) (example: `'.js'`).
304
+ *
305
+ * Cannot contain path separators (`'/'` on unix, macOS, and browsers, `'\'`
306
+ * on windows).
307
+ * Cannot be set if there’s no `path` yet.
308
+ *
309
+ * @param {string | undefined} extname
310
+ * Extname.
311
+ * @returns {undefined}
312
+ * Nothing.
313
+ */
314
+ set extname(extname: string | undefined);
315
+ /**
316
+ * Get the extname (including dot) (example: `'.js'`).
317
+ *
318
+ * @returns {string | undefined}
319
+ * Extname.
320
+ */
321
+ get extname(): string | undefined;
322
+ /**
323
+ * Set the stem (basename w/o extname) (example: `'index.min'`).
324
+ *
325
+ * Cannot contain path separators (`'/'` on unix, macOS, and browsers, `'\'`
326
+ * on windows).
327
+ * Cannot be nullified (use `file.path = file.dirname` instead).
328
+ *
329
+ * @param {string} stem
330
+ * Stem.
331
+ * @returns {undefined}
332
+ * Nothing.
333
+ */
334
+ set stem(stem: string);
335
+ /**
336
+ * Get the stem (basename w/o extname) (example: `'index.min'`).
337
+ *
338
+ * @returns {string | undefined}
339
+ * Stem.
340
+ */
341
+ get stem(): string | undefined;
342
+ /**
343
+ * Create a fatal message for `reason` associated with the file.
344
+ *
345
+ * The `fatal` field of the message is set to `true` (error; file not usable)
346
+ * and the `file` field is set to the current file path.
347
+ * The message is added to the `messages` field on `file`.
348
+ *
349
+ * > 🪦 **Note**: also has obsolete signatures.
350
+ *
351
+ * @overload
352
+ * @param {string} reason
353
+ * @param {MessageOptions | null | undefined} [options]
354
+ * @returns {never}
355
+ *
356
+ * @overload
357
+ * @param {string} reason
358
+ * @param {Node | NodeLike | null | undefined} parent
359
+ * @param {string | null | undefined} [origin]
360
+ * @returns {never}
361
+ *
362
+ * @overload
363
+ * @param {string} reason
364
+ * @param {Point | Position | null | undefined} place
365
+ * @param {string | null | undefined} [origin]
366
+ * @returns {never}
367
+ *
368
+ * @overload
369
+ * @param {string} reason
370
+ * @param {string | null | undefined} [origin]
371
+ * @returns {never}
372
+ *
373
+ * @overload
374
+ * @param {Error | VFileMessage} cause
375
+ * @param {Node | NodeLike | null | undefined} parent
376
+ * @param {string | null | undefined} [origin]
377
+ * @returns {never}
378
+ *
379
+ * @overload
380
+ * @param {Error | VFileMessage} cause
381
+ * @param {Point | Position | null | undefined} place
382
+ * @param {string | null | undefined} [origin]
383
+ * @returns {never}
384
+ *
385
+ * @overload
386
+ * @param {Error | VFileMessage} cause
387
+ * @param {string | null | undefined} [origin]
388
+ * @returns {never}
389
+ *
390
+ * @param {Error | VFileMessage | string} causeOrReason
391
+ * Reason for message, should use markdown.
392
+ * @param {Node | NodeLike | MessageOptions | Point | Position | string | null | undefined} [optionsOrParentOrPlace]
393
+ * Configuration (optional).
394
+ * @param {string | null | undefined} [origin]
395
+ * Place in code where the message originates (example:
396
+ * `'my-package:my-rule'` or `'my-rule'`).
397
+ * @returns {never}
398
+ * Never.
399
+ * @throws {VFileMessage}
400
+ * Message.
401
+ */
402
+ fail(reason: string, options?: Options$4 | null | undefined): never;
403
+ /**
404
+ * Create a fatal message for `reason` associated with the file.
405
+ *
406
+ * The `fatal` field of the message is set to `true` (error; file not usable)
407
+ * and the `file` field is set to the current file path.
408
+ * The message is added to the `messages` field on `file`.
409
+ *
410
+ * > 🪦 **Note**: also has obsolete signatures.
411
+ *
412
+ * @overload
413
+ * @param {string} reason
414
+ * @param {MessageOptions | null | undefined} [options]
415
+ * @returns {never}
416
+ *
417
+ * @overload
418
+ * @param {string} reason
419
+ * @param {Node | NodeLike | null | undefined} parent
420
+ * @param {string | null | undefined} [origin]
421
+ * @returns {never}
422
+ *
423
+ * @overload
424
+ * @param {string} reason
425
+ * @param {Point | Position | null | undefined} place
426
+ * @param {string | null | undefined} [origin]
427
+ * @returns {never}
428
+ *
429
+ * @overload
430
+ * @param {string} reason
431
+ * @param {string | null | undefined} [origin]
432
+ * @returns {never}
433
+ *
434
+ * @overload
435
+ * @param {Error | VFileMessage} cause
436
+ * @param {Node | NodeLike | null | undefined} parent
437
+ * @param {string | null | undefined} [origin]
438
+ * @returns {never}
439
+ *
440
+ * @overload
441
+ * @param {Error | VFileMessage} cause
442
+ * @param {Point | Position | null | undefined} place
443
+ * @param {string | null | undefined} [origin]
444
+ * @returns {never}
445
+ *
446
+ * @overload
447
+ * @param {Error | VFileMessage} cause
448
+ * @param {string | null | undefined} [origin]
449
+ * @returns {never}
450
+ *
451
+ * @param {Error | VFileMessage | string} causeOrReason
452
+ * Reason for message, should use markdown.
453
+ * @param {Node | NodeLike | MessageOptions | Point | Position | string | null | undefined} [optionsOrParentOrPlace]
454
+ * Configuration (optional).
455
+ * @param {string | null | undefined} [origin]
456
+ * Place in code where the message originates (example:
457
+ * `'my-package:my-rule'` or `'my-rule'`).
458
+ * @returns {never}
459
+ * Never.
460
+ * @throws {VFileMessage}
461
+ * Message.
462
+ */
463
+ fail(reason: string, parent: Node$2 | NodeLike | null | undefined, origin?: string | null | undefined): never;
464
+ /**
465
+ * Create a fatal message for `reason` associated with the file.
466
+ *
467
+ * The `fatal` field of the message is set to `true` (error; file not usable)
468
+ * and the `file` field is set to the current file path.
469
+ * The message is added to the `messages` field on `file`.
470
+ *
471
+ * > 🪦 **Note**: also has obsolete signatures.
472
+ *
473
+ * @overload
474
+ * @param {string} reason
475
+ * @param {MessageOptions | null | undefined} [options]
476
+ * @returns {never}
477
+ *
478
+ * @overload
479
+ * @param {string} reason
480
+ * @param {Node | NodeLike | null | undefined} parent
481
+ * @param {string | null | undefined} [origin]
482
+ * @returns {never}
483
+ *
484
+ * @overload
485
+ * @param {string} reason
486
+ * @param {Point | Position | null | undefined} place
487
+ * @param {string | null | undefined} [origin]
488
+ * @returns {never}
489
+ *
490
+ * @overload
491
+ * @param {string} reason
492
+ * @param {string | null | undefined} [origin]
493
+ * @returns {never}
494
+ *
495
+ * @overload
496
+ * @param {Error | VFileMessage} cause
497
+ * @param {Node | NodeLike | null | undefined} parent
498
+ * @param {string | null | undefined} [origin]
499
+ * @returns {never}
500
+ *
501
+ * @overload
502
+ * @param {Error | VFileMessage} cause
503
+ * @param {Point | Position | null | undefined} place
504
+ * @param {string | null | undefined} [origin]
505
+ * @returns {never}
506
+ *
507
+ * @overload
508
+ * @param {Error | VFileMessage} cause
509
+ * @param {string | null | undefined} [origin]
510
+ * @returns {never}
511
+ *
512
+ * @param {Error | VFileMessage | string} causeOrReason
513
+ * Reason for message, should use markdown.
514
+ * @param {Node | NodeLike | MessageOptions | Point | Position | string | null | undefined} [optionsOrParentOrPlace]
515
+ * Configuration (optional).
516
+ * @param {string | null | undefined} [origin]
517
+ * Place in code where the message originates (example:
518
+ * `'my-package:my-rule'` or `'my-rule'`).
519
+ * @returns {never}
520
+ * Never.
521
+ * @throws {VFileMessage}
522
+ * Message.
523
+ */
524
+ fail(reason: string, place: Point$2 | Position$2 | null | undefined, origin?: string | null | undefined): never;
525
+ /**
526
+ * Create a fatal message for `reason` associated with the file.
527
+ *
528
+ * The `fatal` field of the message is set to `true` (error; file not usable)
529
+ * and the `file` field is set to the current file path.
530
+ * The message is added to the `messages` field on `file`.
531
+ *
532
+ * > 🪦 **Note**: also has obsolete signatures.
533
+ *
534
+ * @overload
535
+ * @param {string} reason
536
+ * @param {MessageOptions | null | undefined} [options]
537
+ * @returns {never}
538
+ *
539
+ * @overload
540
+ * @param {string} reason
541
+ * @param {Node | NodeLike | null | undefined} parent
542
+ * @param {string | null | undefined} [origin]
543
+ * @returns {never}
544
+ *
545
+ * @overload
546
+ * @param {string} reason
547
+ * @param {Point | Position | null | undefined} place
548
+ * @param {string | null | undefined} [origin]
549
+ * @returns {never}
550
+ *
551
+ * @overload
552
+ * @param {string} reason
553
+ * @param {string | null | undefined} [origin]
554
+ * @returns {never}
555
+ *
556
+ * @overload
557
+ * @param {Error | VFileMessage} cause
558
+ * @param {Node | NodeLike | null | undefined} parent
559
+ * @param {string | null | undefined} [origin]
560
+ * @returns {never}
561
+ *
562
+ * @overload
563
+ * @param {Error | VFileMessage} cause
564
+ * @param {Point | Position | null | undefined} place
565
+ * @param {string | null | undefined} [origin]
566
+ * @returns {never}
567
+ *
568
+ * @overload
569
+ * @param {Error | VFileMessage} cause
570
+ * @param {string | null | undefined} [origin]
571
+ * @returns {never}
572
+ *
573
+ * @param {Error | VFileMessage | string} causeOrReason
574
+ * Reason for message, should use markdown.
575
+ * @param {Node | NodeLike | MessageOptions | Point | Position | string | null | undefined} [optionsOrParentOrPlace]
576
+ * Configuration (optional).
577
+ * @param {string | null | undefined} [origin]
578
+ * Place in code where the message originates (example:
579
+ * `'my-package:my-rule'` or `'my-rule'`).
580
+ * @returns {never}
581
+ * Never.
582
+ * @throws {VFileMessage}
583
+ * Message.
584
+ */
585
+ fail(reason: string, origin?: string | null | undefined): never;
586
+ /**
587
+ * Create a fatal message for `reason` associated with the file.
588
+ *
589
+ * The `fatal` field of the message is set to `true` (error; file not usable)
590
+ * and the `file` field is set to the current file path.
591
+ * The message is added to the `messages` field on `file`.
592
+ *
593
+ * > 🪦 **Note**: also has obsolete signatures.
594
+ *
595
+ * @overload
596
+ * @param {string} reason
597
+ * @param {MessageOptions | null | undefined} [options]
598
+ * @returns {never}
599
+ *
600
+ * @overload
601
+ * @param {string} reason
602
+ * @param {Node | NodeLike | null | undefined} parent
603
+ * @param {string | null | undefined} [origin]
604
+ * @returns {never}
605
+ *
606
+ * @overload
607
+ * @param {string} reason
608
+ * @param {Point | Position | null | undefined} place
609
+ * @param {string | null | undefined} [origin]
610
+ * @returns {never}
611
+ *
612
+ * @overload
613
+ * @param {string} reason
614
+ * @param {string | null | undefined} [origin]
615
+ * @returns {never}
616
+ *
617
+ * @overload
618
+ * @param {Error | VFileMessage} cause
619
+ * @param {Node | NodeLike | null | undefined} parent
620
+ * @param {string | null | undefined} [origin]
621
+ * @returns {never}
622
+ *
623
+ * @overload
624
+ * @param {Error | VFileMessage} cause
625
+ * @param {Point | Position | null | undefined} place
626
+ * @param {string | null | undefined} [origin]
627
+ * @returns {never}
628
+ *
629
+ * @overload
630
+ * @param {Error | VFileMessage} cause
631
+ * @param {string | null | undefined} [origin]
632
+ * @returns {never}
633
+ *
634
+ * @param {Error | VFileMessage | string} causeOrReason
635
+ * Reason for message, should use markdown.
636
+ * @param {Node | NodeLike | MessageOptions | Point | Position | string | null | undefined} [optionsOrParentOrPlace]
637
+ * Configuration (optional).
638
+ * @param {string | null | undefined} [origin]
639
+ * Place in code where the message originates (example:
640
+ * `'my-package:my-rule'` or `'my-rule'`).
641
+ * @returns {never}
642
+ * Never.
643
+ * @throws {VFileMessage}
644
+ * Message.
645
+ */
646
+ fail(cause: Error | VFileMessage, parent: Node$2 | NodeLike | null | undefined, origin?: string | null | undefined): never;
647
+ /**
648
+ * Create a fatal message for `reason` associated with the file.
649
+ *
650
+ * The `fatal` field of the message is set to `true` (error; file not usable)
651
+ * and the `file` field is set to the current file path.
652
+ * The message is added to the `messages` field on `file`.
653
+ *
654
+ * > 🪦 **Note**: also has obsolete signatures.
655
+ *
656
+ * @overload
657
+ * @param {string} reason
658
+ * @param {MessageOptions | null | undefined} [options]
659
+ * @returns {never}
660
+ *
661
+ * @overload
662
+ * @param {string} reason
663
+ * @param {Node | NodeLike | null | undefined} parent
664
+ * @param {string | null | undefined} [origin]
665
+ * @returns {never}
666
+ *
667
+ * @overload
668
+ * @param {string} reason
669
+ * @param {Point | Position | null | undefined} place
670
+ * @param {string | null | undefined} [origin]
671
+ * @returns {never}
672
+ *
673
+ * @overload
674
+ * @param {string} reason
675
+ * @param {string | null | undefined} [origin]
676
+ * @returns {never}
677
+ *
678
+ * @overload
679
+ * @param {Error | VFileMessage} cause
680
+ * @param {Node | NodeLike | null | undefined} parent
681
+ * @param {string | null | undefined} [origin]
682
+ * @returns {never}
683
+ *
684
+ * @overload
685
+ * @param {Error | VFileMessage} cause
686
+ * @param {Point | Position | null | undefined} place
687
+ * @param {string | null | undefined} [origin]
688
+ * @returns {never}
689
+ *
690
+ * @overload
691
+ * @param {Error | VFileMessage} cause
692
+ * @param {string | null | undefined} [origin]
693
+ * @returns {never}
694
+ *
695
+ * @param {Error | VFileMessage | string} causeOrReason
696
+ * Reason for message, should use markdown.
697
+ * @param {Node | NodeLike | MessageOptions | Point | Position | string | null | undefined} [optionsOrParentOrPlace]
698
+ * Configuration (optional).
699
+ * @param {string | null | undefined} [origin]
700
+ * Place in code where the message originates (example:
701
+ * `'my-package:my-rule'` or `'my-rule'`).
702
+ * @returns {never}
703
+ * Never.
704
+ * @throws {VFileMessage}
705
+ * Message.
706
+ */
707
+ fail(cause: Error | VFileMessage, place: Point$2 | Position$2 | null | undefined, origin?: string | null | undefined): never;
708
+ /**
709
+ * Create a fatal message for `reason` associated with the file.
710
+ *
711
+ * The `fatal` field of the message is set to `true` (error; file not usable)
712
+ * and the `file` field is set to the current file path.
713
+ * The message is added to the `messages` field on `file`.
714
+ *
715
+ * > 🪦 **Note**: also has obsolete signatures.
716
+ *
717
+ * @overload
718
+ * @param {string} reason
719
+ * @param {MessageOptions | null | undefined} [options]
720
+ * @returns {never}
721
+ *
722
+ * @overload
723
+ * @param {string} reason
724
+ * @param {Node | NodeLike | null | undefined} parent
725
+ * @param {string | null | undefined} [origin]
726
+ * @returns {never}
727
+ *
728
+ * @overload
729
+ * @param {string} reason
730
+ * @param {Point | Position | null | undefined} place
731
+ * @param {string | null | undefined} [origin]
732
+ * @returns {never}
733
+ *
734
+ * @overload
735
+ * @param {string} reason
736
+ * @param {string | null | undefined} [origin]
737
+ * @returns {never}
738
+ *
739
+ * @overload
740
+ * @param {Error | VFileMessage} cause
741
+ * @param {Node | NodeLike | null | undefined} parent
742
+ * @param {string | null | undefined} [origin]
743
+ * @returns {never}
744
+ *
745
+ * @overload
746
+ * @param {Error | VFileMessage} cause
747
+ * @param {Point | Position | null | undefined} place
748
+ * @param {string | null | undefined} [origin]
749
+ * @returns {never}
750
+ *
751
+ * @overload
752
+ * @param {Error | VFileMessage} cause
753
+ * @param {string | null | undefined} [origin]
754
+ * @returns {never}
755
+ *
756
+ * @param {Error | VFileMessage | string} causeOrReason
757
+ * Reason for message, should use markdown.
758
+ * @param {Node | NodeLike | MessageOptions | Point | Position | string | null | undefined} [optionsOrParentOrPlace]
759
+ * Configuration (optional).
760
+ * @param {string | null | undefined} [origin]
761
+ * Place in code where the message originates (example:
762
+ * `'my-package:my-rule'` or `'my-rule'`).
763
+ * @returns {never}
764
+ * Never.
765
+ * @throws {VFileMessage}
766
+ * Message.
767
+ */
768
+ fail(cause: Error | VFileMessage, origin?: string | null | undefined): never;
769
+ /**
770
+ * Create an info message for `reason` associated with the file.
771
+ *
772
+ * The `fatal` field of the message is set to `undefined` (info; change
773
+ * likely not needed) and the `file` field is set to the current file path.
774
+ * The message is added to the `messages` field on `file`.
775
+ *
776
+ * > 🪦 **Note**: also has obsolete signatures.
777
+ *
778
+ * @overload
779
+ * @param {string} reason
780
+ * @param {MessageOptions | null | undefined} [options]
781
+ * @returns {VFileMessage}
782
+ *
783
+ * @overload
784
+ * @param {string} reason
785
+ * @param {Node | NodeLike | null | undefined} parent
786
+ * @param {string | null | undefined} [origin]
787
+ * @returns {VFileMessage}
788
+ *
789
+ * @overload
790
+ * @param {string} reason
791
+ * @param {Point | Position | null | undefined} place
792
+ * @param {string | null | undefined} [origin]
793
+ * @returns {VFileMessage}
794
+ *
795
+ * @overload
796
+ * @param {string} reason
797
+ * @param {string | null | undefined} [origin]
798
+ * @returns {VFileMessage}
799
+ *
800
+ * @overload
801
+ * @param {Error | VFileMessage} cause
802
+ * @param {Node | NodeLike | null | undefined} parent
803
+ * @param {string | null | undefined} [origin]
804
+ * @returns {VFileMessage}
805
+ *
806
+ * @overload
807
+ * @param {Error | VFileMessage} cause
808
+ * @param {Point | Position | null | undefined} place
809
+ * @param {string | null | undefined} [origin]
810
+ * @returns {VFileMessage}
811
+ *
812
+ * @overload
813
+ * @param {Error | VFileMessage} cause
814
+ * @param {string | null | undefined} [origin]
815
+ * @returns {VFileMessage}
816
+ *
817
+ * @param {Error | VFileMessage | string} causeOrReason
818
+ * Reason for message, should use markdown.
819
+ * @param {Node | NodeLike | MessageOptions | Point | Position | string | null | undefined} [optionsOrParentOrPlace]
820
+ * Configuration (optional).
821
+ * @param {string | null | undefined} [origin]
822
+ * Place in code where the message originates (example:
823
+ * `'my-package:my-rule'` or `'my-rule'`).
824
+ * @returns {VFileMessage}
825
+ * Message.
826
+ */
827
+ info(reason: string, options?: Options$4 | null | undefined): VFileMessage;
828
+ /**
829
+ * Create an info message for `reason` associated with the file.
830
+ *
831
+ * The `fatal` field of the message is set to `undefined` (info; change
832
+ * likely not needed) and the `file` field is set to the current file path.
833
+ * The message is added to the `messages` field on `file`.
834
+ *
835
+ * > 🪦 **Note**: also has obsolete signatures.
836
+ *
837
+ * @overload
838
+ * @param {string} reason
839
+ * @param {MessageOptions | null | undefined} [options]
840
+ * @returns {VFileMessage}
841
+ *
842
+ * @overload
843
+ * @param {string} reason
844
+ * @param {Node | NodeLike | null | undefined} parent
845
+ * @param {string | null | undefined} [origin]
846
+ * @returns {VFileMessage}
847
+ *
848
+ * @overload
849
+ * @param {string} reason
850
+ * @param {Point | Position | null | undefined} place
851
+ * @param {string | null | undefined} [origin]
852
+ * @returns {VFileMessage}
853
+ *
854
+ * @overload
855
+ * @param {string} reason
856
+ * @param {string | null | undefined} [origin]
857
+ * @returns {VFileMessage}
858
+ *
859
+ * @overload
860
+ * @param {Error | VFileMessage} cause
861
+ * @param {Node | NodeLike | null | undefined} parent
862
+ * @param {string | null | undefined} [origin]
863
+ * @returns {VFileMessage}
864
+ *
865
+ * @overload
866
+ * @param {Error | VFileMessage} cause
867
+ * @param {Point | Position | null | undefined} place
868
+ * @param {string | null | undefined} [origin]
869
+ * @returns {VFileMessage}
870
+ *
871
+ * @overload
872
+ * @param {Error | VFileMessage} cause
873
+ * @param {string | null | undefined} [origin]
874
+ * @returns {VFileMessage}
875
+ *
876
+ * @param {Error | VFileMessage | string} causeOrReason
877
+ * Reason for message, should use markdown.
878
+ * @param {Node | NodeLike | MessageOptions | Point | Position | string | null | undefined} [optionsOrParentOrPlace]
879
+ * Configuration (optional).
880
+ * @param {string | null | undefined} [origin]
881
+ * Place in code where the message originates (example:
882
+ * `'my-package:my-rule'` or `'my-rule'`).
883
+ * @returns {VFileMessage}
884
+ * Message.
885
+ */
886
+ info(reason: string, parent: Node$2 | NodeLike | null | undefined, origin?: string | null | undefined): VFileMessage;
887
+ /**
888
+ * Create an info message for `reason` associated with the file.
889
+ *
890
+ * The `fatal` field of the message is set to `undefined` (info; change
891
+ * likely not needed) and the `file` field is set to the current file path.
892
+ * The message is added to the `messages` field on `file`.
893
+ *
894
+ * > 🪦 **Note**: also has obsolete signatures.
895
+ *
896
+ * @overload
897
+ * @param {string} reason
898
+ * @param {MessageOptions | null | undefined} [options]
899
+ * @returns {VFileMessage}
900
+ *
901
+ * @overload
902
+ * @param {string} reason
903
+ * @param {Node | NodeLike | null | undefined} parent
904
+ * @param {string | null | undefined} [origin]
905
+ * @returns {VFileMessage}
906
+ *
907
+ * @overload
908
+ * @param {string} reason
909
+ * @param {Point | Position | null | undefined} place
910
+ * @param {string | null | undefined} [origin]
911
+ * @returns {VFileMessage}
912
+ *
913
+ * @overload
914
+ * @param {string} reason
915
+ * @param {string | null | undefined} [origin]
916
+ * @returns {VFileMessage}
917
+ *
918
+ * @overload
919
+ * @param {Error | VFileMessage} cause
920
+ * @param {Node | NodeLike | null | undefined} parent
921
+ * @param {string | null | undefined} [origin]
922
+ * @returns {VFileMessage}
923
+ *
924
+ * @overload
925
+ * @param {Error | VFileMessage} cause
926
+ * @param {Point | Position | null | undefined} place
927
+ * @param {string | null | undefined} [origin]
928
+ * @returns {VFileMessage}
929
+ *
930
+ * @overload
931
+ * @param {Error | VFileMessage} cause
932
+ * @param {string | null | undefined} [origin]
933
+ * @returns {VFileMessage}
934
+ *
935
+ * @param {Error | VFileMessage | string} causeOrReason
936
+ * Reason for message, should use markdown.
937
+ * @param {Node | NodeLike | MessageOptions | Point | Position | string | null | undefined} [optionsOrParentOrPlace]
938
+ * Configuration (optional).
939
+ * @param {string | null | undefined} [origin]
940
+ * Place in code where the message originates (example:
941
+ * `'my-package:my-rule'` or `'my-rule'`).
942
+ * @returns {VFileMessage}
943
+ * Message.
944
+ */
945
+ info(reason: string, place: Point$2 | Position$2 | null | undefined, origin?: string | null | undefined): VFileMessage;
946
+ /**
947
+ * Create an info message for `reason` associated with the file.
948
+ *
949
+ * The `fatal` field of the message is set to `undefined` (info; change
950
+ * likely not needed) and the `file` field is set to the current file path.
951
+ * The message is added to the `messages` field on `file`.
952
+ *
953
+ * > 🪦 **Note**: also has obsolete signatures.
954
+ *
955
+ * @overload
956
+ * @param {string} reason
957
+ * @param {MessageOptions | null | undefined} [options]
958
+ * @returns {VFileMessage}
959
+ *
960
+ * @overload
961
+ * @param {string} reason
962
+ * @param {Node | NodeLike | null | undefined} parent
963
+ * @param {string | null | undefined} [origin]
964
+ * @returns {VFileMessage}
965
+ *
966
+ * @overload
967
+ * @param {string} reason
968
+ * @param {Point | Position | null | undefined} place
969
+ * @param {string | null | undefined} [origin]
970
+ * @returns {VFileMessage}
971
+ *
972
+ * @overload
973
+ * @param {string} reason
974
+ * @param {string | null | undefined} [origin]
975
+ * @returns {VFileMessage}
976
+ *
977
+ * @overload
978
+ * @param {Error | VFileMessage} cause
979
+ * @param {Node | NodeLike | null | undefined} parent
980
+ * @param {string | null | undefined} [origin]
981
+ * @returns {VFileMessage}
982
+ *
983
+ * @overload
984
+ * @param {Error | VFileMessage} cause
985
+ * @param {Point | Position | null | undefined} place
986
+ * @param {string | null | undefined} [origin]
987
+ * @returns {VFileMessage}
988
+ *
989
+ * @overload
990
+ * @param {Error | VFileMessage} cause
991
+ * @param {string | null | undefined} [origin]
992
+ * @returns {VFileMessage}
993
+ *
994
+ * @param {Error | VFileMessage | string} causeOrReason
995
+ * Reason for message, should use markdown.
996
+ * @param {Node | NodeLike | MessageOptions | Point | Position | string | null | undefined} [optionsOrParentOrPlace]
997
+ * Configuration (optional).
998
+ * @param {string | null | undefined} [origin]
999
+ * Place in code where the message originates (example:
1000
+ * `'my-package:my-rule'` or `'my-rule'`).
1001
+ * @returns {VFileMessage}
1002
+ * Message.
1003
+ */
1004
+ info(reason: string, origin?: string | null | undefined): VFileMessage;
1005
+ /**
1006
+ * Create an info message for `reason` associated with the file.
1007
+ *
1008
+ * The `fatal` field of the message is set to `undefined` (info; change
1009
+ * likely not needed) and the `file` field is set to the current file path.
1010
+ * The message is added to the `messages` field on `file`.
1011
+ *
1012
+ * > 🪦 **Note**: also has obsolete signatures.
1013
+ *
1014
+ * @overload
1015
+ * @param {string} reason
1016
+ * @param {MessageOptions | null | undefined} [options]
1017
+ * @returns {VFileMessage}
1018
+ *
1019
+ * @overload
1020
+ * @param {string} reason
1021
+ * @param {Node | NodeLike | null | undefined} parent
1022
+ * @param {string | null | undefined} [origin]
1023
+ * @returns {VFileMessage}
1024
+ *
1025
+ * @overload
1026
+ * @param {string} reason
1027
+ * @param {Point | Position | null | undefined} place
1028
+ * @param {string | null | undefined} [origin]
1029
+ * @returns {VFileMessage}
1030
+ *
1031
+ * @overload
1032
+ * @param {string} reason
1033
+ * @param {string | null | undefined} [origin]
1034
+ * @returns {VFileMessage}
1035
+ *
1036
+ * @overload
1037
+ * @param {Error | VFileMessage} cause
1038
+ * @param {Node | NodeLike | null | undefined} parent
1039
+ * @param {string | null | undefined} [origin]
1040
+ * @returns {VFileMessage}
1041
+ *
1042
+ * @overload
1043
+ * @param {Error | VFileMessage} cause
1044
+ * @param {Point | Position | null | undefined} place
1045
+ * @param {string | null | undefined} [origin]
1046
+ * @returns {VFileMessage}
1047
+ *
1048
+ * @overload
1049
+ * @param {Error | VFileMessage} cause
1050
+ * @param {string | null | undefined} [origin]
1051
+ * @returns {VFileMessage}
1052
+ *
1053
+ * @param {Error | VFileMessage | string} causeOrReason
1054
+ * Reason for message, should use markdown.
1055
+ * @param {Node | NodeLike | MessageOptions | Point | Position | string | null | undefined} [optionsOrParentOrPlace]
1056
+ * Configuration (optional).
1057
+ * @param {string | null | undefined} [origin]
1058
+ * Place in code where the message originates (example:
1059
+ * `'my-package:my-rule'` or `'my-rule'`).
1060
+ * @returns {VFileMessage}
1061
+ * Message.
1062
+ */
1063
+ info(cause: Error | VFileMessage, parent: Node$2 | NodeLike | null | undefined, origin?: string | null | undefined): VFileMessage;
1064
+ /**
1065
+ * Create an info message for `reason` associated with the file.
1066
+ *
1067
+ * The `fatal` field of the message is set to `undefined` (info; change
1068
+ * likely not needed) and the `file` field is set to the current file path.
1069
+ * The message is added to the `messages` field on `file`.
1070
+ *
1071
+ * > 🪦 **Note**: also has obsolete signatures.
1072
+ *
1073
+ * @overload
1074
+ * @param {string} reason
1075
+ * @param {MessageOptions | null | undefined} [options]
1076
+ * @returns {VFileMessage}
1077
+ *
1078
+ * @overload
1079
+ * @param {string} reason
1080
+ * @param {Node | NodeLike | null | undefined} parent
1081
+ * @param {string | null | undefined} [origin]
1082
+ * @returns {VFileMessage}
1083
+ *
1084
+ * @overload
1085
+ * @param {string} reason
1086
+ * @param {Point | Position | null | undefined} place
1087
+ * @param {string | null | undefined} [origin]
1088
+ * @returns {VFileMessage}
1089
+ *
1090
+ * @overload
1091
+ * @param {string} reason
1092
+ * @param {string | null | undefined} [origin]
1093
+ * @returns {VFileMessage}
1094
+ *
1095
+ * @overload
1096
+ * @param {Error | VFileMessage} cause
1097
+ * @param {Node | NodeLike | null | undefined} parent
1098
+ * @param {string | null | undefined} [origin]
1099
+ * @returns {VFileMessage}
1100
+ *
1101
+ * @overload
1102
+ * @param {Error | VFileMessage} cause
1103
+ * @param {Point | Position | null | undefined} place
1104
+ * @param {string | null | undefined} [origin]
1105
+ * @returns {VFileMessage}
1106
+ *
1107
+ * @overload
1108
+ * @param {Error | VFileMessage} cause
1109
+ * @param {string | null | undefined} [origin]
1110
+ * @returns {VFileMessage}
1111
+ *
1112
+ * @param {Error | VFileMessage | string} causeOrReason
1113
+ * Reason for message, should use markdown.
1114
+ * @param {Node | NodeLike | MessageOptions | Point | Position | string | null | undefined} [optionsOrParentOrPlace]
1115
+ * Configuration (optional).
1116
+ * @param {string | null | undefined} [origin]
1117
+ * Place in code where the message originates (example:
1118
+ * `'my-package:my-rule'` or `'my-rule'`).
1119
+ * @returns {VFileMessage}
1120
+ * Message.
1121
+ */
1122
+ info(cause: Error | VFileMessage, place: Point$2 | Position$2 | null | undefined, origin?: string | null | undefined): VFileMessage;
1123
+ /**
1124
+ * Create an info message for `reason` associated with the file.
1125
+ *
1126
+ * The `fatal` field of the message is set to `undefined` (info; change
1127
+ * likely not needed) and the `file` field is set to the current file path.
1128
+ * The message is added to the `messages` field on `file`.
1129
+ *
1130
+ * > 🪦 **Note**: also has obsolete signatures.
1131
+ *
1132
+ * @overload
1133
+ * @param {string} reason
1134
+ * @param {MessageOptions | null | undefined} [options]
1135
+ * @returns {VFileMessage}
1136
+ *
1137
+ * @overload
1138
+ * @param {string} reason
1139
+ * @param {Node | NodeLike | null | undefined} parent
1140
+ * @param {string | null | undefined} [origin]
1141
+ * @returns {VFileMessage}
1142
+ *
1143
+ * @overload
1144
+ * @param {string} reason
1145
+ * @param {Point | Position | null | undefined} place
1146
+ * @param {string | null | undefined} [origin]
1147
+ * @returns {VFileMessage}
1148
+ *
1149
+ * @overload
1150
+ * @param {string} reason
1151
+ * @param {string | null | undefined} [origin]
1152
+ * @returns {VFileMessage}
1153
+ *
1154
+ * @overload
1155
+ * @param {Error | VFileMessage} cause
1156
+ * @param {Node | NodeLike | null | undefined} parent
1157
+ * @param {string | null | undefined} [origin]
1158
+ * @returns {VFileMessage}
1159
+ *
1160
+ * @overload
1161
+ * @param {Error | VFileMessage} cause
1162
+ * @param {Point | Position | null | undefined} place
1163
+ * @param {string | null | undefined} [origin]
1164
+ * @returns {VFileMessage}
1165
+ *
1166
+ * @overload
1167
+ * @param {Error | VFileMessage} cause
1168
+ * @param {string | null | undefined} [origin]
1169
+ * @returns {VFileMessage}
1170
+ *
1171
+ * @param {Error | VFileMessage | string} causeOrReason
1172
+ * Reason for message, should use markdown.
1173
+ * @param {Node | NodeLike | MessageOptions | Point | Position | string | null | undefined} [optionsOrParentOrPlace]
1174
+ * Configuration (optional).
1175
+ * @param {string | null | undefined} [origin]
1176
+ * Place in code where the message originates (example:
1177
+ * `'my-package:my-rule'` or `'my-rule'`).
1178
+ * @returns {VFileMessage}
1179
+ * Message.
1180
+ */
1181
+ info(cause: Error | VFileMessage, origin?: string | null | undefined): VFileMessage;
1182
+ /**
1183
+ * Create a message for `reason` associated with the file.
1184
+ *
1185
+ * The `fatal` field of the message is set to `false` (warning; change may be
1186
+ * needed) and the `file` field is set to the current file path.
1187
+ * The message is added to the `messages` field on `file`.
1188
+ *
1189
+ * > 🪦 **Note**: also has obsolete signatures.
1190
+ *
1191
+ * @overload
1192
+ * @param {string} reason
1193
+ * @param {MessageOptions | null | undefined} [options]
1194
+ * @returns {VFileMessage}
1195
+ *
1196
+ * @overload
1197
+ * @param {string} reason
1198
+ * @param {Node | NodeLike | null | undefined} parent
1199
+ * @param {string | null | undefined} [origin]
1200
+ * @returns {VFileMessage}
1201
+ *
1202
+ * @overload
1203
+ * @param {string} reason
1204
+ * @param {Point | Position | null | undefined} place
1205
+ * @param {string | null | undefined} [origin]
1206
+ * @returns {VFileMessage}
1207
+ *
1208
+ * @overload
1209
+ * @param {string} reason
1210
+ * @param {string | null | undefined} [origin]
1211
+ * @returns {VFileMessage}
1212
+ *
1213
+ * @overload
1214
+ * @param {Error | VFileMessage} cause
1215
+ * @param {Node | NodeLike | null | undefined} parent
1216
+ * @param {string | null | undefined} [origin]
1217
+ * @returns {VFileMessage}
1218
+ *
1219
+ * @overload
1220
+ * @param {Error | VFileMessage} cause
1221
+ * @param {Point | Position | null | undefined} place
1222
+ * @param {string | null | undefined} [origin]
1223
+ * @returns {VFileMessage}
1224
+ *
1225
+ * @overload
1226
+ * @param {Error | VFileMessage} cause
1227
+ * @param {string | null | undefined} [origin]
1228
+ * @returns {VFileMessage}
1229
+ *
1230
+ * @param {Error | VFileMessage | string} causeOrReason
1231
+ * Reason for message, should use markdown.
1232
+ * @param {Node | NodeLike | MessageOptions | Point | Position | string | null | undefined} [optionsOrParentOrPlace]
1233
+ * Configuration (optional).
1234
+ * @param {string | null | undefined} [origin]
1235
+ * Place in code where the message originates (example:
1236
+ * `'my-package:my-rule'` or `'my-rule'`).
1237
+ * @returns {VFileMessage}
1238
+ * Message.
1239
+ */
1240
+ message(reason: string, options?: Options$4 | null | undefined): VFileMessage;
1241
+ /**
1242
+ * Create a message for `reason` associated with the file.
1243
+ *
1244
+ * The `fatal` field of the message is set to `false` (warning; change may be
1245
+ * needed) and the `file` field is set to the current file path.
1246
+ * The message is added to the `messages` field on `file`.
1247
+ *
1248
+ * > 🪦 **Note**: also has obsolete signatures.
1249
+ *
1250
+ * @overload
1251
+ * @param {string} reason
1252
+ * @param {MessageOptions | null | undefined} [options]
1253
+ * @returns {VFileMessage}
1254
+ *
1255
+ * @overload
1256
+ * @param {string} reason
1257
+ * @param {Node | NodeLike | null | undefined} parent
1258
+ * @param {string | null | undefined} [origin]
1259
+ * @returns {VFileMessage}
1260
+ *
1261
+ * @overload
1262
+ * @param {string} reason
1263
+ * @param {Point | Position | null | undefined} place
1264
+ * @param {string | null | undefined} [origin]
1265
+ * @returns {VFileMessage}
1266
+ *
1267
+ * @overload
1268
+ * @param {string} reason
1269
+ * @param {string | null | undefined} [origin]
1270
+ * @returns {VFileMessage}
1271
+ *
1272
+ * @overload
1273
+ * @param {Error | VFileMessage} cause
1274
+ * @param {Node | NodeLike | null | undefined} parent
1275
+ * @param {string | null | undefined} [origin]
1276
+ * @returns {VFileMessage}
1277
+ *
1278
+ * @overload
1279
+ * @param {Error | VFileMessage} cause
1280
+ * @param {Point | Position | null | undefined} place
1281
+ * @param {string | null | undefined} [origin]
1282
+ * @returns {VFileMessage}
1283
+ *
1284
+ * @overload
1285
+ * @param {Error | VFileMessage} cause
1286
+ * @param {string | null | undefined} [origin]
1287
+ * @returns {VFileMessage}
1288
+ *
1289
+ * @param {Error | VFileMessage | string} causeOrReason
1290
+ * Reason for message, should use markdown.
1291
+ * @param {Node | NodeLike | MessageOptions | Point | Position | string | null | undefined} [optionsOrParentOrPlace]
1292
+ * Configuration (optional).
1293
+ * @param {string | null | undefined} [origin]
1294
+ * Place in code where the message originates (example:
1295
+ * `'my-package:my-rule'` or `'my-rule'`).
1296
+ * @returns {VFileMessage}
1297
+ * Message.
1298
+ */
1299
+ message(reason: string, parent: Node$2 | NodeLike | null | undefined, origin?: string | null | undefined): VFileMessage;
1300
+ /**
1301
+ * Create a message for `reason` associated with the file.
1302
+ *
1303
+ * The `fatal` field of the message is set to `false` (warning; change may be
1304
+ * needed) and the `file` field is set to the current file path.
1305
+ * The message is added to the `messages` field on `file`.
1306
+ *
1307
+ * > 🪦 **Note**: also has obsolete signatures.
1308
+ *
1309
+ * @overload
1310
+ * @param {string} reason
1311
+ * @param {MessageOptions | null | undefined} [options]
1312
+ * @returns {VFileMessage}
1313
+ *
1314
+ * @overload
1315
+ * @param {string} reason
1316
+ * @param {Node | NodeLike | null | undefined} parent
1317
+ * @param {string | null | undefined} [origin]
1318
+ * @returns {VFileMessage}
1319
+ *
1320
+ * @overload
1321
+ * @param {string} reason
1322
+ * @param {Point | Position | null | undefined} place
1323
+ * @param {string | null | undefined} [origin]
1324
+ * @returns {VFileMessage}
1325
+ *
1326
+ * @overload
1327
+ * @param {string} reason
1328
+ * @param {string | null | undefined} [origin]
1329
+ * @returns {VFileMessage}
1330
+ *
1331
+ * @overload
1332
+ * @param {Error | VFileMessage} cause
1333
+ * @param {Node | NodeLike | null | undefined} parent
1334
+ * @param {string | null | undefined} [origin]
1335
+ * @returns {VFileMessage}
1336
+ *
1337
+ * @overload
1338
+ * @param {Error | VFileMessage} cause
1339
+ * @param {Point | Position | null | undefined} place
1340
+ * @param {string | null | undefined} [origin]
1341
+ * @returns {VFileMessage}
1342
+ *
1343
+ * @overload
1344
+ * @param {Error | VFileMessage} cause
1345
+ * @param {string | null | undefined} [origin]
1346
+ * @returns {VFileMessage}
1347
+ *
1348
+ * @param {Error | VFileMessage | string} causeOrReason
1349
+ * Reason for message, should use markdown.
1350
+ * @param {Node | NodeLike | MessageOptions | Point | Position | string | null | undefined} [optionsOrParentOrPlace]
1351
+ * Configuration (optional).
1352
+ * @param {string | null | undefined} [origin]
1353
+ * Place in code where the message originates (example:
1354
+ * `'my-package:my-rule'` or `'my-rule'`).
1355
+ * @returns {VFileMessage}
1356
+ * Message.
1357
+ */
1358
+ message(reason: string, place: Point$2 | Position$2 | null | undefined, origin?: string | null | undefined): VFileMessage;
1359
+ /**
1360
+ * Create a message for `reason` associated with the file.
1361
+ *
1362
+ * The `fatal` field of the message is set to `false` (warning; change may be
1363
+ * needed) and the `file` field is set to the current file path.
1364
+ * The message is added to the `messages` field on `file`.
1365
+ *
1366
+ * > 🪦 **Note**: also has obsolete signatures.
1367
+ *
1368
+ * @overload
1369
+ * @param {string} reason
1370
+ * @param {MessageOptions | null | undefined} [options]
1371
+ * @returns {VFileMessage}
1372
+ *
1373
+ * @overload
1374
+ * @param {string} reason
1375
+ * @param {Node | NodeLike | null | undefined} parent
1376
+ * @param {string | null | undefined} [origin]
1377
+ * @returns {VFileMessage}
1378
+ *
1379
+ * @overload
1380
+ * @param {string} reason
1381
+ * @param {Point | Position | null | undefined} place
1382
+ * @param {string | null | undefined} [origin]
1383
+ * @returns {VFileMessage}
1384
+ *
1385
+ * @overload
1386
+ * @param {string} reason
1387
+ * @param {string | null | undefined} [origin]
1388
+ * @returns {VFileMessage}
1389
+ *
1390
+ * @overload
1391
+ * @param {Error | VFileMessage} cause
1392
+ * @param {Node | NodeLike | null | undefined} parent
1393
+ * @param {string | null | undefined} [origin]
1394
+ * @returns {VFileMessage}
1395
+ *
1396
+ * @overload
1397
+ * @param {Error | VFileMessage} cause
1398
+ * @param {Point | Position | null | undefined} place
1399
+ * @param {string | null | undefined} [origin]
1400
+ * @returns {VFileMessage}
1401
+ *
1402
+ * @overload
1403
+ * @param {Error | VFileMessage} cause
1404
+ * @param {string | null | undefined} [origin]
1405
+ * @returns {VFileMessage}
1406
+ *
1407
+ * @param {Error | VFileMessage | string} causeOrReason
1408
+ * Reason for message, should use markdown.
1409
+ * @param {Node | NodeLike | MessageOptions | Point | Position | string | null | undefined} [optionsOrParentOrPlace]
1410
+ * Configuration (optional).
1411
+ * @param {string | null | undefined} [origin]
1412
+ * Place in code where the message originates (example:
1413
+ * `'my-package:my-rule'` or `'my-rule'`).
1414
+ * @returns {VFileMessage}
1415
+ * Message.
1416
+ */
1417
+ message(reason: string, origin?: string | null | undefined): VFileMessage;
1418
+ /**
1419
+ * Create a message for `reason` associated with the file.
1420
+ *
1421
+ * The `fatal` field of the message is set to `false` (warning; change may be
1422
+ * needed) and the `file` field is set to the current file path.
1423
+ * The message is added to the `messages` field on `file`.
1424
+ *
1425
+ * > 🪦 **Note**: also has obsolete signatures.
1426
+ *
1427
+ * @overload
1428
+ * @param {string} reason
1429
+ * @param {MessageOptions | null | undefined} [options]
1430
+ * @returns {VFileMessage}
1431
+ *
1432
+ * @overload
1433
+ * @param {string} reason
1434
+ * @param {Node | NodeLike | null | undefined} parent
1435
+ * @param {string | null | undefined} [origin]
1436
+ * @returns {VFileMessage}
1437
+ *
1438
+ * @overload
1439
+ * @param {string} reason
1440
+ * @param {Point | Position | null | undefined} place
1441
+ * @param {string | null | undefined} [origin]
1442
+ * @returns {VFileMessage}
1443
+ *
1444
+ * @overload
1445
+ * @param {string} reason
1446
+ * @param {string | null | undefined} [origin]
1447
+ * @returns {VFileMessage}
1448
+ *
1449
+ * @overload
1450
+ * @param {Error | VFileMessage} cause
1451
+ * @param {Node | NodeLike | null | undefined} parent
1452
+ * @param {string | null | undefined} [origin]
1453
+ * @returns {VFileMessage}
1454
+ *
1455
+ * @overload
1456
+ * @param {Error | VFileMessage} cause
1457
+ * @param {Point | Position | null | undefined} place
1458
+ * @param {string | null | undefined} [origin]
1459
+ * @returns {VFileMessage}
1460
+ *
1461
+ * @overload
1462
+ * @param {Error | VFileMessage} cause
1463
+ * @param {string | null | undefined} [origin]
1464
+ * @returns {VFileMessage}
1465
+ *
1466
+ * @param {Error | VFileMessage | string} causeOrReason
1467
+ * Reason for message, should use markdown.
1468
+ * @param {Node | NodeLike | MessageOptions | Point | Position | string | null | undefined} [optionsOrParentOrPlace]
1469
+ * Configuration (optional).
1470
+ * @param {string | null | undefined} [origin]
1471
+ * Place in code where the message originates (example:
1472
+ * `'my-package:my-rule'` or `'my-rule'`).
1473
+ * @returns {VFileMessage}
1474
+ * Message.
1475
+ */
1476
+ message(cause: Error | VFileMessage, parent: Node$2 | NodeLike | null | undefined, origin?: string | null | undefined): VFileMessage;
1477
+ /**
1478
+ * Create a message for `reason` associated with the file.
1479
+ *
1480
+ * The `fatal` field of the message is set to `false` (warning; change may be
1481
+ * needed) and the `file` field is set to the current file path.
1482
+ * The message is added to the `messages` field on `file`.
1483
+ *
1484
+ * > 🪦 **Note**: also has obsolete signatures.
1485
+ *
1486
+ * @overload
1487
+ * @param {string} reason
1488
+ * @param {MessageOptions | null | undefined} [options]
1489
+ * @returns {VFileMessage}
1490
+ *
1491
+ * @overload
1492
+ * @param {string} reason
1493
+ * @param {Node | NodeLike | null | undefined} parent
1494
+ * @param {string | null | undefined} [origin]
1495
+ * @returns {VFileMessage}
1496
+ *
1497
+ * @overload
1498
+ * @param {string} reason
1499
+ * @param {Point | Position | null | undefined} place
1500
+ * @param {string | null | undefined} [origin]
1501
+ * @returns {VFileMessage}
1502
+ *
1503
+ * @overload
1504
+ * @param {string} reason
1505
+ * @param {string | null | undefined} [origin]
1506
+ * @returns {VFileMessage}
1507
+ *
1508
+ * @overload
1509
+ * @param {Error | VFileMessage} cause
1510
+ * @param {Node | NodeLike | null | undefined} parent
1511
+ * @param {string | null | undefined} [origin]
1512
+ * @returns {VFileMessage}
1513
+ *
1514
+ * @overload
1515
+ * @param {Error | VFileMessage} cause
1516
+ * @param {Point | Position | null | undefined} place
1517
+ * @param {string | null | undefined} [origin]
1518
+ * @returns {VFileMessage}
1519
+ *
1520
+ * @overload
1521
+ * @param {Error | VFileMessage} cause
1522
+ * @param {string | null | undefined} [origin]
1523
+ * @returns {VFileMessage}
1524
+ *
1525
+ * @param {Error | VFileMessage | string} causeOrReason
1526
+ * Reason for message, should use markdown.
1527
+ * @param {Node | NodeLike | MessageOptions | Point | Position | string | null | undefined} [optionsOrParentOrPlace]
1528
+ * Configuration (optional).
1529
+ * @param {string | null | undefined} [origin]
1530
+ * Place in code where the message originates (example:
1531
+ * `'my-package:my-rule'` or `'my-rule'`).
1532
+ * @returns {VFileMessage}
1533
+ * Message.
1534
+ */
1535
+ message(cause: Error | VFileMessage, place: Point$2 | Position$2 | null | undefined, origin?: string | null | undefined): VFileMessage;
1536
+ /**
1537
+ * Create a message for `reason` associated with the file.
1538
+ *
1539
+ * The `fatal` field of the message is set to `false` (warning; change may be
1540
+ * needed) and the `file` field is set to the current file path.
1541
+ * The message is added to the `messages` field on `file`.
1542
+ *
1543
+ * > 🪦 **Note**: also has obsolete signatures.
1544
+ *
1545
+ * @overload
1546
+ * @param {string} reason
1547
+ * @param {MessageOptions | null | undefined} [options]
1548
+ * @returns {VFileMessage}
1549
+ *
1550
+ * @overload
1551
+ * @param {string} reason
1552
+ * @param {Node | NodeLike | null | undefined} parent
1553
+ * @param {string | null | undefined} [origin]
1554
+ * @returns {VFileMessage}
1555
+ *
1556
+ * @overload
1557
+ * @param {string} reason
1558
+ * @param {Point | Position | null | undefined} place
1559
+ * @param {string | null | undefined} [origin]
1560
+ * @returns {VFileMessage}
1561
+ *
1562
+ * @overload
1563
+ * @param {string} reason
1564
+ * @param {string | null | undefined} [origin]
1565
+ * @returns {VFileMessage}
1566
+ *
1567
+ * @overload
1568
+ * @param {Error | VFileMessage} cause
1569
+ * @param {Node | NodeLike | null | undefined} parent
1570
+ * @param {string | null | undefined} [origin]
1571
+ * @returns {VFileMessage}
1572
+ *
1573
+ * @overload
1574
+ * @param {Error | VFileMessage} cause
1575
+ * @param {Point | Position | null | undefined} place
1576
+ * @param {string | null | undefined} [origin]
1577
+ * @returns {VFileMessage}
1578
+ *
1579
+ * @overload
1580
+ * @param {Error | VFileMessage} cause
1581
+ * @param {string | null | undefined} [origin]
1582
+ * @returns {VFileMessage}
1583
+ *
1584
+ * @param {Error | VFileMessage | string} causeOrReason
1585
+ * Reason for message, should use markdown.
1586
+ * @param {Node | NodeLike | MessageOptions | Point | Position | string | null | undefined} [optionsOrParentOrPlace]
1587
+ * Configuration (optional).
1588
+ * @param {string | null | undefined} [origin]
1589
+ * Place in code where the message originates (example:
1590
+ * `'my-package:my-rule'` or `'my-rule'`).
1591
+ * @returns {VFileMessage}
1592
+ * Message.
1593
+ */
1594
+ message(cause: Error | VFileMessage, origin?: string | null | undefined): VFileMessage;
1595
+ /**
1596
+ * Serialize the file.
1597
+ *
1598
+ * > **Note**: which encodings are supported depends on the engine.
1599
+ * > For info on Node.js, see:
1600
+ * > <https://nodejs.org/api/util.html#whatwg-supported-encodings>.
1601
+ *
1602
+ * @param {string | null | undefined} [encoding='utf8']
1603
+ * Character encoding to understand `value` as when it’s a `Uint8Array`
1604
+ * (default: `'utf-8'`).
1605
+ * @returns {string}
1606
+ * Serialized file.
1607
+ */
1608
+ toString(encoding?: string | null | undefined): string;
1609
+ }
1610
+ type NodeLike = object & {
1611
+ type: string;
1612
+ position?: Position$2 | undefined;
1613
+ };
1614
+
1615
+ // See: <https://github.com/sindresorhus/type-fest/blob/main/source/empty-object.d.ts>
1616
+ declare const emptyObjectSymbol$2: unique symbol
1617
+
1618
+
1619
+ /**
1620
+ * Things that can be passed to the constructor.
1621
+ */
1622
+ type Compatible$2 = Options$3 | URL | VFile$1 | Value$1
1623
+
1624
+ /**
1625
+ * Raw source map.
1626
+ *
1627
+ * See:
1628
+ * <https://github.com/mozilla/source-map/blob/60adcb0/source-map.d.ts#L15-L23>.
1629
+ */
1630
+ interface Map$1 {
1631
+ /**
1632
+ * The generated file this source map is associated with.
1633
+ */
1634
+ file: string
1635
+ /**
1636
+ * A string of base64 VLQs which contain the actual mappings.
1637
+ */
1638
+ mappings: string
1639
+ /**
1640
+ * An array of identifiers which can be referenced by individual mappings.
1641
+ */
1642
+ names: Array<string>
1643
+ /**
1644
+ * An array of contents of the original source files.
1645
+ */
1646
+ sourcesContent?: Array<string> | undefined
1647
+ /**
1648
+ * The URL root from which all sources are relative.
1649
+ */
1650
+ sourceRoot?: string | undefined
1651
+ /**
1652
+ * An array of URLs to the original source files.
1653
+ */
1654
+ sources: Array<string>
1655
+ /**
1656
+ * Which version of the source map spec this map is following.
1657
+ */
1658
+ version: number
1659
+ }
1660
+
1661
+ /**
1662
+ * This map registers the type of the `data` key of a `VFile`.
1663
+ *
1664
+ * This type can be augmented to register custom `data` types.
1665
+ *
1666
+ * @example
1667
+ * declare module 'vfile' {
1668
+ * interface DataMap {
1669
+ * // `file.data.name` is typed as `string`
1670
+ * name: string
1671
+ * }
1672
+ * }
1673
+ */
1674
+ interface DataMap {
1675
+ [emptyObjectSymbol$2]?: never
1676
+ }
1677
+
1678
+ /**
1679
+ * Custom info.
1680
+ *
1681
+ * Known attributes can be added to {@linkcode DataMap}
1682
+ */
1683
+ type Data$3 = Record<string, unknown> & Partial<DataMap>
1684
+
1685
+ /**
1686
+ * Configuration.
1687
+ */
1688
+ interface Options$3 {
1689
+ /**
1690
+ * Arbitrary fields that will be shallow copied over to the new file.
1691
+ */
1692
+ [key: string]: unknown
1693
+ /**
1694
+ * Set `basename` (name).
1695
+ */
1696
+ basename?: string | null | undefined
1697
+ /**
1698
+ * Set `cwd` (working directory).
1699
+ */
1700
+ cwd?: string | null | undefined
1701
+ /**
1702
+ * Set `data` (associated info).
1703
+ */
1704
+ data?: Data$3 | null | undefined
1705
+ /**
1706
+ * Set `dirname` (path w/o basename).
1707
+ */
1708
+ dirname?: string | null | undefined
1709
+ /**
1710
+ * Set `extname` (extension with dot).
1711
+ */
1712
+ extname?: string | null | undefined
1713
+ /**
1714
+ * Set `history` (paths the file moved between).
1715
+ */
1716
+ history?: Array<string> | null | undefined
1717
+ /**
1718
+ * Set `path` (current path).
1719
+ */
1720
+ path?: URL | string | null | undefined
1721
+ /**
1722
+ * Set `stem` (name without extension).
1723
+ */
1724
+ stem?: string | null | undefined
1725
+ /**
1726
+ * Set `value` (the contents of the file).
1727
+ */
1728
+ value?: Value$1 | null | undefined
1729
+ }
566
1730
 
567
1731
  /**
568
1732
  * Contents of the file.
@@ -2310,7 +3474,7 @@ interface Raw$1 extends Literal {
2310
3474
  /**
2311
3475
  * Info associated with hast raw nodes by the ecosystem.
2312
3476
  */
2313
- interface RawData$1 extends Data$5 {}
3477
+ interface RawData$1 extends Data$4 {}
2314
3478
 
2315
3479
  // Register nodes in content.
2316
3480
  declare module 'hast' {
@@ -2379,7 +3543,7 @@ interface Raw extends Literal {
2379
3543
  /**
2380
3544
  * Info associated with hast raw nodes by the ecosystem.
2381
3545
  */
2382
- interface RawData extends Data$5 {}
3546
+ interface RawData extends Data$4 {}
2383
3547
 
2384
3548
  // Register nodes in content.
2385
3549
  declare module 'hast' {
@@ -2443,7 +3607,7 @@ type Options = Options$1;
2443
3607
  * ^^^
2444
3608
  * ```
2445
3609
  */
2446
- interface MdxJsxAttributeValueExpression$1 extends Node$3 {
3610
+ interface MdxJsxAttributeValueExpression$1 extends Node$2 {
2447
3611
  /**
2448
3612
  * Node type.
2449
3613
  */
@@ -2464,7 +3628,7 @@ interface MdxJsxAttributeValueExpression$1 extends Node$3 {
2464
3628
  * Info associated with mdast MDX JSX attribute value expression nodes by the
2465
3629
  * ecosystem.
2466
3630
  */
2467
- interface MdxJsxAttributeValueExpressionData$1 extends Data$7 {
3631
+ interface MdxJsxAttributeValueExpressionData$1 extends Data$6 {
2468
3632
  /**
2469
3633
  * Program node from estree.
2470
3634
  */
@@ -2479,7 +3643,7 @@ interface MdxJsxAttributeValueExpressionData$1 extends Data$7 {
2479
3643
  * ^^^^^^
2480
3644
  * ```
2481
3645
  */
2482
- interface MdxJsxExpressionAttribute$2 extends Node$3 {
3646
+ interface MdxJsxExpressionAttribute$2 extends Node$2 {
2483
3647
  /**
2484
3648
  * Node type.
2485
3649
  */
@@ -2500,7 +3664,7 @@ interface MdxJsxExpressionAttribute$2 extends Node$3 {
2500
3664
  * Info associated with mdast MDX JSX expression attribute nodes by the
2501
3665
  * ecosystem.
2502
3666
  */
2503
- interface MdxJsxExpressionAttributeData$1 extends Data$7 {
3667
+ interface MdxJsxExpressionAttributeData$1 extends Data$6 {
2504
3668
  /**
2505
3669
  * Program node from estree.
2506
3670
  */
@@ -2515,7 +3679,7 @@ interface MdxJsxExpressionAttributeData$1 extends Data$7 {
2515
3679
  * ^^^^^
2516
3680
  * ```
2517
3681
  */
2518
- interface MdxJsxAttribute$2 extends Node$3 {
3682
+ interface MdxJsxAttribute$2 extends Node$2 {
2519
3683
  /**
2520
3684
  * Node type.
2521
3685
  */
@@ -2538,7 +3702,7 @@ interface MdxJsxAttribute$2 extends Node$3 {
2538
3702
  * Info associated with mdast MDX JSX attribute nodes by the
2539
3703
  * ecosystem.
2540
3704
  */
2541
- interface MdxJsxAttributeData$1 extends Data$7 {}
3705
+ interface MdxJsxAttributeData$1 extends Data$6 {}
2542
3706
 
2543
3707
  /**
2544
3708
  * MDX JSX element node, occurring in flow (block).
@@ -2570,7 +3734,7 @@ interface MdxJsxFlowElement$1 extends Parent {
2570
3734
  * Info associated with mdast MDX JSX element (flow) nodes by the
2571
3735
  * ecosystem.
2572
3736
  */
2573
- interface MdxJsxFlowElementData$1 extends Data$6 {}
3737
+ interface MdxJsxFlowElementData$1 extends Data$5 {}
2574
3738
 
2575
3739
  /**
2576
3740
  * MDX JSX element node, occurring in text (phrasing).
@@ -2602,7 +3766,7 @@ interface MdxJsxTextElement$1 extends Parent {
2602
3766
  * Info associated with mdast MDX JSX element (text) nodes by the
2603
3767
  * ecosystem.
2604
3768
  */
2605
- interface MdxJsxTextElementData$1 extends Data$6 {}
3769
+ interface MdxJsxTextElementData$1 extends Data$5 {}
2606
3770
 
2607
3771
  /**
2608
3772
  * MDX JSX element node, occurring in flow (block), for hast.
@@ -2634,7 +3798,7 @@ interface MdxJsxFlowElementHast$1 extends Parent$1 {
2634
3798
  * Info associated with hast MDX JSX element (flow) nodes by the
2635
3799
  * ecosystem.
2636
3800
  */
2637
- interface MdxJsxFlowElementHastData$1 extends Data$5 {}
3801
+ interface MdxJsxFlowElementHastData$1 extends Data$4 {}
2638
3802
 
2639
3803
  /**
2640
3804
  * MDX JSX element node, occurring in text (phrasing), for hast.
@@ -2666,7 +3830,7 @@ interface MdxJsxTextElementHast$1 extends Parent$1 {
2666
3830
  * Info associated with hast MDX JSX element (text) nodes by the
2667
3831
  * ecosystem.
2668
3832
  */
2669
- interface MdxJsxTextElementHastData$1 extends Data$5 {}
3833
+ interface MdxJsxTextElementHastData$1 extends Data$4 {}
2670
3834
 
2671
3835
  // Add nodes to mdast content.
2672
3836
  declare module 'mdast' {
@@ -3761,7 +4925,7 @@ type Tag = {
3761
4925
  * ^^^
3762
4926
  * ```
3763
4927
  */
3764
- interface MdxJsxAttributeValueExpression extends Node$3 {
4928
+ interface MdxJsxAttributeValueExpression extends Node$2 {
3765
4929
  /**
3766
4930
  * Node type.
3767
4931
  */
@@ -3782,7 +4946,7 @@ interface MdxJsxAttributeValueExpression extends Node$3 {
3782
4946
  * Info associated with mdast MDX JSX attribute value expression nodes by the
3783
4947
  * ecosystem.
3784
4948
  */
3785
- interface MdxJsxAttributeValueExpressionData extends Data$7 {
4949
+ interface MdxJsxAttributeValueExpressionData extends Data$6 {
3786
4950
  /**
3787
4951
  * Program node from estree.
3788
4952
  */
@@ -3797,7 +4961,7 @@ interface MdxJsxAttributeValueExpressionData extends Data$7 {
3797
4961
  * ^^^^^^
3798
4962
  * ```
3799
4963
  */
3800
- interface MdxJsxExpressionAttribute extends Node$3 {
4964
+ interface MdxJsxExpressionAttribute extends Node$2 {
3801
4965
  /**
3802
4966
  * Node type.
3803
4967
  */
@@ -3818,7 +4982,7 @@ interface MdxJsxExpressionAttribute extends Node$3 {
3818
4982
  * Info associated with mdast MDX JSX expression attribute nodes by the
3819
4983
  * ecosystem.
3820
4984
  */
3821
- interface MdxJsxExpressionAttributeData extends Data$7 {
4985
+ interface MdxJsxExpressionAttributeData extends Data$6 {
3822
4986
  /**
3823
4987
  * Program node from estree.
3824
4988
  */
@@ -3833,7 +4997,7 @@ interface MdxJsxExpressionAttributeData extends Data$7 {
3833
4997
  * ^^^^^
3834
4998
  * ```
3835
4999
  */
3836
- interface MdxJsxAttribute extends Node$3 {
5000
+ interface MdxJsxAttribute extends Node$2 {
3837
5001
  /**
3838
5002
  * Node type.
3839
5003
  */
@@ -3856,7 +5020,7 @@ interface MdxJsxAttribute extends Node$3 {
3856
5020
  * Info associated with mdast MDX JSX attribute nodes by the
3857
5021
  * ecosystem.
3858
5022
  */
3859
- interface MdxJsxAttributeData extends Data$7 {}
5023
+ interface MdxJsxAttributeData extends Data$6 {}
3860
5024
 
3861
5025
  /**
3862
5026
  * MDX JSX element node, occurring in flow (block).
@@ -3888,7 +5052,7 @@ interface MdxJsxFlowElement extends Parent {
3888
5052
  * Info associated with mdast MDX JSX element (flow) nodes by the
3889
5053
  * ecosystem.
3890
5054
  */
3891
- interface MdxJsxFlowElementData extends Data$6 {}
5055
+ interface MdxJsxFlowElementData extends Data$5 {}
3892
5056
 
3893
5057
  /**
3894
5058
  * MDX JSX element node, occurring in text (phrasing).
@@ -3920,7 +5084,7 @@ interface MdxJsxTextElement extends Parent {
3920
5084
  * Info associated with mdast MDX JSX element (text) nodes by the
3921
5085
  * ecosystem.
3922
5086
  */
3923
- interface MdxJsxTextElementData extends Data$6 {}
5087
+ interface MdxJsxTextElementData extends Data$5 {}
3924
5088
 
3925
5089
  /**
3926
5090
  * MDX JSX element node, occurring in flow (block), for hast.
@@ -3952,7 +5116,7 @@ interface MdxJsxFlowElementHast extends Parent$1 {
3952
5116
  * Info associated with hast MDX JSX element (flow) nodes by the
3953
5117
  * ecosystem.
3954
5118
  */
3955
- interface MdxJsxFlowElementHastData extends Data$5 {}
5119
+ interface MdxJsxFlowElementHastData extends Data$4 {}
3956
5120
 
3957
5121
  /**
3958
5122
  * MDX JSX element node, occurring in text (phrasing), for hast.
@@ -3984,7 +5148,7 @@ interface MdxJsxTextElementHast extends Parent$1 {
3984
5148
  * Info associated with hast MDX JSX element (text) nodes by the
3985
5149
  * ecosystem.
3986
5150
  */
3987
- interface MdxJsxTextElementHastData extends Data$5 {}
5151
+ interface MdxJsxTextElementHastData extends Data$4 {}
3988
5152
 
3989
5153
  // Add nodes to mdast content.
3990
5154
  declare module 'mdast' {
@@ -4112,7 +5276,7 @@ interface MdxFlowExpression$1 extends Literal$1 {
4112
5276
  /**
4113
5277
  * Info associated with mdast MDX expression (flow) nodes by the ecosystem.
4114
5278
  */
4115
- interface MdxFlowExpressionData$1 extends Data$6 {
5279
+ interface MdxFlowExpressionData$1 extends Data$5 {
4116
5280
  /**
4117
5281
  * Program node from estree.
4118
5282
  */
@@ -4137,7 +5301,7 @@ interface MdxTextExpression$1 extends Literal$1 {
4137
5301
  /**
4138
5302
  * Info associated with mdast MDX expression (text) nodes by the ecosystem.
4139
5303
  */
4140
- interface MdxTextExpressionData$1 extends Data$6 {
5304
+ interface MdxTextExpressionData$1 extends Data$5 {
4141
5305
  /**
4142
5306
  * Program node from estree.
4143
5307
  */
@@ -4162,7 +5326,7 @@ interface MdxFlowExpressionHast$1 extends Literal {
4162
5326
  /**
4163
5327
  * Info associated with hast MDX expression (flow) nodes by the ecosystem.
4164
5328
  */
4165
- interface MdxFlowExpressionHastData$1 extends Data$5 {
5329
+ interface MdxFlowExpressionHastData$1 extends Data$4 {
4166
5330
  /**
4167
5331
  * Program node from estree.
4168
5332
  */
@@ -4187,7 +5351,7 @@ interface MdxTextExpressionHast$1 extends Literal {
4187
5351
  /**
4188
5352
  * Info associated with hast MDX expression (text) nodes by the ecosystem.
4189
5353
  */
4190
- interface MdxTextExpressionHastData$1 extends Data$5 {
5354
+ interface MdxTextExpressionHastData$1 extends Data$4 {
4191
5355
  /**
4192
5356
  * Program node from estree.
4193
5357
  */
@@ -4265,7 +5429,7 @@ interface MdxFlowExpression extends Literal$1 {
4265
5429
  /**
4266
5430
  * Info associated with mdast MDX expression (flow) nodes by the ecosystem.
4267
5431
  */
4268
- interface MdxFlowExpressionData extends Data$6 {
5432
+ interface MdxFlowExpressionData extends Data$5 {
4269
5433
  /**
4270
5434
  * Program node from estree.
4271
5435
  */
@@ -4290,7 +5454,7 @@ interface MdxTextExpression extends Literal$1 {
4290
5454
  /**
4291
5455
  * Info associated with mdast MDX expression (text) nodes by the ecosystem.
4292
5456
  */
4293
- interface MdxTextExpressionData extends Data$6 {
5457
+ interface MdxTextExpressionData extends Data$5 {
4294
5458
  /**
4295
5459
  * Program node from estree.
4296
5460
  */
@@ -4315,7 +5479,7 @@ interface MdxFlowExpressionHast extends Literal {
4315
5479
  /**
4316
5480
  * Info associated with hast MDX expression (flow) nodes by the ecosystem.
4317
5481
  */
4318
- interface MdxFlowExpressionHastData extends Data$5 {
5482
+ interface MdxFlowExpressionHastData extends Data$4 {
4319
5483
  /**
4320
5484
  * Program node from estree.
4321
5485
  */
@@ -4340,7 +5504,7 @@ interface MdxTextExpressionHast extends Literal {
4340
5504
  /**
4341
5505
  * Info associated with hast MDX expression (text) nodes by the ecosystem.
4342
5506
  */
4343
- interface MdxTextExpressionHastData extends Data$5 {
5507
+ interface MdxTextExpressionHastData extends Data$4 {
4344
5508
  /**
4345
5509
  * Program node from estree.
4346
5510
  */
@@ -4418,7 +5582,7 @@ interface MdxjsEsm$1 extends Literal$1 {
4418
5582
  /**
4419
5583
  * Info associated with mdast MDX.js ESM nodes by the ecosystem.
4420
5584
  */
4421
- interface MdxjsEsmData$1 extends Data$6 {
5585
+ interface MdxjsEsmData$1 extends Data$5 {
4422
5586
  /**
4423
5587
  * Program node from estree.
4424
5588
  */
@@ -4443,7 +5607,7 @@ interface MdxjsEsmHast$1 extends Literal {
4443
5607
  /**
4444
5608
  * Info associated with hast MDX.js ESM nodes by the ecosystem.
4445
5609
  */
4446
- interface MdxjsEsmHastData$1 extends Data$5 {
5610
+ interface MdxjsEsmHastData$1 extends Data$4 {
4447
5611
  /**
4448
5612
  * Program node from estree.
4449
5613
  */
@@ -4495,7 +5659,7 @@ interface MdxjsEsm extends Literal$1 {
4495
5659
  /**
4496
5660
  * Info associated with mdast MDX.js ESM nodes by the ecosystem.
4497
5661
  */
4498
- interface MdxjsEsmData extends Data$6 {
5662
+ interface MdxjsEsmData extends Data$5 {
4499
5663
  /**
4500
5664
  * Program node from estree.
4501
5665
  */
@@ -4520,7 +5684,7 @@ interface MdxjsEsmHast extends Literal {
4520
5684
  /**
4521
5685
  * Info associated with hast MDX.js ESM nodes by the ecosystem.
4522
5686
  */
4523
- interface MdxjsEsmHastData extends Data$5 {
5687
+ interface MdxjsEsmHastData extends Data$4 {
4524
5688
  /**
4525
5689
  * Program node from estree.
4526
5690
  */