npm

Bring the best of OSS JavaScript development to your projects with npm Orgs - private packages & team management tools.Learn more »

fixturify

1.2.0 • Public • Published

node-fixturify

Build Status Build status

Convert JSON objects into directory structures on the file system, and back again. This package is primarily useful for writing tests.

Installation

yarn add fixturify

Usage

const fs = require('fs')
const fixturify = require('fixturify')
 
const obj = {
  'foo.txt': 'foo.txt contents',
  'subdir': {
    'bar.txt': 'bar.txt contents'
  }
}
 
fixturify.writeSync('testdir', obj) // write it to disk
 
fixturify.readSync('testdir') // => deep-equals obj
 
fixturify.readSync('testdir', { include: ['foo*'] }) // glob support
// => { foo.txt: 'foo.text contents' }
 
fixturify.readSync('testdir', { exclude: ['foo*'] }) // glob support
// => { subdir: { bar.txt: 'bar.text contents' } }
 
fixturify.writeSync('testDir', {
  'subdir': { 'bar.txt': null }
}) // remove subdir/bar.txt
 
fixturify.readSync('testdir') // => { foo.txt: 'foo.text contents' }
 
fixturify.writeSync('testDir', {
  'subdir': null
}) // remove subdir/
 
const fs = require('fs')
const fixturify = require('fixturify')
 
const obj = {
  'subdir': {
    'foo.txt': 'foo.txt contents'
  },
  'emptydir': {}
}
 
fixturify.writeSync('testdir', obj) // write it to disk
 
fixturify.readSync('testdir', { ignoreEmptyDirs: true })
// => { subdir: { foo.txt': 'foo.txt contents' } }
 

File contents are decoded and encoded with UTF-8.

fixture.readSync follows symlinks. It throws an error if it encounters a broken symlink.

Limitations

To keep the API simple, node-fixturify has the following limitations:

  • Reading or setting file stats (last-modified time, permissions, etc.) is not supported.

  • Creating symlinks is not supported.

  • Special files like FIFOs, sockets, or devices are not supported.

  • File contents are automatically encoded/decoded into strings. Binary files are not supported.

Keywords

none

install

npm i fixturify

Downloadsweekly downloads

47,851

version

1.2.0

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
  • avatar
Report a vulnerability