vfile-reporter

What is vfile-reporter?

The vfile-reporter package is used to format and report messages from vfile objects, which are used to represent files with associated metadata and messages. It is particularly useful in the context of processing files with tools like unified, remark, and rehype.

What are vfile-reporter's main functionalities?

Basic Reporting

This feature allows you to generate a basic report from a vfile object. The report includes messages such as warnings or errors associated with the file.

const vfile = require('vfile');
const vfileReporter = require('vfile-reporter');

const file = vfile({path: 'example.md', contents: 'Hello, world!'});
file.message('Warning: something is not right', {line: 1, column: 1});

console.log(vfileReporter([file]));

Custom Reporters

This feature allows you to create custom reporters to format the messages in a way that suits your needs. The example shows a custom reporter that formats messages with file path, line, and column information.

const vfile = require('vfile');
const vfileReporter = require('vfile-reporter');

const file = vfile({path: 'example.md', contents: 'Hello, world!'});
file.message('Warning: something is not right', {line: 1, column: 1});

const customReporter = (files) => {
  return files.map(file => file.messages.map(msg => `${file.path}:${msg.line}:${msg.column} - ${msg.reason}`).join('\n')).join('\n');
};

console.log(customReporter([file]));

Other packages similar to vfile-reporter

eslint

ESLint is a tool for identifying and reporting on patterns found in ECMAScript/JavaScript code. It is highly configurable and can be extended with custom rules and plugins. Unlike vfile-reporter, which is more general-purpose and can be used with any type of file, ESLint is specifically designed for JavaScript and TypeScript code.

stylelint

Stylelint is a linter that helps you avoid errors and enforce conventions in your styles. It is specifically designed for CSS and other style languages. Similar to vfile-reporter, it provides detailed reports of issues found in the files it processes, but it is specialized for style sheets.

markdownlint

Markdownlint is a linter for Markdown files. It helps enforce standards and catch common mistakes in Markdown documents. While vfile-reporter can be used with Markdown files as part of a larger toolchain, markdownlint is specifically focused on Markdown and provides a set of rules tailored to that format.

README

vfile-reporter

vfile utility to create a report.

Contents

• What is this?
• When should I use this?
• Install
• Use
• API
  • reporter(files[, options])
  • Options
• Types
• Compatibility
• Security
• Related
• Contribute
• License

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 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 '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

• files (VFile, Array<VFile>, or Error) — files or error to report
• options (Options, optional) — configuration

Returns

Report (string).

Options

Configuration (TypeScript type).

Fields

• color (boolean, default: depends) — use ANSI colors in report, the default behavior in Node.js is the check if color is supported
• verbose (boolean, default: false) — show message notes, notes are optional, additional, long descriptions
• quiet (boolean, default: false) — do not show files without messages
• silent (boolean, default: false) — show errors only, this hides info and warning messages, and sets quiet: true
• defaultName (string, default: '<stdin>'). — label to use for files without file path, if one file and no defaultName is given, no name will show up in the report

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

• vfile-reporter-json — create a JSON report
• vfile-reporter-pretty — create a pretty report
• vfile-reporter-junit — create a jUnit report
• vfile-reporter-position — create a report with content excerpts

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.