Skip to content

Format VFiles using a stylish reporter with position output and a summary line

License

Notifications You must be signed in to change notification settings

Hocdoc/vfile-reporter-position

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

19 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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

About

Format VFiles using a stylish reporter with position output and a summary line

Resources

License

Stars

Watchers

Forks

Packages

No packages published