vfile-sort
!Buildbuild-badgebuild
!Coveragecoverage-badgecoverage
!Downloadsdownloads-badgedownloads
!Sizesize-badgesize
!Sponsorssponsors-badgecollective
!Backersbackers-badgecollective
!Chatchat-badgechatvfile
vfile utility to sort files or messages.Contents
* [`compareFile(a, b)`](#comparefilea-b)
* [`compareMessage(a, b)`](#comparemessagea-b)
What is this?
This package exposes comparators for vfile files and messages.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 onlyesm. In Node.js (version 16+), install with npm:npm install vfile-sort
In Deno with
esm.sh
esmsh:import {sort} from 'https://esm.sh/vfile-sort@4'
In browsers with
esm.sh
esmsh:<script type="module">
import {sort} from 'https://esm.sh/vfile-sort@4?bundle'
</script>
Use
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']
API
This package exports the identifierscompareFile
api-compare-file and
compareMessage
api-compare-message.
There is no default export.compareFile(a, b)
Compare files (since: 4.0.0
).Parameters
— file
— other file
Returns
Order (number
).compareMessage(a, b)
Compare messages (since: 4.0.0
).Algorithm
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 usinglocaleCompare
on source
, ruleId
, or finally
reason
.Parameters
— message
— other message
Returns
Order (number
).Types
This package is fully typed with TypeScript. It exports no additional types.Compatibility
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.Contribute
Seecontributing.md
contributing in vfile/.github
health for ways to
get started.
See support.md
support 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.