Alexandro.Net

Version 1.0.2

@stackline/vfile-reporter

vfile utility to create a report for a file

Independent maintenance of vfile-reporter 7.0.5. Original authors and licenses are retained.

Installation

# Preserve existing imports with an npm alias
npm install vfile-reporter@npm:@stackline/vfile-reporter@1.0.2
# Or use the scoped package name in your imports
npm install @stackline/vfile-reporter@1.0.2

Node.js: See compatibility notes. Read the compatibility and maintenance notes before migrating.

Usage and API

@stackline/vfile-reporter

vfile utility to create a report for a file.

npm version license GitHub repository Docs Reddit community

Documentation | npm | Issues | Repository

Current package version: 1.0.2

Why this package?

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

Compatibility

Item Value
Package @stackline/vfile-reporter@1.0.2
API target vfile-reporter@7.0.5
Supported Node.js See supported framework requirements
License MIT
Module type module
Main entry index.js
Types index.d.ts
Runtime dependencies vfile, vfile-sort, string-width, vfile-message, supports-color, vfile-statistics, @types/supports-color, unist-util-stringify-position

Installation

npm install @stackline/vfile-reporter

Preserve existing imports and plugin resolution with an npm alias:

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

Usage and API reference

vfile-reporter

vfile utility to create a report.

Contents

What is this?

This package create a textual report from a file showing the warnings that occurred while processing. Many CLIs of tools that process files, whether linters (such as ESLint) or bundlers (such as esbuild), have similar functionality.

When should I use this?

You can use this package whenever you want to display a report about what occurred while processing to a human.

There are other reporters that display information differently listed in vfile.

Install

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

npm install @stackline/vfile-reporter

In Deno with esm.sh:

import {reporter} from 'https://esm.sh/vfile-reporter@7'

In browsers with esm.sh:

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

Use

Say our module example.js looks as follows:

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

const one = new VFile({path: 'test/fixture/1.js'})
const two = new VFile({path: 'test/fixture/2.js'})

one.message('Warning!', {line: 2, column: 4})

console.error(reporter([one, two]))

…now running node example.js yields:

test/fixture/1.js
  2:4  warning  Warning!

test/fixture/2.js: no issues found

⚠ 1 warning

API

This package exports the identifier reporter. That value is also the default export.

reporter(files[, options])

Create a report from an error, one file, or multiple files.

Parameters
Returns

Report (string).

Options

Configuration (TypeScript type).

Fields

Types

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

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.

Security

Use of vfile-reporter is safe.

Related

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, organisation, or community you agree to abide by its terms.

License

MIT © Titus Wormer

Forked from ESLints stylish reporter (originally created by Sindre Sorhus), which is Copyright (c) 2013 Nicholas C. Zakas, and licensed under MIT.

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.

Upstream issues and maintenance review

Upstream and maintenance review

This package maintains vfile-reporter@7.0.5 under the independent @stackline/vfile-reporter name.

Issue triage

The queried open-issue list contained no issue entries. This does not establish that the upstream is abandoned or bug-free. No runtime bug fix is claimed for this initial maintenance release.

The evidence query fetched the latest 100 open and 30 closed issue/PR entries and removed PRs. Closed entries were collected for context; this report does not claim an exhaustive historic review.

Release discipline

The source commit, passing CI and CodeQL, reviewed CI tarball hash, npm provenance, normal and aliased installs, and immutable GitHub release are checked before a release is complete. Published versions and tags are never replaced.

Release changes

Changelog

1.0.0

Release files and references

Package bytes, npm provenance and the immutable GitHub release were verified for this version. Security checks describe the reviewed release; documented compatibility risks and upstream reports are not blanket claims of resolution.