# mkfiletree

**Repository Path**: mirrors_rvagg/mkfiletree

## Basic Information

- **Project Name**: mkfiletree
- **Description**: Make a tree of files and directories by from data defined in an object
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-18
- **Last Updated**: 2026-07-18

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# mkfiletree

[![NPM](https://nodei.co/npm/mkfiletree.svg?style=flat&data=n,v&color=blue)](https://nodei.co/npm/mkfiletree/)

Serialize an object to a file/directory tree. Particularly useful for making test fixtures where you need to create a non-trivial tree of files and don't want to have to mock out `fs`. **See [readfiletree](https://github.com/rvagg/node-readfiletree) for file tree deserialization.**

## Requirements

Node.js >= 20

## API

### await makeTemp(prefix, tree)

Make a directory & file tree in the system's temporary directory, under a uniquely named subdirectory prefixed with the `prefix` argument. The returned value will be a `dir` telling you the full path to the root directory created for you.

Using both *mkfiletree* and *readfiletree* we can do the following:

```js
import * as mkfiletree from 'mkfiletree'
import { readfiletree } from 'readfiletree'

const directoryContents = {
  'adir': {
    'one.txt': '1\n2\n3\n',
    'two.txt': 'a\nb\nc\n',
    'deeper': {
      'depths.txt': 'whoa...'
    }
  },
  'afile.txt': 'file contents'
}

const dir = await mkfiletree.makeTemp('testfiles', directoryContents)
const obj = await readfiletree(dir)
console.log(obj)
```

The directory structure created above looks like the following:

```
$ find /tmp/testfiles11240-23530-r7rs3 -type f -exec sh -c "echo '\n{}: ' && cat '{}'" \;
  /tmp/testfiles11240-23530-r7rs3/afile.txt:
    file contents
    /tmp/testfiles11240-23530-r7rs3/adir/deeper/depths.txt:
    whoa...
    /tmp/testfiles11240-23530-r7rs3/adir/two.txt:
    a
    b
    c

    /tmp/testfiles11240-23530-r7rs3/adir/one.txt:
    1
    2
    3

```

And the output of the program should be the same as the input to *mkfiletree*:

```js
{
  'adir': {
    'one.txt': '1\n2\n3\n',
    'two.txt': 'a\nb\nc\n',
    'deeper': {
      'depths.txt': 'whoa...'
    }
  },
  'afile.txt': 'file contents'
}
```

### await cleanUp()

Clean up any temporary directories created with `makeTemp()` since the last `cleanUp()` call or the beginning of the current process.

### await make(root, tree)

Same as `makeTemp()` but you specify the exact root path *to be created* which will contain your directory tree. The returned value will be a `dir` telling you the full path to the root directory created for you.

Directories created with `make()` won't be removed with a `cleanUp()` call.

## License

**mkfiletree** is Copyright (c) 2014 Rod Vagg [@rvagg](https://github.com/rvagg) and licenced under the MIT licence. All rights not explicitly granted in the MIT license are reserved. See the included LICENSE.md file for more details.