fixture-dir
Create/copy directory to temporary directory
fixture-dir
was built for quickly setting up/tearing down directories that originate from tests but should not contaminate the repo. Previous to fixture-dir's
creation, I have used this pattern in foundry-release-git and sexy-bash-prompt.
A mocha flavor is available, mocha-fixture-dir, which provides automatic directory cleanup.
Getting Started
Install the module with: npm install fixture-dir
// Generate a tmp namespace for our testsvar exec = exec;var FixtureDir = ;var fixtureDir = 'my-node-module-tests'; // Inside of our tests, copy over folder contents and interact with them;;; ;
Documentation
fixture-dir
returns the FixtureDir
constructor via its module.exports
.
FixtureDir(folderName)
Constructor for fixture directory namespaces inside of /tmp
(or your equivalent temporary directory).
- folderName
String
, Folder to create all subsequent temporary directories inside of- We require this to be reduce pollution of the
/tmp
folder names - The folder path will be
/tmp/{{folderName}}
(e.g./tmp/hai
for{folderName: 'hai'}
- We require this to be reduce pollution of the
FixtureDir#mkdir([options], cb)
- options
Object
, Optional container for various flags/parameters- options.folderName
String
, Folder name to create- The folder path will be
/tmp/top-level/{{folderName}}
(e.g./tmp/top-level/world
for{folderName: 'world'}
- If this is not provided, we will use a random string generated by tmp
- The folder path will be
- options.copyFrom
String
, Path to source folder to copy contents from
- options.folderName
- cb
Function
, Error-first callback function with signature(err, dir)
- err
Error|null
, If any errors occurred then this will be it - dir
Directory
, Instance ofDirectory
for folder we just created
- err
Directory
Class representation of a directory for getting path
and cleaning up
Directory.path
Filepath to directory (e.g. /tmp/my-node-module-tests/git-log
)
Directory.destroy(cb)
Method to clean up temporary directory (usually for next test run)
- cb
Function
, Error-first callback function with signature(err)
- err
Error|null
, If any errors occurred then this will be it
- err
Examples
Creating a temporary folder with no contents:
var fixtureDir = 'my-node-module-tests';;
Contributing
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint via grunt and test via npm test
.
Donating
Support this project and others by twolfson via gittip.
Unlicense
As of Apr 12 2014, Todd Wolfson has released this repository and its contents to the public domain.
It has been released under the UNLICENSE.