vfile-sort

Sort vfile messages.

• First sorts by line/column: earlier messages come first
• If two messages occurred at the same place, sorts fatal error before warnings, before info messages
• Otherwise, uses localeCompare to compare source, ruleId, or finally reason

Install

This package is ESM only: Node 12+ is needed to use it and it must be imported instead of required.

npm:

npm install vfile-sort

Use

import {VFile} from 'vfile'
import {sort} from 'vfile-sort'

var 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 following identifiers: sort. There is no default export.

sort(file)

Sort messages in the given vfile.

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

Current Tags

• 3.0.0                                ...           latest (4 years ago)

3 Versions

• 3.0.0                                ...           4 years ago
• 2.2.2                                ...           5 years ago
• 1.0.0                                ...           10 years ago