vfile-message
!Buildbuild-badgebuild
!Coveragecoverage-badgecoverage
!Downloadsdownloads-badgedownloads
!Sizesize-badgesize
!Sponsorssponsors-badgecollective
!Backersbackers-badgecollective
!Chatchat-badgechatCreate vfile messages.
Contents
* [`VFileMessage(reason[, place][, origin])`](#vfilemessagereason-place-origin)
* [Well-known fields](#well-known-fields)
What is this?
This package provides a (lint) message format.When should I use this?
In most cases, you can usefile.message
from VFile
itself, but in some
cases you might not have a file, and still want to emit warnings or errors,
in which case this can be used directly.Install
This package is ESM onlyesm. In Node.js (version 14.14+, 16.0+), install with npm:npm install vfile-message
In Deno with
esm.sh
esmsh:import {VFileMessage} from 'https://esm.sh/vfile-message@3'
In browsers with
esm.sh
esmsh:<script type="module">
import {VFileMessage} from 'https://esm.sh/vfile-message@3?bundle'
</script>
Use
import {VFileMessage} from 'vfile-message'
const message = new VFileMessage(
'Unexpected unknown word `braavo`, did you mean `bravo`?',
{line: 1, column: 8},
'spell:typo'
)
console.log(message)
Yields:
[1:8: Unexpected unknown word `braavo`, did you mean `bravo`?] {
reason: 'Unexpected unknown word `braavo`, 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 identifierVFileMessage
.
There is no default export.VFileMessage(reason[, place][, origin])
Create a message for reason
at place
from origin
.
When an error is passed in as reason
, the stack
is copied.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
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
Whether this is a fatal problem that marks an associated file as no longer
processable (boolean?
).
If true
, marks associated file as no longer processable.
If false
, necessitates a (potential) change.
The value can also be null
or undefined
, for things that might not need
changing.line
Starting line of error (number?
).column
Starting column of error (number?
).position
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 message (string?
, example: 'my-package'
).ruleId
Category of message (string?
, example: 'my-rule-name'
).stack
Stack of message (string?
).file
Path of a file (used throughout the vfile ecosystem).Well-known fields
It’s OK to store custom data directly on theVFileMessage
, some of those are
handled by utilitiesutil.actual
Specify the source value that’s being reported, which is deemed incorrect
(string?
).expected
Suggest values that should be used instead of actual
, one or more values that
are deemed as acceptable ((string|Array<string>)?
)url
Link to documentation for the message (string
).note
Long form description of the message (supported by
vfile-reporter
reporter).Types
This package is fully typed with TypeScript. It exports no additional types.Compatibility
Projects maintained by the unified collective are compatible with all maintained versions of Node.js. As of now, that is Node.js 14.14+ and 16.0+. Our projects sometimes work with older versions, but this is not guaranteed.Contribute
Seecontributing.md
contributing in vfile/.github
health for ways to
get started.
See support.md
support for ways to get help.This project has a code of conductcoc. By interacting with this repository, organization, or community you agree to abide by its terms.