Nobody Packages More

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

    3.0.1 • Public • Published

    vfile-sort

    Build Coverage Downloads Size Sponsors Backers Chat

    vfile utility to sort messages.

    Contents

    What is this?

    This is a small package to sort the list of messages. It first sorts by line/column: earlier messages come first. When two messages occurr at the same place, sorts fatal error before warnings, before info messages. Finally, it sorts using localeCompare on source, ruleId, or finally reason.

    When should I use this?

    You can use this right before a reporter is used to give humans a coherent report.

    Install

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

    npm install vfile-sort

    In Deno with esm.sh:

    import {sort} from 'https://esm.sh/vfile-sort@3'

    In browsers with esm.sh:

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

    Use

    import {VFile} from 'vfile'
    import {sort} from 'vfile-sort'
    
    const file = VFile()
    
    file.message('Error!', {line: 3, column: 1})
    file.message('Another!', {line: 2, column: 2})
    
    sort(file)
    
    console.log(file.messages.map(d => String(d)))
    // => ['2:2: Another!', '3:1: Error!']

    API

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

    sort(file)

    Sort messages in the given vfile.

    Parameters
    • file (VFile) — file to sort
    Returns

    Sorted file (VFile).

    Types

    This package is fully typed with TypeScript. It exports no additional types.

    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 © Titus Wormer

    Install

    npm i vfile-sort

    DownloadsWeekly Downloads

    225,187

    Version

    3.0.1

    License

    MIT

    Unpacked Size

    9.03 kB

    Total Files

    7

    Last publish

    Collaborators

    • wooorm