README
vfile-reporter-pretty
Create a pretty report for a vfile.
Install
This package is ESM only:
Node 12+ is needed to use it and it must be import
ed instead of require
d.
npm:
npm install vfile-reporter-pretty
Use
import {VFile} from 'vfile'
import {reporterPretty} from 'vfile-reporter-pretty'
const file = new VFile({path: '~/example.md'})
file.message('`braavo` is misspelt; did you mean `bravo`?', {line: 1, column: 8})
file.info('This is perfect', {line: 2, column: 1})
try {
file.fail('This is horrible', {line: 3, column: 5})
} catch (error) {}
console.log(reporterPretty([file]))
API
This package exports the following identifiers: reporterPretty
.
That identifier is also the default export.
reporterPretty(files)
Create a report (string
) for the given files.
files
List of files (Array.<VFile>
).
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.