Skip to content
Create a vfile from a file-path
Branch: master
Clone or download
Latest commit a7abc68 Jan 6, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
lib Refactor code-style Nov 19, 2018
.editorconfig Update for vfile@2.0.0 Aug 21, 2016
.gitignore Add `yarn.lock` to `.gitignore` May 4, 2018
.npmrc Add `.npmrc` May 4, 2018
.prettierignore Add `.prettierignore` May 5, 2018
.travis.yml
index.js
license Move `LICENSE` > `license` Oct 28, 2018
package.json Add support for tests on Windows Jan 6, 2019
readme.md
test.js Add support for tests on Windows Jan 6, 2019

readme.md

to-vfile

Build Coverage Downloads Chat

Create a vfile from a file-path. Optionally populates them from the file-system as well. Can write virtual files to file-system too.

Installation

npm:

npm install to-vfile

Note: the file-system stuff is not available in the browser.

Usage

var vfile = require('to-vfile')

console.log(vfile('readme.md'))
console.log(vfile.readSync('.git/HEAD'))
console.log(vfile.readSync('.git/HEAD', 'utf8'))

Yields:

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

API

toVFile(options)

Create a virtual file. Works like the vfile constructor, except when options is string or Buffer, in which case it’s treated as {path: options} instead of {contents: options}.

toVFile.read(options[, encoding][, callback])

Creates a virtual file from options (toVFile(options)), reads the file from the file-system and populates file.contents with the result. If encoding is specified, it’s passed to fs.readFile. If callback is given, invokes it with either an error or the populated virtual file. If callback is not given, returns a Promise that is rejected with an error or resolved with the populated virtual file.

toVFile.readSync(options[, encoding])

Like toVFile.read but synchronous. Either throws an error or returns a populated virtual file.

toVFile.write(options[, fsOptions][, callback])

Creates a virtual file from options (toVFile(options)), writes the file to the file-system. fsOptions are passed to fs.writeFile. If callback is given, invokes it with an error, if any. If callback is not given, returns a Promise that is rejected with an error or resolved without any value.

toVFile.writeSync(options[, fsOptions])

Like toVFile.write but synchronous. Throws an error, if any.

Contribute

See contributing.md in vfile/vfile for ways to get started.

This organisation has a Code of Conduct. By interacting with this repository, organisation, or community you agree to abide by its terms.

License

MIT © Titus Wormer

You can’t perform that action at this time.