unified

Project: vfile/vfile-message

Package: vfile-message@3.1.3

  1. Dependents: 0
  2. vfile utility to create a virtual message
  1. util 146
  2. utility 142
  3. file 34
  4. virtual 18
  5. vfile 17
  6. vfile-util 15
  7. message 8

vfile-message

Build Coverage Downloads Size Sponsors Backers Chat

Create vfile messages.

Contents

What is this?

This package provides a (lint) message format.

When should I use this?

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.

Install

This package is ESM only. In Node.js (version 16+), install with npm:

npm install vfile-message

In Deno with esm.sh:

import {VFileMessage} from 'https://esm.sh/vfile-message@3'

In browsers with esm.sh:

<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: undefined, column: undefined}}
}

API

This package exports the identifier VFileMessage. 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.

Signatures
Parameters
Extends

Error.

Returns

Instance of VFileMessage.

Fields

Well-known

It’s OK to store custom data directly on the VFileMessage, some of those are handled by utilities. The following fields are documented and typed here.

Fields

Types

This package is fully typed with TypeScript. It exports no additional types.

Compatibility

Projects maintained by the unified collective are compatible with maintained versions of Node.js (as of June 2023, that is Node.js 16+).

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@^3, compatible with Node.js 12.

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.

License

MIT © Titus Wormer