Vfile

vfile is a JavaScript virtual file format that represents an in-memory file by tracking its path and contents.

  • Development
  • Tools & Utilities
vfile is a JavaScript virtual file format that represents an in-memory file by tracking its path and contents. It stores metadata and a list of lint messages so tools can record problems found while reading, parsing, or transforming a file. It is built for the unified tooling ecosystem and suits developers creating linters, compilers, static site generators, and other build systems that process text. Use it as a lightweight, serialisable model of a file when a full file-system object is unnecessary.

Platform availability

Available on 0 of 10 platforms

  • Unraid (not listed)
  • TrueNAS (not listed)
  • Umbrel (not listed)
  • ZimaOS (not listed)
  • Proxmox (not listed)
  • Helm (not listed)
  • Mac (not listed)
  • Windows (not listed)
  • Linux (not listed)
  • Any server (not listed)

Health score?A 0-100 score computed nightly from four factors: maintained (40%: recent commits and steady activity), popular (25%: GitHub stars, log scale), easy to install (20%: platforms, install notes, setup guides, Docker image) and light to run (15%: minimum RAM, ARM support). When the source code has been checked, a fifth factor, security check (20%: automated scan for committed secrets, unsafe desktop-app settings, known-vulnerable dependencies and project hygiene; any serious finding caps it at 20), is added. Factors without data are left out and the rest are rescaled.

33/100 Low

Maintained
7last commit 655 days ago
Popular
55532 GitHub stars
Easy to install
250 install platforms, install notes, Docker image
Light to run
No data
Security check
65no serious findings, CI, OpenSSF Scorecard 3.4/10

Based on 4 of 5 factors.

Availability: platform listings confirmed today

GitHub stars
532
Open issues
0
Last commit
2025-02-04
Latest release
6.0.2
License
MIT
Activity
stale

Checked 22 days ago - source: GitHub (vfile/vfile)

Resources & Compatibility

Requirements not published yet.

Checked 23 days ago - source: Docker Hub image tags and published docs

First-install notes

  • Install Install with npm using npm install vfile, then import VFile from 'vfile'. source

Fetched 3 days ago - each note links to its source

Alternatives

No alternatives collected yet.

Common questions

Is vfile an ESM-only package?

Yes. The README states that this package is ESM only.

Can vfile be used where the local file system is not accessible?

Yes. It is described as useful in places where you might not be able to access the file system.

How can I record lint problems in a vfile?

Use the message API to attach messages, errors, or failures to places in the file. The API includes message, info, and fail methods.

How do I convert a vfile to a string?

Call the file's toString method, which can take an encoding argument.

Answers sourced from github.com

Community

Collected 48 days ago - public community threads