vfile-to-eslint

vfile-to-eslint

Convert VFiles to ESLint formatter compatible output.

Contents

• What is this?
• When should I use this?
• Install
• Use
• API
  • toESLint(files)
• Types
• Compatibility
• Contribute
• License

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 16+), install with npm:

npm install vfile-to-eslint

In Deno with esm.sh:

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

In browsers with esm.sh:

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

Use

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

const file = await remark()
  .use(remarkPresetLintRecommended)
  .process('## Hello world!')

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

API

This package exports the identifier toESLint. There is no default export.

toESLint(files)

Turn virtual files into a ESLint results that can be passed directly to an ESLint formatter.

Parameters

• files (Array<VFile>) — list of files

Returns

Lint results (Array<LintResult>)

Types

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

Compatibility

Projects maintained by the unified collective are compatible with maintained versions of Node.js.

When we cut a new major release, we drop support for unmaintained versions of Node. This means we try to keep the current release line, vfile-to-eslint@^4, compatible with Node.js 16.

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