@stackline/vfile-sort
vfile utility to sort messages by line/column.
Documentation | npm | Issues | Repository
Current package version: 1.0.2
Why this package?
@stackline/vfile-sort is the Stackline-maintained distribution of vfile-sort@3.0.1. It is an independent continuation of vfile-sort; original authors and licenses remain credited below.
Compatibility
| Item | Value |
|---|---|
| Package | @stackline/vfile-sort@1.0.2 |
| API target | vfile-sort@3.0.1 |
| Supported Node.js | See supported framework requirements |
| License | MIT |
| Module type | module |
| Main entry | index.js |
| Types | index.d.ts |
| Runtime dependencies | vfile, vfile-message |
Installation
npm install @stackline/vfile-sort
Preserve existing imports and plugin resolution with an npm alias:
npm install vfile-sort@npm:@stackline/vfile-sort
Usage and API reference
vfile-sort
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 @stackline/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 '@stackline/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
Credits and original authors
- Original project: vfile-sort.
- Titus Wormer.
- Copyright (c) 2015 Titus Wormer tituswormer@gmail.com.
- Stackline maintenance: Alexandro Paixao Marques and Stackline contributors.
Original copyright, license notices and contributor acknowledgements remain part of this distribution. Stackline maintenance does not replace authorship of the original work.
Community and Links
Use this repository's issue tracker for reproducible bugs and feature requests. Join r/Stackline for examples, usage questions and release discussions.