Security News
The Dark Side of Open Source
At Node Congress, Socket CEO Feross Aboukhadijeh uncovers the darker aspects of open source, where applications that rely heavily on third-party dependencies can be exploited in supply chain attacks.
vfile-message
Advanced tools
Package description
The vfile-message npm package is designed for creating and managing virtual file messages, such as warnings and errors, in a standardized format. It is commonly used in file processing pipelines to report issues found during the processing of files. These messages can include details such as the position of the issue within the file, the rule that was violated, and a human-readable message describing the problem.
Creating a new message
This code demonstrates how to create a new vfile message. The message includes a human-readable string, a position object indicating where in the file the message applies, and an optional error code.
{"const VFileMessage = require('vfile-message');\nconst message = new VFileMessage('This is an error message', {line: 10, column: 5}, 'error-code');\nconsole.log(message);"}
Associating a message with a file
This example shows how to create a vfile message and associate it with a vfile. The message is pushed into the file's `messages` array, allowing multiple messages to be associated with a single file.
{"const vfile = require('vfile');\nconst VFileMessage = require('vfile-message');\nconst file = vfile();\nconst error = new VFileMessage('Invalid syntax', {line: 2, column: 10}, 'syntax-error');\nfile.messages.push(error);\nconsole.log(file.messages);"}
ESLint is a tool for identifying and reporting on patterns found in ECMAScript/JavaScript code, making it somewhat similar to vfile-message in its ability to report errors and warnings. However, ESLint is more focused on linting JavaScript code according to customizable coding standards, whereas vfile-message is more generic and can be used with any type of file.
Chalk is a package for styling terminal text. While not directly similar to vfile-message in functionality, it is often used alongside vfile-message and other reporting tools to colorize messages (errors, warnings) for better visibility in the console. Chalk does not create or manage messages but enhances the presentation of messages created by packages like vfile-message.
Remark-lint is a markdown code style linter that is part of the unified.js ecosystem, similar to vfile-message which is also often used in the unified ecosystem for handling messages. Remark-lint focuses specifically on linting Markdown files according to a set of rules, generating messages (warnings, errors) similar to those created by vfile-message, but with a focus on Markdown content.
Readme
Create vfile messages.
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. In Node.js (version 14.14+, 16.0+), 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>
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}}
}
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.
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
,
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'
).
An instance of itself.
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
).
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).
It’s OK to store custom data directly on the VFileMessage
, some of those are
handled by utilities.
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
).
This package is fully typed with TypeScript. It exports no additional types.
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.
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.
FAQs
vfile utility to create a virtual message
The npm package vfile-message receives a total of 8,895,749 weekly downloads. As such, vfile-message popularity was classified as popular.
We found that vfile-message demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
At Node Congress, Socket CEO Feross Aboukhadijeh uncovers the darker aspects of open source, where applications that rely heavily on third-party dependencies can be exploited in supply chain attacks.
Research
Security News
The Socket Research team found this npm package includes code for collecting sensitive developer information, including your operating system username, Git username, and Git email.
Security News
OpenJS is warning of social engineering takeovers targeting open source projects after receiving a credible attempt on the foundation.