Skip to documentation
ALEXANDRONET

package

@stackline/vfile-reporter 1.0.2 — installation and API

vfile utility to create a report for a file

Install @stackline/vfile-reporter

npm install @stackline/[email protected]

Package version: 1.0.2. Metadata verified: 2026-11-12. This is separate from the framework version and demonstration runtime.

Node.js requirement
{}
Accepted peer dependencies (declared ranges)
{}

Tested environments are described in the versioned README and linked source checks. A declared peer range is not evidence that every version in it was tested.

Versioned reference

This reference comes from the published @stackline/[email protected] README. Its upstream attribution and license remain with the source. Benchmark and security statements describe the cited tests and advisories, not a guarantee for every application.

@stackline/vfile-reporter

vfile utility to create a report for a file.

Documentation | npm | Issues | Repository

Current package version: 1.0.2

Why this package?

@stackline/vfile-reporter is the Stackline-maintained distribution of [email protected]. It is an independent continuation of vfile-reporter; original authors and licenses remain credited below.

Compatibility

Item Value
Package @stackline/[email protected]
API target [email protected]
Supported Node.js See supported framework requirements
License MIT
Module type module
Main entry index.js
Types index.d.ts
Runtime dependencies vfile, vfile-sort, string-width, vfile-message, supports-color, vfile-statistics, @types/supports-color, unist-util-stringify-position

Installation

npm install @stackline/vfile-reporter

Preserve existing imports and plugin resolution with an npm alias:

npm install vfile-reporter@npm:@stackline/vfile-reporter

Usage and API reference

vfile-reporter

vfile utility to create a report.

Contents

What is this?

This package create a textual report from a file showing the warnings that occurred while processing. Many CLIs of tools that process files, whether linters (such as ESLint) or bundlers (such as esbuild), have similar functionality.

When should I use this?

You can use this package whenever you want to display a report about what occurred while processing to a human.

There are other reporters that display information differently listed in vfile.

Install

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

npm install @stackline/vfile-reporter

In Deno with esm.sh:

import {reporter} from 'https://esm.sh/vfile-reporter@7'

In browsers with esm.sh:

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

Use

Say our module example.js looks as follows:

import {VFile} from 'vfile'
import {reporter} from '@stackline/vfile-reporter'

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.error(reporter([one, two]))

…now running node example.js yields:

test/fixture/1.js
  2:4  warning  Warning!

test/fixture/2.js: no issues found

⚠ 1 warning

API

This package exports the identifier reporter. That value is also the default export.

reporter(files[, options])

Create a report from an error, one file, or multiple files.

Parameters
  • files (VFile, Array<VFile>, or Error) — files or error to report
  • options (Options, optional) — configuration
Returns

Report (string).

Options

Configuration (TypeScript type).

Fields
  • color (boolean, default: depends) — use ANSI colors in report, the default behavior in Node.js is the check if color is supported
  • verbose (boolean, default: false) — show message notes, notes are optional, additional, long descriptions
  • quiet (boolean, default: false) — do not show files without messages
  • silent (boolean, default: false) — show errors only, this hides info and warning messages, and sets quiet: true
  • defaultName (string, default: '<stdin>'). — label to use for files without file path, if one file and no defaultName is given, no name will show up in the report

Types

This package is fully typed with TypeScript. It exports the additional type 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.

Security

Use of vfile-reporter is safe.

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, organisation, or community you agree to abide by its terms.

License

MIT © Titus Wormer

Forked from ESLints stylish reporter (originally created by Sindre Sorhus), which is Copyright (c) 2013 Nicholas C. Zakas, and licensed under MIT.

Credits and original authors

Original copyright, license notices and contributor acknowledgements remain part of this distribution. Stackline maintenance does not replace authorship of the original work.

Use this repository's issue tracker for reproducible bugs and feature requests. Join r/Stackline for examples, usage questions and release discussions.