Diffusion Open Access Compliance Check Tool (OACCT) (paginated-inlines) Browse

vfile-message
f646e1f695a7paginated-inlines

vfile-message

index.js
license
package.json
readme.md
types/

readme.md

vfile-message

[![Build][build-badge]][build] [![Coverage][coverage-badge]][coverage] [![Downloads][downloads-badge]][downloads] [![Size][size-badge]][size] [![Sponsors][sponsors-badge]][collective] [![Backers][backers-badge]][collective] [![Chat][chat-badge]][chat]

Create [vfile][] messages.

Install

[npm][]:

bash
npm install vfile-message

Use

js
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:

js
{ [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][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`

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][position]). Has start and end properties, both set to an object with line and column, set to number?.