unified

Project: vfile/vfile-reporter

Package: vfile-reporter@6.0.1

  1. Dependencies: 6·Dependents: 72
  2. vfile utility to create a report for a file
  1. util 107
  2. utility 105
  3. file 31
  4. virtual 21
  5. vfile 18
  6. vfile-util 16
  7. message 8
  8. vfile-reporter 5
  9. reporter 5
  10. formatter 4
  11. report 3
  12. format 3
  13. warning 2
  14. error 2

vfile-reporter

Build Coverage Downloads Sponsors Backers Chat

Create a report for a vfile.

Example screenshot of **vfile-reporter**

Features

Install

npm:

npm install vfile-reporter

Use

Say example.js contains:

var vfile = require('vfile')
var reporter = require('vfile-reporter')

var one = vfile({path: 'test/fixture/1.js'})
var two = vfile({path: 'test/fixture/2.js'})

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

console.error(reporter([one, two]))

Now, running node example yields:

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

test/fixture/2.js: no issues found

⚠ 1 warning

API

reporter(files[, options])

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

options
options.verbose

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

options.quiet

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.

options.silent

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

options.color

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

options.defaultName

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.

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

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