unified

Project: vfile/vfile-to-eslint

Package: vfile-to-eslint@3.0.0

  1. Dependents: 3
  2. vfile utility to convert to ESLint formatter compatible output
  1. util 143
  2. utility 139
  3. file 34
  4. virtual 19
  5. vfile 17
  6. vfile-util 15
  7. vfile-reporter 4
  8. reporter 4
  9. eslint 4

vfile-to-eslint

Build Coverage Downloads Sponsors Backers Chat

Convert VFiles to ESLint formatter compatible output.

For example, remark-lint returns a VFile, which you could pass through this module to display it using an ESLint formatter.

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-to-eslint

Use

import remark from 'remark'
import recommended from 'remark-preset-lint-recommended'
import eslintFormatterPretty from 'eslint-formatter-pretty'
import {toESLint} from 'vfile-to-eslint'

const file = remark()
  .use(recommended)
  .processSync('## Hello world!')

console.log(eslintFormatterPretty(toESLint([file])))

API

This package exports the following identifiers: toESLint. There is no default export.

toESLint(files)

Returns an Object that can be passed directly to an ESLint formatter.

files

List of files (Array.<VFile>).

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 © Sindre Sorhus