Alexandro.Net

Download README · GitHub release

@stackline/vfile-statistics

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

npm version license GitHub repository Docs Reddit community

Documentation | npm | Issues | Repository

Current package version: 1.0.2

Why this package?

@stackline/vfile-statistics is the Stackline-maintained distribution of vfile-statistics@2.0.1. It is an independent continuation of vfile-statistics; original authors and licenses remain credited below.

Compatibility

Item Value
Package @stackline/vfile-statistics@1.0.2
API target vfile-statistics@2.0.1
Supported Node.js See supported framework requirements
License MIT
Module type module
Main entry index.js
Types index.d.ts
Runtime dependencies vfile, vfile-message

Installation

npm install @stackline/vfile-statistics

Preserve existing imports and plugin resolution with an npm alias:

npm install vfile-statistics@npm:@stackline/vfile-statistics

Usage and API reference

vfile-statistics

vfile utility to count messages per category (fatal, warn, info, etc).

Contents

What is this?

This tiny package gives you stats about messages in files.

When should I use this?

This is really tiny, you could do it yourself, but this is useful as a building block.

Install

This package is ESM only. In Node.js (version 14.14+ and 16.0+), install with npm:

npm install @stackline/vfile-statistics

In Deno with esm.sh:

import {statistics} from 'https://esm.sh/vfile-statistics@2'

In browsers with esm.sh:

<script type="module">
  import {statistics} from 'https://esm.sh/vfile-statistics@2?bundle'
</script>

Use

import {VFile} from 'vfile'
import {statistics} from '@stackline/vfile-statistics'

const 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 {}

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 identifier statistics. There is no default export.

statistics(file)

Get stats for a file, list of files, or list of messages.

Parameters
Returns

Statistics (Statistics).

Statistics

Statistics (TypeScript type).

Fields

Types

This package is fully typed with TypeScript. It exports the additional type Statistics.

Compatibility

Projects maintained by the unified collective are compatible with all maintained versions of Node.js. As of now, that is Node.js 14.14+ and 16.0+. Our projects sometimes work with older versions, but this is not guaranteed.

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

Credits and original authors

Original copyright, license notices and contributor acknowledgements remain part of this distribution. Stackline maintenance does not replace authorship of the original work.

Community and Links

Use this repository's issue tracker for reproducible bugs and feature requests. Join r/Stackline for examples, usage questions and release discussions.