vfile-statistics

vfile utility to count messages per category: failures, warnings, etc

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
vfile-statistics
502.0.02 years ago6 years agoMinified + gzip package size for vfile-statistics in KB

Readme

vfile-statistics
!Buildbuild-badgebuild !Coveragecoverage-badgecoverage !Downloadsdownloads-badgedownloads !Sizesize-badgesize !Sponsorssponsors-badgecollective !Backersbackers-badgecollective !Chatchat-badgechat
Count 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 be imported instead of required.
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 or fatal: undefined)
  • nonfatal: warning or info messages
  • total: all messages

Contribute

See contributing.mdcontributing in vfile/.githubhealth for ways to get started. See support.mdsupport 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.

License

MITlicense © Titus Wormerauthor