Installation

# Preserve existing imports with an npm alias
npm install vfile-message@npm:@stackline/vfile-message@1.0.0
# Or use the scoped package name in your imports
npm install @stackline/vfile-message@1.0.0

Node.js: See compatibility notes. Read the compatibility and maintenance notes before migrating.

Usage and API

The reference below may retain upstream package names. Use the alias installation above to run those imports with this Stackline release.

@stackline/vfile-message

Independent maintenance fork of vfile-message@3.1.4, preserving its API and published type declarations.

npm install @stackline/vfile-message
# Keep existing imports:
npm install vfile-message@npm:@stackline/vfile-message@1.0.0

Stackline · Issues · Community

See UPSTREAM.md for source identity and issue review, and CHANGELOG.md for maintenance changes. Functional tests also run against the final npm tarball; releases are published from GitHub Actions with provenance.

Upstream documentation

vfile-message

Create vfile messages.

Contents

• What is this?
• When should I use this?
• Install
• Use
• API
  • VFileMessage(reason[, place][, origin])
  • Well-known
• Types
• Compatibility
• Contribute
• License

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 14.14+ and 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>

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

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.

Parameters

• reason (string or Error) — reason for message, uses the stack and message of the error if given
• place (Node, Position, or Point, optional) — place in file where the message occurred
• origin (string, optional) — place in code where the message originates (example: 'my-package:my-rule' or 'my-rule')

Extends

Error.

Returns

Instance of VFileMessage.

Fields

• reason (string) — reason for message (you should use markdown)
• fatal (boolean | null | undefined) — state of problem; true marks associated file as no longer processable (error); false necessitates a (potential) change (warning); null | undefined for things that might not need changing (info)
• line (number | null) — starting line of error
• column (number | null) — starting column of error
• position (Position | null) — full unist position
• source (string | null, example: 'my-package') — namespace of message
• ruleId (string | null, example: 'my-rule') — category of message
• stack (string | null) — stack of message in code
• file (string | null) — path of a file (used throughout the VFile ecosystem)

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

• actual (string | null) — specify the source value that’s being reported, which is deemed incorrect
• expected (Array<string> | null) — suggest acceptable values that can be used instead of actual
• url (string | null) — link to docs for the message (this must be an absolute URL that can be passed as x to new URL(x))
• note (string | null) — long form description of the message (you should use markdown)

Types

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

Compatibility

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.

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

Upstream issues and maintenance review

Upstream and maintenance review

This package maintains vfile-message@3.1.4 under the independent @stackline/vfile-message name.

• Source: https://github.com/vfile/vfile-message/tree/a174d9fc7cdd7f4ce3d48ceeecb01a02e18ef691
• Public npm artifact integrity: sha512-fa0Z6P8HUrQN4BZaX05SIVXic+7kE3b05PWAtPuYP9QLHsLKYR7/AlLW3NtOrpXRLeawpDLMsVkmk5DG0NXgWw==.
• Upstream issue evidence checked: 2026-09-29T00:22:19.275343+00:00.
• Original license and author notices are retained.
• The upstream published runtime files and declarations are hash-checked in .stackline/upstream.json. Any runtime fix is explicitly listed there.
• Functional upstream suites run against the source and extracted final package. Development tools were reduced to those used by validation; full source and runtime audits must pass.
• Only direct dependencies of the original Stackline portfolio are in this migration. This is not a claim that all transitive projects are maintained by Stackline.

Issue triage

• https://github.com/vfile/vfile-message/issues/22: reproduced on 3.1.4 with both inherited read-only and getter-only Error.prototype.stack. Fixed by defining the own prototype default. Two isolated-process regressions preserve instance behavior and descriptor attributes.
• https://github.com/vfile/vfile-message/issues/13: adding a fixes property is a feature/API proposal; it is not introduced in this compatibility release.

The evidence query fetched the latest 100 open and 30 closed issue/PR entries and removed PRs. Closed entries were collected for context; this report does not claim an exhaustive historic review.

Release discipline

The source commit, passing CI and CodeQL, reviewed CI tarball hash, npm provenance, normal and aliased installs, and immutable GitHub release are checked before a release is complete. Published versions and tags are never replaced.

Release changes

Changelog

1.0.0

• Fix import failure when Error.prototype.stack is non-writable or getter-only, with isolated process regressions (upstream issue #22).
• Start Stackline maintenance of the documented upstream API.
• Preserve and verify published runtime files and TypeScript declarations.
• Run upstream functional suites against both source and the final package.
• Publish the reviewed CI artifact through GitHub Actions with provenance and immutable release evidence.

Release files and references

• README.md
• UPSTREAM.md
• CHANGELOG.md
• NOTICE
• Package and publication metadata
• Full text documentation

Package bytes, npm provenance and the immutable GitHub release were verified for this version. Security checks describe the reviewed release; documented compatibility risks and upstream reports are not blanket claims of resolution.