Gathering detailed insights and metrics for vfile-sort
Gathering detailed insights and metrics for vfile-sort
Installations
npm install vfile-sortDeveloper Guide
BETA
Typescript
Yes
Module System
ESM
Node Version
20.0.0
NPM Version
9.6.4
Releases
11
Languages
1
JavaScript
JavaScript (100%)
Developer
Download Statistics
Total Downloads
0
Last Day
0
Last Week
0
Last Month
0
Last Year
0
GitHub Statistics
MIT License
5 Stars
94 Commits
3 Forks
7 Watchers
1 Branches
10 Contributors
Updated on May 05, 2024
Sponsor this package
Maintainers
1
Package Meta Information
Latest Version
4.0.0
Package Id
vfile-sort@4.0.0
Unpacked Size
11.99 kB
Size
4.13 kB
File Count
7
NPM Version
9.6.4
Node Version
20.0.0
Published on
Jun 10, 2023
Total Downloads
Cumulative downloads
Total Downloads
NaN
Last Day
0%
NaN
Compared to previous day
Last Week
0%
NaN
Compared to previous week
Last Month
0%
NaN
Compared to previous month
Last Year
0%
NaN
Compared to previous year
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
2
vfile-sort
vfile utility to sort files or messages.
Contents
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 only. In Node.js (version 16+), install with npm:
1npm install vfile-sort
In Deno with esm.sh:
1import {sort} from 'https://esm.sh/vfile-sort@4'
In browsers with esm.sh:
1<script type="module"> 2 import {sort} from 'https://esm.sh/vfile-sort@4?bundle' 3</script>
Use
1import {VFile} from 'vfile' 2import {VFileMessage} from 'vfile-message' 3import {compareFile, compareMessage} from 'vfile-sort' 4 5console.log( 6 [ 7 new VFileMessage('Error!', {place: {line: 3, column: 1}}), 8 new VFileMessage('Another!', {place: {line: 2, column: 2}}) 9 ] 10 .toSorted(compareMessage) 11 .map(String) 12) //=> ['2:2: Another!', '3:1: Error!'] 13 14console.log( 15 [ 16 new VFile(new URL(import.meta.url)), 17 new VFile(new URL('.', import.meta.url)) 18 ] 19 .toSorted(compareFile) 20 .map((d) => d.path) 21) //=> ['/Users/tilde/Projects/oss/vfile-sort/', '/Users/tilde/Projects/oss/vfile-sort/example.js']
API
This package exports the identifiers compareFile and
compareMessage.
There is no default export.
compareFile(a, b)
Compare files (since: 4.0.0).
Parameters
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 using localeCompare on source, ruleId, or finally
reason.
Parameters
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
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
No vulnerabilities found.
Reason
no dangerous workflow patterns detected
Reason
no binaries found in the repo
Reason
0 existing vulnerabilities detected
Reason
license file detected
Details
- Info: project has a license file: license:0
- Info: FSF or OSI recognized license: MIT License: license:0
Reason
security policy file detected
Details
- Info: security policy file detected: github.com/vfile/.github/security.md:1
- Info: Found linked content: github.com/vfile/.github/security.md:1
- Info: Found disclosure, vulnerability, and/or timelines in security policy: github.com/vfile/.github/security.md:1
- Info: Found text in security policy: github.com/vfile/.github/security.md:1
Reason
0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
Found 1/30 approved changesets -- score normalized to 0
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/bb.yml:11: update your workflow using https://app.stepsecurity.io/secureworkflow/vfile/vfile-sort/bb.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:10: update your workflow using https://app.stepsecurity.io/secureworkflow/vfile/vfile-sort/main.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:11: update your workflow using https://app.stepsecurity.io/secureworkflow/vfile/vfile-sort/main.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/main.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/vfile/vfile-sort/main.yml/main?enable=pin
- Warn: npmCommand not pinned by hash: .github/workflows/main.yml:15
- Info: 0 out of 2 GitHub-owned GitHubAction dependencies pinned
- Info: 0 out of 2 third-party GitHubAction dependencies pinned
- Info: 0 out of 1 npmCommand dependencies pinned
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: no topLevel permission defined: .github/workflows/bb.yml:1
- Warn: no topLevel permission defined: .github/workflows/main.yml:1
- Info: no jobLevel write permissions found
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
Project has not signed or included provenance with any releases.
Details
- Warn: release artifact 2.2.2 not signed: https://api.github.com/repos/vfile/vfile-sort/releases/24134673
- Warn: release artifact 2.2.1 not signed: https://api.github.com/repos/vfile/vfile-sort/releases/17676958
- Warn: release artifact 2.2.2 does not have provenance: https://api.github.com/repos/vfile/vfile-sort/releases/24134673
- Warn: release artifact 2.2.1 does not have provenance: https://api.github.com/repos/vfile/vfile-sort/releases/17676958
Reason
branch protection not enabled on development/release branches
Details
- Warn: branch protection not enabled for branch 'main'
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 1 are checked with a SAST tool
Score
3.7
/10
Last Scanned on 2025-06-30
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More