JavaScript
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.editorconfig
.gitignore
.npmrc
.prettierignore
.travis.yml
LICENSE
index.js
package.json
readme.md
screenshot.png
test.js

readme.md

vfile-reporter Build Status Coverage Status

Format vfiles using a stylish reporter.

Example screenshot of vfile-reporter

Features

  • Ranges (3:2 and 3:2-3:6)
  • Stack-traces to show where awful stuff occurs
  • Successful files (configurable)
  • All of VFile’s awesomeness

Installation

npm:

npm install vfile-reporter

Usage

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

Do not output anything for a file which has no warnings or errors (boolean, default: false). The default behaviour 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 colour (boolean, default: depends). The default behaviour is the check if colour 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.

Related

Contribute

See contributing.md in vfile/vfile for ways to get started.

This organisation 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 ESLint’s stylish reporter (originally created by Sindre Sorhus), which is Copyright (c) 2013 Nicholas C. Zakas, and licensed under MIT.