vfile utility to create a report for a file
npm install vfile-reporter[![Build][build-badge]][build]
[![Coverage][coverage-badge]][coverage]
[![Downloads][downloads-badge]][downloads]
[![Size][size-badge]][size]
[![Sponsors][sponsors-badge]][collective]
[![Backers][backers-badge]][collective]
[![Chat][chat-badge]][chat]
[vfile][] utility to create a report.
![Example screenshot of vfile-reporter][screenshot]
* What is this?
* When should I use this?
* Install
* Use
* API
* [reporter(files[, options])](#reporterfiles-options)
* Options
* Example
* Types
* Compatibility
* Security
* Related
* Contribute
* License
This package create a textual report from files showing the warnings that
occurred while processing.
Many CLIs of tools that process files, whether linters (such as ESLint) or
bundlers (such as esbuild), have similar functionality.
You can use this package when you want to display a report about what occurred
while processing to a human.
There are [other reporters][reporters] that display information differently
listed in vfile.
This package is [ESM only][esm].
In Node.js (version 16+), install with [npm][]:
``sh`
npm install vfile-reporter
In Deno with [esm.sh][esmsh]:
`js`
import {reporter} from 'https://esm.sh/vfile-reporter@8'
In browsers with [esm.sh][esmsh]:
`html`
Say our module example.js looks as follows:
`js
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.js yields:
`txt
test/fixture/1.js
2:4 warning Warning!
test/fixture/2.js: no issues found
⚠ 1 warning
`
This package exports the identifier [reporter][api-reporter].default
That value is also the export.
Create a report from one or more files.
###### Parameters
* files ([Array][vfile] or VFile)options
— files to report
* ([Options][api-options], optional)
— configuration
###### Returns
Report (string).
Configuration (TypeScript type).
###### Fields
* color (boolean, default: true when in Node.js andfalse
[color is supported][supports-color], or )defaultName
— use ANSI colors in report
* (string, default: ')defaultName
— Label to use for files without file path; if one file and no verbose
is given, no name will show up in the report
* (boolean, default: false)quiet
— show message notes, URLs, and ancestor stack trace if available
* (boolean, default: false)silent
— do not show files without messages
* (boolean, default: false)quiet: true
— show errors only; this hides info and warning messages, and sets
traceLimit
* (number, default: 10)verbose: true
— max number of nodes to show in ancestors trace); ancestors can be shown
when
Here’s a small example that looks through a markdown AST for emphasis and
strong nodes, and checks whether they use *.
The message has detailed information which will be shown in verbose mode.
example.js:
`js
import {fromMarkdown} from 'mdast-util-from-markdown'
import {visitParents} from 'unist-util-visit-parents'
import {VFile} from 'vfile'
import {reporter} from 'vfile-reporter'
const file = new VFile({
path: new URL('example.md', import.meta.url),
value: '# hi, _world_!'
})
const value = String(file)
const tree = fromMarkdown(value)
visitParents(tree, (node, parents) => {
if (node.type === 'emphasis' || node.type === 'strong') {
const start = node.position?.start.offset
if (start !== undefined && value.charAt(start) === '_') {
const m = file.message('Expected * (asterisk), not _ (underscore)', {It is recommended to use asterisks for emphasis/strong attention when
ancestors: [...parents, node],
place: node.position,
ruleId: 'attention-marker',
source: 'some-lint-example'
})
m.note =
writing markdown.
There are some small differences in whether sequences can open and/or close…
m.url = 'https://example.com/whatever'
}
}
})
console.error(reporter([file], {verbose: false}))
`
…running node example.js yields:
`txt*
/Users/tilde/Projects/oss/vfile-reporter/example.md
1:9-1:16 warning Expected (asterisk), not _ (underscore) attention-marker some-lint-example
⚠ 1 warning
`
To show the info, pass verbose: true to reporter, and run again:
and see:
`txt*
/Users/tilde/Projects/oss/vfile-reporter/example.md
1:9-1:16 warning Expected (asterisk), not _ (underscore) attention-marker some-lint-example
[url]:
https://example.com/whatever
[note]:
It is recommended to use asterisks for emphasis/strong attention when
writing markdown.
There are some small differences in whether sequences can open and/or close…
[trace]:
at emphasis (1:9-1:16)
at heading (1:1-1:17)
at root (1:1-1:17)
⚠ 1 warning
`
This package is fully typed with [TypeScript][].
It exports the additional type [Options][api-options].
Projects maintained by the unified collective are compatible with maintained
versions of Node.js.
When we cut a new major release, we drop support for unmaintained versions of
Node.
This means we try to keep the current release line, vfile-reporter@^8,
compatible with Node.js 16.
Use of vfile-reporter is safe.
* vfile-reporter-json
— create a JSON report
* vfile-reporter-pretty
— create a pretty report
* vfile-reporter-junit
— create a jUnit report
* vfile-reporter-position
— create a report with content excerpts
See [contributing.md][contributing] in [vfile/.github][health] for ways tosupport.md`][support] for ways to get help.
get started.
See [
This project has a [code of conduct][coc].
By interacting with this repository, organisation, or community you agree to
abide by its terms.
[MIT][license] © [Titus Wormer][author]
[build-badge]: https://github.com/vfile/vfile-reporter/workflows/main/badge.svg
[build]: https://github.com/vfile/vfile-reporter/actions
[coverage-badge]: https://img.shields.io/codecov/c/github/vfile/vfile-reporter.svg
[coverage]: https://codecov.io/github/vfile/vfile-reporter
[downloads-badge]: https://img.shields.io/npm/dm/vfile-reporter.svg
[downloads]: https://www.npmjs.com/package/vfile-reporter
[size-badge]: https://img.shields.io/badge/dynamic/json?label=minzipped%20size&query=$.size.compressedSize&url=https://deno.bundlejs.com/?q=vfile-reporter
[size]: https://bundlejs.com/?q=vfile-reporter
[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg
[backers-badge]: https://opencollective.com/unified/backers/badge.svg
[collective]: https://opencollective.com/unified
[chat-badge]: https://img.shields.io/badge/chat-discussions-success.svg
[chat]: https://github.com/vfile/vfile/discussions
[npm]: https://docs.npmjs.com/cli/install
[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c
[esmsh]: https://esm.sh
[typescript]: https://www.typescriptlang.org
[contributing]: https://github.com/vfile/.github/blob/main/contributing.md
[support]: https://github.com/vfile/.github/blob/main/support.md
[health]: https://github.com/vfile/.github
[coc]: https://github.com/vfile/.github/blob/main/code-of-conduct.md
[license]: license
[author]: https://wooorm.com
[vfile]: https://github.com/vfile/vfile
[reporters]: https://github.com/vfile/vfile#reporters
[supports-color]: https://github.com/chalk/supports-color
[screenshot]: screenshot.png
[api-reporter]: #reporterfiles-options
[api-options]: #options