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
|
# vfile-message [![Build Status][travis-badge]][travis] [![Coverage Status][codecov-badge]][codecov]
Create [vfile][] messages.
## Installation
[npm][]:
```bash
npm install vfile-message
```
## Usage
```js
var VMessage = require('vfile-message');
var message = new VMessage('`braavo` is misspelt; did you mean `bravo`?', {line: 1, column: 8}, 'spell:typo');
console.log(message);
```
Yields:
```js
{ [1:8: `braavo` is misspelt; did you mean `bravo`?]
reason: '`braavo` is misspelt; did you mean `bravo`?',
fatal: null,
line: 1,
column: 8,
location:
{ start: { line: 1, column: 8 },
end: { line: null, column: null } },
source: 'spell',
ruleId: 'typo' }
```
## API
### `VMessage(reason[, position][, origin])`
Constructor of a message for `reason` at `position` from `origin`. When
an error is passed in as `reason`, copies the stack.
##### Parameters
###### `reason`
Reason for message (`string` or `Error`). Uses the stack and message of the
error if given.
###### `position`
Place at which the message occurred in a file ([`Node`][node],
[`Position`][position], or [`Point`][point], optional).
###### `origin`
Place in code the message originates from (`string`, optional).
Can either be the [`ruleId`][ruleid] (`'rule'`), or a string with both a
[`source`][source] and a [`ruleId`][ruleid] delimited with a colon
(`'source:rule'`).
##### Extends
[`Error`][error].
##### Returns
An instance of itself.
##### Properties
###### `reason`
Reason for message (`string`).
###### `fatal`
If `true`, marks associated file as no longer processable (`boolean?`). If
`false`, necessitates a (potential) change. The value can also be `null` or
`undefined`.
###### `line`
Starting line of error (`number?`).
###### `column`
Starting column of error (`number?`).
###### `location`
Full range information, when available ([`Position`][position]). Has `start`
and `end` properties, both set to an object with `line` and `column`, set to
`number?`.
###### `source`
Namespace of warning (`string?`).
###### `ruleId`
Category of message (`string?`).
###### `stack`
Stack of message (`string?`).
##### Custom properties
It’s OK to store custom data directly on the `VFileMessage`, some of those are
handled by [utilities][util].
###### `file`
You may add a `file` property with a path of a file (used throughout the
[**VFile**][vfile] ecosystem).
###### `note`
You may add a `note` property with a long form description of the message
(supported by [`vfile-reporter`][reporter]).
###### `url`
You may add a `url` property with a link to documentation for the message.
## License
[MIT][license] © [Titus Wormer][author]
<!-- Definitions -->
[travis-badge]: https://img.shields.io/travis/vfile/vfile-message.svg
[travis]: https://travis-ci.org/vfile/vfile-message
[codecov-badge]: https://img.shields.io/codecov/c/github/vfile/vfile-message.svg
[codecov]: https://codecov.io/github/vfile/vfile-message
[npm]: https://docs.npmjs.com/cli/install
[license]: LICENSE
[author]: http://wooorm.com
[error]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error
[node]: https://github.com/syntax-tree/unist#node
[position]: https://github.com/syntax-tree/unist#position
[point]: https://github.com/syntax-tree/unist#point
[vfile]: https://github.com/vfile/vfile
[util]: https://github.com/vfile/vfile#utilities
[reporter]: https://github.com/vfile/vfile-reporter
[ruleid]: #ruleid
[source]: #source
|
