Project: vfile/vfile-reporter

Package: vfile-reporter@7.0.2

  1. Dependents: 94
  2. vfile utility to create a report for a file
  1. util 143
  2. utility 139
  3. file 34
  4. virtual 19
  5. vfile 17
  6. vfile-util 15
  7. message 8
  8. vfile-reporter 4
  9. reporter 4
  10. formatter 3
  11. format 3
  12. report 2
  13. warning 2
  14. error 2


Build Coverage Downloads Sponsors Backers Chat

Create a report for a vfile.

Example screenshot of vfile-reporter



This package is ESM only: Node 12+ is needed to use it and it must be imported instead of required.


npm install vfile-reporter


Say example.js contains:

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 yields:

  2:4  warning  Warning!

test/fixture/2.js: no issues found

⚠ 1 warning


This package exports the following identifiers: reporter. That identifier is also the default export.

reporter(files[, options])

Generate a stylish report from the given vfile, Array.<VFile>, or Error.


Output long form descriptions of messages, if applicable (boolean, default: false).


Do not output anything for a file which has no warnings or errors (boolean, default: false). The default behavior is to show a success message.


Do not output messages without fatal set to true (boolean, default: false). Also sets quiet to true.


Whether to use color (boolean, default: depends). The default behavior is the check if color is supported.


Label to use for files without file-path (string, default: '<stdin>'). If one file and no defaultName is given, no name will show up in the report.


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.


MIT © Titus Wormer

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