Installation

# Preserve existing imports with an npm alias
npm install vfile-reporter-json@npm:@stackline/vfile-reporter-json@1.0.0
# Or use the scoped package name in your imports
npm install @stackline/vfile-reporter-json@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-reporter-json

Independent maintenance fork of vfile-reporter-json@3.3.0, preserving its API and published type declarations.

npm install @stackline/vfile-reporter-json
# Keep existing imports:
npm install vfile-reporter-json@npm:@stackline/vfile-reporter-json@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-reporter-json

vfile utility to create a report in machine readable JSON.

Contents

• What is this?
• When should I use this?
• Install
• Use
• API
  • reporterJson(files[, options])
  • JsonFile
  • JsonMessage
  • Options
• Types
• Compatibility
• Contribute
• License

What is this?

This package is like vfile-reporter but it outputs machine readable JSON.

When should I use this?

You can use this when you need to serialize lint results for machines, use vfile-reporter itself for humans.

Install

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

npm install vfile-reporter-json

In Deno with esm.sh:

import {reporterJson} from 'https://esm.sh/vfile-reporter-json@3'

In browsers with esm.sh:

<script type="module">
  import {reporterJson} from 'https://esm.sh/vfile-reporter-json@3?bundle'
</script>

Use

import {VFile} from 'vfile'
import {reporterJson} from 'vfile-reporter-json'

const one = new VFile({path: 'test/fixture/1.js'})
const two = new VFile({path: 'test/fixture/2.js'})

one.message('Warning!', {line: 2, column: 4})

console.log(reporterJson([one, two]))

Yields:

[{"path":"test/fixture/1.js","cwd":"/Users/tilde/projects/oss/vfile-reporter-json","history":["test/fixture/1.js"],"messages":[{"reason":"Warning!","line":2,"column":4,"position":{"start":{"line":2,"column":4},"end":{"line":null,"column":null}},"ruleId":null,"source":null,"fatal":false,"stack":null}]},{"path":"test/fixture/2.js","cwd":"/Users/tilde/projects/oss/vfile-reporter-json","history":["test/fixture/2.js"],"messages":[]}]

API

This package exports the identifier reporterJson. That identifier is also the default export.

reporterJson(files[, options])

Create a serialized JSON report from one file or multiple files.

Parameters

• files (VFile or Array<VFile>) — file or files to report
• options (Options, optional) — configuration

Returns

Report as serialized JSON (string).

Reporters must return strings, which is why serialized JSON is exposed. You can parse the result with JSON.parse, in which case you will get Array<JsonFile>.

JsonFile

JSON file (TypeScript type).

Fields

• path (string) — full path (example: '~/index.min.js')
• cwd (string) — base of path
• history (Array<string>) — list of filepaths the file moved between; the first is the original path and the last is the current path
• messages (Array<JsonMessage>) — list of filepaths the file moved between; the first is the original path and the last is the current path

JsonMessage

JSON message (TypeScript type).

Fields

• stack (string | null) — stack of message; this is used by normal errors to show where something happened in programming code
• 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) — namespace of message (example: 'my-package')
• ruleId (string | null) — category of message (example: 'my-rule')
• actual (string | null | undefined) — specify the source value that’s being reported, which is deemed incorrect
• expected (Array<string> | null | undefined) — suggest acceptable values that can be used instead of actual
• url (string | null | undefined) — 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 | undefined) — long form description of the message (should use markdown)

Options

Configuration (TypeScript type).

Fields

• pretty (number | string | boolean, default: 0) — value of space of JSON.stringify(x, undefined, space)
• quiet (boolean, default: false) — do not show files without messages
• silent (boolean, default: false) — show errors only; this does not show info and warning messages; also sets quiet to true

Types

This package is fully typed with TypeScript. It exports the additional types JsonFile, JsonMessage, and Options.

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-reporter-json@3.3.0 under the independent @stackline/vfile-reporter-json name.

• Source: https://github.com/vfile/vfile-reporter-json/tree/7d6a4563f7dad46e427225dcb83fc7280cb3e427
• Public npm artifact integrity: sha512-/zgRtjxQ2UGJn+HViiZ7+nIXtUzkkXFQum3BmaS/bSyr10P0X41ETRqqwMJ95RtbKUah3m7pKb6oS1eZeXXHzQ==.
• Upstream issue evidence checked: 2026-09-29T00:22:19.778209+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

The queried open-issue list contained no issue entries. This does not establish that the upstream is abandoned or bug-free. No runtime bug fix is claimed for this initial maintenance 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

• 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.