Package Exports

mock-fs

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (mock-fs) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Mock FS

A configurable mock file system. You know, for testing.

Example

The code below creates a mock fs module that is configured to work with a few mock files and directories.

var mock = require('mock-fs');

var fs = mock.fs({
  'path/to/fake/dir': {
    'some-file.txt': 'file content here',
    'empty-dir': {/** empty directory */}
  },
  'path/to/some.png': new Buffer([8, 6, 7, 5, 3, 0, 9]),
  'some/other/path': {/** another empty directory */}
});

If you are testing a module that requires the real fs module, you can use rewire to inject a mock fs module for testing.

var rewire = require("rewire");
var moduleToTest = rewire('./path/to/module');

// inject the mock fs created above
moduleToTest.__set__('fs', fs);

// now functions in moduleToTest will use
// your mock fs instead of the real one

Status

The table below shows what is covered by the mock fs. Tests are currently run on Node 0.8 and 0.10. Eventually more versions will be supported.

function	status	notes
`fs.rename`	100%	Complete
`fs.renameSync`	100%	Complete
`fs.ftruncate`	0%	Implement `binding.ftruncate`
`fs.ftruncateSync`	0%	Implement `binding.ftruncate`
`fs.truncate`	0%	Implement `binding.ftruncate`
`fs.chown`	0%	Implement `binding.chown`
`fs.chownSync`	0%	Implement `binding.chown`
`fs.fchown`	0%	Implement `binding.fchown`
`fs.fchownSync`	0%	Implement `binding.fchown`
`fs.lchownSync`	0%	Implement `binding.fchown`
`fs.lchown`	0%	Implement `binding.fchown`
`fs.chmod`	0%	Implement `binding.chmod`
`fs.chmodSync`	0%	Implement `binding.chmod`
`fs.fchmod`	0%	Implement `binding.fchmod`
`fs.fchmodSync`	0%	Implement `binding.fchmod`
`fs.lchmod`	0%	Implement `binding.fchmod`
`fs.lchmodSync`	0%	Implement `binding.fchmod`
`fs.stat`	90%	Provides stats object see Stats
`fs.lstat`	0%	Implement `binding.lstat`
`fs.fstat`	90%	Provides stats object see Stats
`fs.statSync`	90%	Provides stats object see Stats
`fs.lstatSync`	0%	Implement `binding.lstat`
`fs.fstatSync`	90%	Provides stats object see Stats
`fs.link`	0%	Implement `binding.link`
`fs.linkSync`	0%	Implement `binding.link`
`fs.symlink`	0%	Implement `binding.symlink`
`fs.symlinkSync`	0%	Implement `binding.symlink`
`fs.readlink`	0%	Implement `binding.readlink`
`fs.readlinkSync`	0%	Implement `binding.readlink`
`fs.realpath`	0%	Implement `binding.readlink` & `binding.lstat`
`fs.realpathSync`	0%	Implement `binding.readlink` & `binding.lstat`
`fs.unlink`	0%	Implement `binding.unlink`
`fs.unlinkSync`	0%	Implement `binding.unlink`
`fs.rmdir`	100%	Complete
`fs.rmdirSync`	100%	Complete
`fs.mkdir`	100%	Complete
`fs.mkdirSync`	100%	Complete
`fs.readdir`	100%	Complete
`fs.readdirSync`	100%	Complete
`fs.close`	100%	Complete
`fs.closeSync`	100%	Complete
`fs.open`	100%	Complete
`fs.openSync`	100%	Complete
`fs.utimes`	0%	Implement `binding.utimes`
`fs.utimesSync`	0%	Implement `binding.utimes`
`fs.futimes`	0%	Implement `binding.futimes`
`fs.futimesSync`	0%	Implement `binding.futimes`
`fs.fsync`	0%	Implement `binding.fsync`
`fs.fsyncSync`	0%	Implement `binding.fsync`
`fs.write`	100%	Complete
`fs.writeSync`	100%	Complete
`fs.read`	100%	Complete
`fs.readSync`	100%	Complete
`fs.readFile`	100%	Complete
`fs.readFileSync`	100%	Complete
`fs.writeFile`	100%	Complete
`fs.writeFileSync`	100%	Complete
`fs.appendFile`	100%	Complete
`fs.appendFileSync`	100%	Complete
`fs.watchFile`	0%	Implement `binding.StatWatcher`
`fs.unwatchFile`	0%	Implement `binding.StatWatcher`
`fs.watch`	0%	Implement `fs.FSWatcher`
`fs.exists`	100%	Complete
`fs.existsSync`	100%	Complete
`fs.Stats`	90%	Incudes `mode`, `size`, `atime`, `ctime`, `mtime`, `isFile()`, and `isDirectory()`
`fs.createReadStream`	100%	Complete
`fs.ReadStream`	100%	Complete
`fs.createWriteStream`	100%	Complete
`fs.WriteStream`	100%	Complete
`fs.FSWatcher`	0%	Implement `fs.FSWatcher`
`fs.fdatasync`	0%	Implement `binding.fdatasync`
`fs.fdatasyncSync`	0%	Implement `binding.fdatasync`