unified

Project: vfile/vfile-to-eslint

Package: vfile-to-eslint@3.0.0

  1. Dependents: 0
  2. vfile utility to convert to ESLint formatter compatible output
  1. util 147
  2. utility 143
  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.

Contents

What is this?

This package turns a file into the LintResult schema that ESLint uses for its formatters

When should I use this?

While vfile and ESLint results are different, they do overlap in some places. This package can be used to integrate with ESLint in those cases. In other cases, a custom vfile utility might be a better solution.

Install

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

npm install vfile-to-eslint

In Deno with esm.sh:

import {toESLint} from 'https://esm.sh/vfile-to-eslint@3'

In browsers with esm.sh:

<script type="module">
  import {toESLint} from 'https://esm.sh/vfile-to-eslint@3?bundle'
</script>

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

toESLint(files)

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

files

List of files (Array<VFile>).

Types

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

Compatibility

Projects maintained by the unified collective are compatible with all maintained versions of Node.js. As of now, that is Node.js 12.20+, 14.14+, 16.0+, and 18.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 © Sindre Sorhus