vfile utility to sort files or messages.

• What is this?
• When should I use this?
• Install
• Use
• API
  • compareFile(a, b)
  • compareMessage(a, b)
• Types
• Compatibility
• Contribute
• License

This package exposes comparators for vfile files and messages.

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

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

npm install vfile-sort

In Deno with esm.sh:

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

In browsers with esm.sh:

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

import {VFile} from 'vfile'
import {VFileMessage} from 'vfile-message'
import {compareFile, compareMessage} from 'vfile-sort'
console.log(
  [
    new VFileMessage('Error!', {place: {line: 3, column: 1}}),
    new VFileMessage('Another!', {place: {line: 2, column: 2}})
  ]
    .toSorted(compareMessage)
    .map(String)
) //=> ['2:2: Another!', '3:1: Error!']
console.log(
  [
    new VFile(new URL(import.meta.url)),
    new VFile(new URL('.', import.meta.url))
  ]
    .toSorted(compareFile)
    .map((d) => d.path)
) //=> ['/Users/tilde/Projects/oss/vfile-sort/', '/Users/tilde/Projects/oss/vfile-sort/example.js']

This package exports the identifiers compareFile and compareMessage. There is no default export.

Compare files (since: 4.0.0).

• a (VFile) — file
• b (VFile) — other file

Order (number).

Compare messages (since: 4.0.0).

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.

• a (VFile) — message
• b (VFile) — other message

Order (number).

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

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-sort@^4, compatible with Node.js 16.

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.

MIT © Titus Wormer