vfile-to-eslint

vfile utility to convert to ESLint formatter compatible output

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
vfile-to-eslint
1503.0.02 years ago6 years agoMinified + gzip package size for vfile-to-eslint in KB

Readme

vfile-to-eslint
!Buildbuild-badgebuild !Coveragecoverage-badgecoverage !Downloadsdownloads-badgedownloads !Sponsorssponsors-badgecollective !Backersbackers-badgecollective !Chatchat-badgechat
Convert VFilesvfile 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.
!screenshot

Install

This package is ESM only: Node 12+ is needed to use it and it must be imported instead of required.
npm install vfile-to-eslint
## Use

```js
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 formattereslint-formatter.
files
List of files (Array.<VFile>vfile).

Contribute

See contributing.mdcontributing in vfile/.githubhealth for ways to get started. See support.mdsupport for ways to get help.
This project has a code of conductcoc. By interacting with this repository, organization, or community you agree to abide by its terms.

License

MITlicense © Sindre Sorhusauthor