vfile-reporter

vfile utility to create a report.

Example screenshot of vfile-reporter

What is this?
When should I use this?
Install
Use
API
- reporter(files[, options])
- Options
Types
Compatibility
Security
Related
Contribute
License

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

vfile-reporter-json — create a JSON report
vfile-reporter-pretty — create a pretty report
vfile-reporter-junit — create a jUnit report
vfile-reporter-position — create a report with content excerpts

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.