vfile-statistics
!Buildbuild-badgebuild
!Coveragecoverage-badgecoverage
!Downloadsdownloads-badgedownloads
!Sizesize-badgesize
!Sponsorssponsors-badgecollective
!Backersbackers-badgecollective
!Chatchat-badgechatCount vfile messages per category (fatal, warn, info, nonfatal and total).
Install
This package is ESM only: Node 12+ is needed to use it and it must beimport
ed instead of require
d.npm install vfile-statistics
## Use
```js
import {VFile} from 'vfile'
import {statistics} from 'vfile-statistics'
var file = new 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
This package exports the following identifiers:statistics
.
There is no default export.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
orfatal: undefined
)nonfatal
: warning or info messagestotal
: all messages
Contribute
Seecontributing.md
contributing in vfile/.github
health for ways to
get started.
See support.md
support for ways to get help.This project has a code of conductcoc. By interacting with this repository, organization, or community you agree to abide by its terms.