vfile-reporter
vfile utility to create a report for a file
Last updated 4 months ago by wooorm .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install vfile-reporter 
SYNC missed versions from official npm registry.

vfile-reporter

Build Coverage Downloads Sponsors Backers Chat

Create a report for a vfile.

Example screenshot of vfile-reporter

Features

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

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.

Related

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.

Current Tags

  • 6.0.1                                ...           latest (4 months ago)

19 Versions

  • 6.0.1                                ...           4 months ago
  • 6.0.0                                ...           a year ago
  • 5.1.2                                ...           a year ago
  • 5.1.1                                ...           2 years ago
  • 5.1.0                                ...           2 years ago
  • 5.0.0                                ...           2 years ago
  • 4.0.0                                ...           3 years ago
  • 3.1.0                                ...           3 years ago
  • 3.0.0                                ...           4 years ago
  • 2.1.0                                ...           4 years ago
  • 2.0.1                                ...           4 years ago
  • 2.0.0                                ...           4 years ago
  • 1.5.0                                ...           5 years ago
  • 1.4.1                                ...           5 years ago
  • 1.4.0                                ...           5 years ago
  • 1.3.0                                ...           5 years ago
  • 1.2.0                                ...           5 years ago
  • 1.1.0                                ...           5 years ago
  • 1.0.0                                ...           5 years ago
Maintainers (1)
Downloads
Today 150
This Week 807
This Month 1,434
Last Day 159
Last Week 1,010
Last Month 4,479
Dependencies (6)
Dev Dependencies (15)
Dependents (99)

Copyright 2014 - 2016 © taobao.org |