unified

Project:vfile/vfile-message

Package:vfile-message@2.0.4

  1. Dependencies:2·Dependents:8
  2. vfile utility to create a virtual message
  1. 78%
  3. MIT
  4. 5
  1. 622 B
  2. CJS
  3. 16m
  1. util 105
  2. utility 105
  3. file 24
  4. virtual 21
  5. vfile 17
  6. vfile-util 16
  7. message 8

vfile-message

Build Coverage Downloads Size Sponsors Backers Chat

Create vfile messages.

Install

npm:

npm install vfile-message

Use

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:

{ [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, 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

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). 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 VMessage, 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.

License

MIT © Titus Wormer