- Notifications
You must be signed in to change notification settings - Fork1
Creates a temporary folder inside cwd, cds inside the folder, runs a function, and removes the folder. Especially useful for testing.
License
dword-design/with-local-tmp-dir
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
Creates a temporary folder inside cwd, cds inside the folder, runs a function, and removes the folder. Especially useful for testing.
This package can be used to write file-based tests with real files. See below for some examples.
# npm$ npm install with-local-tmp-dir# Yarn$ yarn add with-local-tmp-dir
constwithLocalTmpDir=require('with-local-tmp-dir')constfs=require('fs-extra')awaitwithLocalTmpDir(()=>{console.log(process.cwd())//> /Users/max/project/tmp-18815DudQxmdn03Rz// Create some filesawaitfs.outputFile('foo.txt','foo bar')awaitfs.outputFile('bar.txt','foo bar')})// Now the folder does not exist anymore// The folder is removed even if an exception is thrownawaitwithLocalTmpDir(()=>thrownewError('File could not be found'))
Instead of a function you can reset the state yourself instead of passing a function, i.e. change to the previous folder and remove the folder:
constwithLocalTmpDir=require('with-local-tmp-dir')constfs=require('fs-extra')// You can still pass optionsconstreset=awaitwithLocalTmpDir()console.log(process.cwd())//> /Users/max/project/tmp-18815DudQxmdn03Rz// Create some filesawaitfs.outputFile('foo.txt','foo bar')awaitfs.outputFile('bar.txt','foo bar')awaitreset()// Now the folder does not exist anymore
You can specify an options object that is passed down totmp-promise. Check the readme for details. Some default values are adjusted, but they still can be overridden.
constwithLocalTmpDir=require('with-local-tmp-dir')constfs=require('fs-extra')// do not cleanup if there are filesawaitwithLocalTmpDir(()=>{awaitfs.outputFile('foo.txt','foo bar')},{unsafeCleanup:false})// run in a subfolderawaitwithLocalTmpDir(()=>{console.log(process.cwd())//> /Users/max/project/foo/tmp-18815DudQxmdn03Rz},{dir:'foo'})// use a different prefixawaitwithLocalTmpDir(()=>{console.log(process.cwd())//> /Users/max/project/foo-18815DudQxmdn03Rz},{prefix:'foo'})
The most common use case for this package is probably unit tests with Mocha or Jest. The package itself is framework-agnostic, so you can use any of them. To make life easier when writing multiple files with multi-line text content, there are two handy packages: output-files andendent.
The following is an example for Mocha:
constwithLocalTmpDir=require('with-local-tmp-dir')constoutputFiles=require('output-files')constendent=require('endent')constfuncToTest=require('.')beforeEach(asyncfunction(){this.resetWithLocalTmpDir=awaitwithLocalTmpDir()})afterEach(asyncfunction(){awaitthis.resetWithLocalTmpDir()})it('works',async()=>{awaitoutputFiles({'foo.txt':endent` Lorem ipsum dolor sit `,'index.js':endent` export default { foo: 1, bar: 2, } `,})funcToTest()})
It is also possible to test libraries that make use of Git. You can instantiate a local Git repository inside the temporary folder and run Git operations on it:
constwithLocalTmpDir=require('with-local-tmp-dir')constfs=require('fs-extra')constexeca=require('execa')beforeEach(asyncfunction(){this.resetWithLocalTmpDir=awaitwithLocalTmpDir()})afterEach(asyncfunction(){awaitthis.resetWithLocalTmpDir()})it('works',async()=>{awaitexeca.command('git init')awaitexeca.command('git config user.email "foo@bar.de"')awaitexeca.command('git config user.name "foo"')awaitoutputFile('foo.txt','foo bar')awaitexeca.command('git add .')awaitexeca.command('git commit -m "feat: init"')funcToTest()})
Be careful though, if the repository is not properly initialized, your user Git config might be overridden!
Are you missing something or want to contribute? Feel free to file anissue or apull request! ⚙️
Hey, I am Sebastian Landwehr, a freelance web developer, and I love developing web apps and open source packages. If you want to support me so that I can keep packages up to date and build more helpful tools, you can donate here:
Thanks a lot for your support! ❤️
- output-files: Output a tree of files and directories by providing an object. Especially useful for testing with real files.
- expect-mocha-image-snapshot: A wrapper around jest-image-snapshot that makes it compatible to Mocha.
- jest-image-matcher: A Jest matcher for image comparisons based on pixelmatch. Can also be used with Mocha. Useful for visual regression testing.
- unify-mocha-output: Adjusts a Mocha output so that it is consistent across platforms and can be used for snapshot testing. Basically adjusts the checkmark symbol and removes time values.
- mock-argv: Temporarily overrides the command line arguments. This is useful for testing.
About
Creates a temporary folder inside cwd, cds inside the folder, runs a function, and removes the folder. Especially useful for testing.
