Alexandro.Net

Version 1.0.0

@stackline/to-vfile

vfile utility to create a vfile from a filepath

Independent maintenance of to-vfile 7.2.4. Original authors and licenses are retained.

Installation

# Preserve existing imports with an npm alias
npm install to-vfile@npm:@stackline/to-vfile@1.0.0
# Or use the scoped package name in your imports
npm install @stackline/to-vfile@1.0.0

Node.js: See compatibility notes. Read the compatibility and maintenance notes before migrating.

Usage and API

The reference below may retain upstream package names. Use the alias installation above to run those imports with this Stackline release.

@stackline/to-vfile

Independent maintenance fork of to-vfile@7.2.4, preserving its API and published type declarations.

npm install @stackline/to-vfile
# Keep existing imports:
npm install to-vfile@npm:@stackline/to-vfile@1.0.0

Stackline · Issues · Community

See UPSTREAM.md for source identity and issue review, and CHANGELOG.md for maintenance changes. Functional tests also run against the final npm tarball; releases are published from GitHub Actions with provenance.

Upstream documentation

to-vfile

Build Coverage Downloads Sponsors Backers Chat

vfile utility to read and write to the file system.

Contents

What is this?

This utility places file paths and the file system first. Where vfile itself focusses on file values (the file contents), this instead focuses on the file system, which is a common case when working with files.

When should I use this?

Use this if you know there’s a file system and want to use it. Use vfile if there might not be a file system.

Install

This package is ESM only. In Node.js (version 14.14+ and 16.0+), install with npm:

npm install to-vfile

In Deno with esm.sh:

import {toVFile, read, readSync, write, writeSync} from 'https://esm.sh/to-vfile@7'

In browsers with esm.sh:

<script type="module">
  import {toVFile, read, readSync, write, writeSync} from 'https://esm.sh/to-vfile@7?bundle'
</script>

Use

import {toVFile, read} from 'to-vfile'

console.log(toVFile('readme.md'))
console.log(toVFile(new URL('readme.md', import.meta.url)))
console.log(await read('.git/HEAD'))
console.log(await read('.git/HEAD', 'utf8'))

Yields:

VFile {
  data: {},
  messages: [],
  history: [ 'readme.md' ],
  cwd: '/Users/tilde/Projects/oss/to-vfile'
}
VFile {
  data: {},
  messages: [],
  history: [ '/Users/tilde/Projects/oss/to-vfile/readme.md' ],
  cwd: '/Users/tilde/Projects/oss/to-vfile'
}
VFile {
  data: {},
  messages: [],
  history: [ '.git/HEAD' ],
  cwd: '/Users/tilde/Projects/oss/to-vfile',
  value: <Buffer 72 65 66 3a 20 72 65 66 73 2f 68 65 61 64 73 2f 6d 61 69 6e 0a>
}
VFile {
  data: {},
  messages: [],
  history: [ '.git/HEAD' ],
  cwd: '/Users/tilde/Projects/oss/to-vfile',
  value: 'ref: refs/heads/main\n'
}

API

This package exports the identifiers read, readSync, toVFile, write, and writeSync. There is no default export.

toVFile(description)

Create a virtual file from a description.

This is like VFile, but it accepts a file path instead of file cotnents.

If options is a string, URL, or buffer, it’s used as the path. Otherwise, if it’s a file, that’s returned instead. Otherwise, the options are passed through to new VFile().

Parameters
Returns

Given file or new file (VFile).

read(description[, options][, callback])

Create a virtual file and read it in, async.

Signatures
Parameters
Returns

Nothing when a callback is given, otherwise promise that resolves to given file or new file (VFile).

readSync(description[, options])

Create a virtual file and read it in, synchronously.

Parameters
Returns

Given file or new file (VFile).

write(description[, options][, callback])

Create a virtual file and write it, async.

Signatures
Parameters
Returns

Nothing when a callback is given, otherwise promise that resolves to given file or new file (VFile).

writeSync(description[, options])

Create a virtual file and write it, synchronously.

Parameters
Returns

Given file or new file (VFile).

BufferEncoding

Encodings supported by the buffer class (TypeScript type).

This is a copy of the types from Node and VFile.

Type
type BufferEncoding =
  | 'ascii'
  | 'utf8'
  | 'utf-8'
  | 'utf16le'
  | 'ucs2'
  | 'ucs-2'
  | 'base64'
  | 'base64url'
  | 'latin1'
  | 'binary'
  | 'hex'

Callback

Callback called after reading or writing a file (TypeScript type).

Parameters
Returns

Nothing (void).

Compatible

URL to file, path to file, options for file, or actual file (TypeScript type).

Type
type Compatible = Buffer | URL | VFileOptions | VFile | string

See VFileOptions and VFile.

ReadOptions

Configuration for fs.readFile (TypeScript type).

Fields

WriteOptions

Configuration for fs.writeFile (TypeScript type).

Fields

Types

This package is fully typed with TypeScript. It exports the additional types BufferEncoding, Callback, Compatible, ReadOptions, and WriteOptions.

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

MIT © Titus Wormer

Upstream issues and maintenance review

Upstream and maintenance review

This package maintains to-vfile@7.2.4 under the independent @stackline/to-vfile name.

Issue triage

The queried open-issue list contained no issue entries. This does not establish that the upstream is abandoned or bug-free. No runtime bug fix is claimed for this initial maintenance release.

The evidence query fetched the latest 100 open and 30 closed issue/PR entries and removed PRs. Closed entries were collected for context; this report does not claim an exhaustive historic review.

Release discipline

The source commit, passing CI and CodeQL, reviewed CI tarball hash, npm provenance, normal and aliased installs, and immutable GitHub release are checked before a release is complete. Published versions and tags are never replaced.

Release changes

Changelog

1.0.0

Release files and references

Package bytes, npm provenance and the immutable GitHub release were verified for this version. Security checks describe the reviewed release; documented compatibility risks and upstream reports are not blanket claims of resolution.