vfile-statistics
![Chat](https://img.shields.io/badge/chat-spectrum-7b16ff.svg)
Count vfile messages per category (fatal, warn, info, nonfatal and total).
Install
npm:
npm install vfile-statistics
Use
var vfile = require('vfile')
var statistics = require('vfile-statistics')
var file = vfile({path: '~/example.md'})
file.message('This could be better')
file.message('That could be better')
try {
file.fail('This is terribly wrong')
} catch (err) {}
file.info('This is perfect')
console.log(statistics(file))
Yields:
{fatal: 1, nonfatal: 3, warn: 2, info: 1, total: 4}
API
statistics(file)
Pass a vfile, list of vfiles, or a list of messages (file.messages
), get
counts per category.
Returns
Object
:
fatal
: fatal errors (fatal: true
)warn
: warning messages (fatal: false
)info
: informational messages (fatal: null
or fatal: undefined
)nonfatal
: warning or info messagestotal
: all messages
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