vfile-reporter-position

Format vfiles using a stylish reporter with position output and a summary line.

Usage no npm install needed!

<script type="module">
  import vfileReporterPosition from 'https://cdn.skypack.dev/vfile-reporter-position';
</script>

README

vfile-reporter-position

Format vfiles using a stylish reporter with position output and a summary line.

If the VFile has contents and a message will have a position then it will print the first erroneous line.

Example screenshot of vfile-reporter-position

This project was bootstrapped with TSDX.

Install

npm install vfile-reporter-position

Usage

See test/index.test.ts for the example from the screenshot.

API

reporter(files: VFile[]): string

Return a stylish report for the given VFile array.

Files without messages are ignored.

If there are no messages at all, it will return an empty string.

Inspired by

  • vfile-reporter: It offers more options but prints the position only as numbers.

TODO

  • Write tests
  • Add options

License

MIT © Bernhard Berger