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

Create a report for a vfile.

Features

• Ranges (3:2 and 3:2-3:6)
• Stack-traces to show where awful stuff occurs
• Successful files (configurable)
• All of VFile’s awesomeness

Install

This package is ESM only: Node 12+ is needed to use it and it must be imported instead of required.

npm:

npm install vfile-reporter

Use

Say example.js contains:

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 yields:

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

test/fixture/2.js: no issues found

⚠ 1 warning

API

This package exports the following identifiers: reporter. That identifier is also the default export.

reporter(files[, options])

Generate a stylish report from the given vfile, Array.<VFile>, or Error.

options

options.verbose

Output long form descriptions of messages, if applicable (boolean, default: false).

options.quiet

Do not output anything for a file which has no warnings or errors (boolean, default: false). The default behavior is to show a success message.

options.silent

Do not output messages without fatal set to true (boolean, default: false). Also sets quiet to true.

options.color

Whether to use color (boolean, default: depends). The default behavior is the check if color is supported.

options.defaultName

Label to use for files without file-path (string, default: '<stdin>'). If one file and no defaultName is given, no name will show up in the report.

Related

• vfile-reporter-json — JSON reporter
• vfile-reporter-pretty — Pretty reporter
• convert-vinyl-to-vfile — Convert from Vinyl
• vfile-statistics — Count messages per category
• vfile-sort — Sort messages by line/column

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

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