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

npm:

npm install to-vfile

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

var toVFile = require('to-vfile');

toVFile('readme.md');

Yields:

VFile {
  data: {},
  messages: [],
  history: [ 'readme.md' ],
  cwd: '/Users/tilde/projects/oss/to-vfile' }

Populate a virtual file:

toVFile.readSync('.git/HEAD', 'utf8');

Yields:

VFile {
  data: {},
  messages: [],
  history: [ '.git/HEAD' ],
  cwd: '/Users/tilde/projects/oss/to-vfile',
  contents: 'ref: refs/heads/master\n' }

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}.

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. Invokes callback with either an error or the populated virtual file.

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

Creates a virtual file from options (toVFile(options)), writes the file to the file-system. fsOptions are passed to fs.writeFile. Invokes callback with an error, if any.

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

MIT © Titus Wormer