JarCasting
JarCasting JarCasting

vfile-reporter

WebJar for vfile-reporter

License

License

MIT
GroupId

GroupId

org.webjars.npm
ArtifactId

ArtifactId

vfile-reporter
Last Version

Last Version

6.0.0
Release Date

Release Date
Type

Type

jar
Description

Description

vfile-reporter
WebJar for vfile-reporter
Project URL

Project URL

http://webjars.org
Source Code Management

Source Code Management

https://github.com/vfile/vfile-reporter

Download vfile-reporter

Filename Size
vfile-reporter-6.0.0.pom
vfile-reporter-6.0.0.jar 9 KB
vfile-reporter-6.0.0-sources.jar 22 bytes
vfile-reporter-6.0.0-javadoc.jar 22 bytes
Browse

How to add to project

<!-- https://jarcasting.com/artifacts/org.webjars.npm/vfile-reporter/ -->
<dependency>
    <groupId>org.webjars.npm</groupId>
    <artifactId>vfile-reporter</artifactId>
    <version>6.0.0</version>
</dependency>
// https://jarcasting.com/artifacts/org.webjars.npm/vfile-reporter/
implementation 'org.webjars.npm:vfile-reporter:6.0.0'
// https://jarcasting.com/artifacts/org.webjars.npm/vfile-reporter/
implementation ("org.webjars.npm:vfile-reporter:6.0.0")
'org.webjars.npm:vfile-reporter:jar:6.0.0'
<dependency org="org.webjars.npm" name="vfile-reporter" rev="6.0.0">
  <artifact name="vfile-reporter" type="jar" />
</dependency>
@Grapes(
@Grab(group='org.webjars.npm', module='vfile-reporter', version='6.0.0')
)
libraryDependencies += "org.webjars.npm" % "vfile-reporter" % "6.0.0"
[org.webjars.npm/vfile-reporter "6.0.0"]

Dependencies

compile (6)

Group / Artifact Type Version
org.webjars.npm : vfile-sort jar [2.1.2,3)
org.webjars.npm : unist-util-stringify-position jar [2.0.0,3)
org.webjars.npm : vfile-statistics jar [1.1.0,2)
org.webjars.npm : supports-color jar [6.0.0,7)
org.webjars.npm : repeat-string jar [1.5.0,2)
org.webjars.npm : string-width jar [4.0.0,5)

Project Modules

There are no modules declared in this project.

vfile-reporter

Build Coverage Downloads Sponsors Backers Chat

Create a report for a vfile.

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

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.

org.webjars.npm
Virtual file format for text processing used in @unifiedjs

Versions

Version
6.0.0
3.0.0