vfile utility to create a virtual message
npm install vfile-message[![Build][badge-build-image]][badge-build-url]
[![Coverage][badge-coverage-image]][badge-coverage-url]
[![Downloads][badge-downloads-image]][badge-downloads-url]
[![Size][badge-size-image]][badge-size-url]
Create [vfile][github-vfile] messages.
* What is this?
* When should I use this?
* Install
* Use
* API
* [VFileMessage(reason[, options])](#vfilemessagereason-options)
* Options
* Well-known
* Compatibility
* Contribute
* License
This package provides a (lint) message format.
In most cases,
you can use file.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.
This package is [ESM only][github-gist-esm].
In Node.js (version 16+),
install with [npm][npmjs-install]:
``sh`
npm install vfile-message
In Deno with [esm.sh][esmsh]:
`js`
import {VFileMessage} from 'https://esm.sh/vfile-message@4'
In browsers with [esm.sh][esmsh]:
`html`
`js
import {VFileMessage} from 'vfile-message'
const message = new VFileMessage(
'Unexpected unknown word braavo, did you mean bravo?',
{place: {column: 8, line: 1}, ruleId: 'typo', source: 'spell'}
)
console.log(message)
`
Yields:
`textbraavo
[1:8: Unexpected unknown word , did you mean bravo?] {braavo
reason: 'Unexpected unknown word , did you mean bravo?',`
line: 1,
column: 8,
ancestors: undefined,
cause: undefined,
fatal: undefined,
place: {line: 1, column: 8},
ruleId: 'typo',
source: 'spell'
}
This package exports the identifier [VFileMessage][api-vfile-message].Options
There is no default export.
It exports the additional [TypeScript][] type [][api-options].
Create a message for reason.
> πͺ¦ Note: also has obsolete signatures.
###### Parameters
* reason (string)options
β reason for message (should use markdown)
* ([Options][api-options], optional)
β configuration.
###### Extends
[Error][developer-mozilla-error].
###### Returns
Instance of VFileMessage.
###### Fields
* ancestors ([Array][github-unist-node] or undefined)cause
β stack of (inclusive) ancestor nodes surrounding the message
* ([Error][developer-mozilla-error] or undefined)column
β original error cause of the message
* (number or undefined)fatal
β starting column of message
* (boolean or undefined)true
β state of problem; : error, file not usable; false: warning,undefined
change may be needed; : info, change likely not neededline
* (number or undefined)place
β starting line of message
* ([Point][github-unist-point], [Position][github-unist-position]undefined
or )reason
β place of message
* (string)ruleId
β reason for message (should use markdown)
* (string or undefined, example: 'my-rule')source
β category of message
* (string or undefined, example: 'my-package')
β namespace of message
Configuration (TypeScript type).
###### Fields
* ancestors ([Array][github-unist-node], optional)cause
β stack of (inclusive) ancestor nodes surrounding the message
* ([Error][developer-mozilla-error], optional)place
β original error cause of the message
* ([Point][github-unist-point] or [Position][github-unist-position],ruleId
optional)
β place of message
* (string, optional, example: 'my-rule')source
β category of message
* (string, optional, , example: 'my-package')
β namespace of who sent the message
Itβs OK to store custom data directly on the VFileMessage, some of those are
handled by [utilities][github-vfile-util].
The following fields are documented and typed here.
###### Fields
* actual (string, optional)expected
β specify the source value thatβs being reported, which is deemed incorrect
* (Array, optional)actual
β suggest acceptable values that can be used instead of url
* (string, optional)x
β link to docs for the message (this must be an absolute URL that can be
passed as to new URL(x))note
* (string, optional)
β long form description of the message (you should use markdown)
Projects maintained by the unified collective are compatible with maintained
versions of Node.js.
When we cut a new major release, we drop support for unmaintained versions of
Node.
This means we try to keep the current release line, vfile-message@^4,
compatible with Node.js 16.
See [contributing.md][health-contributing] in [vfile/.github][health]support.md`][health-support] for ways to get help.
for ways to get started.
See [
This project has a [code of conduct][health-coc].
By interacting with this repository,
organization,
or community you agree to abide by its terms.
[MIT][file-license] Β© [Titus Wormer][wooorm]
[api-options]: #options
[api-vfile-message]: #vfilemessagereason-options
[badge-build-image]: https://github.com/vfile/vfile-message/workflows/main/badge.svg
[badge-build-url]: https://github.com/vfile/vfile-message/actions
[badge-coverage-image]: https://img.shields.io/codecov/c/github/vfile/vfile-message.svg
[badge-coverage-url]: https://codecov.io/github/vfile/vfile-message
[badge-downloads-image]: https://img.shields.io/npm/dm/vfile-message.svg
[badge-downloads-url]: https://www.npmjs.com/package/vfile-message
[badge-size-image]: https://img.shields.io/bundlejs/size/vfile-message
[badge-size-url]: https://bundlejs.com/?q=vfile-message
[developer-mozilla-error]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error
[esmsh]: https://esm.sh
[file-license]: license
[github-gist-esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c
[github-unist-node]: https://github.com/syntax-tree/unist#node
[github-unist-point]: https://github.com/syntax-tree/unist#point
[github-unist-position]: https://github.com/syntax-tree/unist#position
[github-vfile]: https://github.com/vfile/vfile
[github-vfile-util]: https://github.com/vfile/vfile#utilities
[health]: https://github.com/vfile/.github
[health-coc]: https://github.com/vfile/.github/blob/main/code-of-conduct.md
[health-contributing]: https://github.com/vfile/.github/blob/main/contributing.md
[health-support]: https://github.com/vfile/.github/blob/main/support.md
[npmjs-install]: https://docs.npmjs.com/cli/install
[typescript]: https://www.typescriptlang.org
[wooorm]: https://wooorm.com