vfile-message
Create vfile messages.
Install
This package is ESM only: Node 12+ is needed to use it and it must be imported instead of required.
npm:
npm install vfile-message
Use
import {VFileMessage} from 'vfile-message'
var message = new VFileMessage(
'`braavo` is misspelt; did you mean `bravo`?',
{line: 1, column: 8},
'spell:typo'
)
console.log(message)
Yields:
[1:8: `braavo` is misspelt; did you mean `bravo`?] {
reason: '`braavo` is misspelt; did you mean `bravo`?',
line: 1,
column: 8,
source: 'spell',
ruleId: 'typo',
position: {start: {line: 1, column: 8}, end: {line: null, column: null}}
}
API
This package exports the following identifiers: VFileMessage. There is no default export.
VFileMessage(reason[, place][, origin])
Constructor of a message for reason at place 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.
place
Place at which the message occurred in a file (Node, Position, or Point, optional).
origin
Place in code the message originates from (string, optional).
Can either be the ruleId ('rule'), or a string with both a source and a ruleId delimited with a colon ('source:rule').
Extends
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?).
position
Full range information, when available (Position). Has start and end properties, both set to an object with line and column, set to number?.
source
Namespace of message (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.
file
You may add a file property with a path of a file (used throughout the VFile ecosystem).
note
You may add a note property with a long form description of the message (supported by vfile-reporter).
url
You may add a url property with a link to documentation for the message.
Contribute
See contributing.md in vfile/.github for ways to get started. See support.md for ways to get help.
This project has a code of conduct. By interacting with this repository, organization, or community you agree to abide by its terms.