Neanderthal Pudding Mix

    vfile-to-eslint
    TypeScript icon, indicating that this package has built-in type declarations

    3.1.0 • Public • Published

    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 14.14+ and 16.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 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
    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 all maintained versions of Node.js. As of now, that is Node.js 14.14+ and 16.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

    Install

    npm i vfile-to-eslint

    DownloadsWeekly Downloads

    910

    Version

    3.1.0

    License

    MIT

    Unpacked Size

    9.96 kB

    Total Files

    7

    Last publish

    Collaborators

    • wooorm