moeriki/temporarily

Create temporary directories and files.

temporarily

Create temporary directories and files.

---

Install

npm install --save temporarily

Why

There are a few other temporary file creation utilities. Here's why I made my own.

• cleanup by default (on process exit), no opt-out (though you may clean up early if necessary)
• sync by default, meant for testing
• easy nested dir / file scaffolding with content

Usage

const temp = require('temporarily');
// or
const { dir, file, filepath } = require('temporarily');
// or
import { dir, file, filepath } from 'temporarily';

API

filepath

Generate a filepath. No file is created.

filepath( [options:object] )

• options.dir :string – default os.tmpdir()
• options.ext :string
• options.name :string – default temporarily-{wwwwdddd}

filepath();
// '/var/folders/30/T/temporarily-tkEK6023'

filepath({ ext: 'json' });
// '/var/folders/30/T/temporarily-tkEK6023.json'

filepath({ dir: os.homedir() });
// '/home/myuser/temporarily-tkEK6023'

filepath({ name: 'file-{wwdd}' });
// '/var/folders/30/T/file-tk60'

file

Create a temporary file.

file( [options:object] )

• options.data :string|Buffer – default ''
• options.encoding :string – default 'utf8'
• options.mode :string – default 0o666

All options from filepath can be applied as well.

file();
// { data: '',
//   filepath: '/var/folders/30/T/temporarily-RdgC6481',
//   mode: 438,
//   cleanup: [Function: cleanup] }

file({ mode: 0o777 });
// { data: '',
//   filepath: '/var/folders/30/T/temporarily-RdgC6481',
//   mode: 511,
//   cleanup: [Function: cleanup] }

file({ data: 'Hello World!' }); // write file contents
// { data: 'Hello World!',
//   filepath: '/var/folders/30/T/temporarily-RdgC6481',
//   mode: 438,
//   cleanup: [Function: cleanup] }

dir

Create a temporary directory.

dir( [options:object], [children:Array<object>] )

• options.mode :string – default 0o777

All options from filepath can be applied as well.

dir();
// { filepath: '/var/folders/30/T/temporarily-tkEK6023',
//   mode: 511,
//   cleanup: [Function: cleanup] }

dir({ dir: os.homedir() });
// { filepath: '/home/myuser/temporarily-tkEK6023',
//   mode: 511,
//   cleanup: [Function: cleanup] }

dir({ mode: 0o666 });
// { filepath: '/var/folders/30/T/temporarily-tkEK6023',
//   mode: 438,
//   cleanup: [Function: cleanup] }

dir({ name: 'tempo' }, [
  dir([
    file({ name: 'nestedFile' }),
  ]),
  file({ data: 'Hello World!' }),
])
// { filepath: '/var/folders/30/T/tempo',
//   mode: 511,
//   cleanup: [Function: cleanup],
//   children:
//    [ { filepath: '/var/folders/30/T/tempo/temporarily-MwpX5662',
//        mode: 511,
//        cleanup: [Function: cleanup],
//        children:
//         [ { data: '',
//             filepath: '/var/folders/30/T/tempo/temporarily-MwpX5662/nestedFile',
//             mode: 438,
//             cleanup: [Function: cleanup] } ] },
//      { data: 'Hello World!',
//        filepath: '/var/folders/30/T/tempo/temporarily-yxYz6104',
//        mode: 438,
//        cleanup: [Function: cleanup] } ] }

temporarily's Issues

Document cleanup

Hello!

I see that cleanup is being exported, which is useful in some testing scenarios. However, it's not documented in the README and I wonder if it's safe for me to assume that it's part of the public API.

Thanks.

TypeError [ERR_INVALID_CALLBACK]: Callback must be a function

fs.js:167
    throw new ERR_INVALID_CALLBACK();
    ^

TypeError [ERR_INVALID_CALLBACK]: Callback must be a function
    at makeCallback (fs.js:167:11)
    at Object.fs.rmdir (fs.js:810:14)
    at D:\Dev\config-locator\node_modules\temporarily\build\index.js:91:20
    at Array.forEach (<anonymous>)
    at process.cleanup (D:\Dev\config-locator\node_modules\temporarily\build\ind
ex.js:87:9)
    at process.emit (events.js:187:15)
    at processEmit [as emit] (D:\Dev\config-locator\node_modules\nyc\node_module
s\signal-exit\index.js:149:35)

It seems that it should use the synced version of rmdir:
https://github.com/Moeriki/temporarily/blob/44831a329368ac7456f459fa96d8b845f7ecfc0d/build/index.js#L91

node v10.4.1

The repository link is broken

Steps to reproduce:

1. go to https://www.npmjs.com/package/temporarily
2. click the "repository" link on the right

Duplicated filename problem

If the file tree contains duplicated filename, it would fail to create the file tree in some cases. This would work:

const {dir, file} = require("temporarily");
dir([
    dir([
        file({name: "foo.txt"})
    ]),
    file({name: "foo.txt"})
]);

https://runkit.com/embed/7z186vonwegw

This would not:

const {dir, file} = require("temporarily");
dir([
    file({name: "foo.txt"}),
    dir([
        file({name: "foo.txt"})
    ])
]);

https://runkit.com/embed/agf3dwbmamjs

The first foo.txt is overwritten by the second foo.txt. I think:

1. The module should throw an error when a file is overwritten that it can't handle this situation.
2. Maybe adding an option finalName? which acts like a filename but it is only used in renaming (i.e. use a random name for creation), so the overwritten would never happen.