fs-teardown

Teardown API for testing file system-dependent code.

Getting started

``sh
$ npm install fs-teardown -D


or


$ yan add fs-teardown -D
`

API

$3

Calling the createTeardown function returns you the API to create the specified file system structure and clean it up on demand.

`js
const api = createTeardown({
rootDir: './example',
})
`

You can specify an optional paths property to describe an initial directory/file tree.

`js
createTeardown({
rootDir: './example',
paths: {
'empty.txt': null,
'file.txt': 'hello world',
'src/hooks': {
'useField.js': null,
},
},
})
`

> Providing a relative path to the rootDir creates the given path at the system's default directory for temporary files (os.tmpdir). Absolute paths are used as-is.

$3

Creates files and directories specified in the operations of the teardown. Returns a Promise that resolves once all the operations have been executed.

$3

Creates a file tree relative to the root directory after the initial setup.

`js
const api = createTeardown({
rootDir: './example',
})

await api.create({
'file.txt': 'hello world',
'directory/another-file.txt': 'hello to you',
})
`

$3

Returns an absolute path to the given file or directory relative to the rootDir of the teardown. Useful to reference a certain file or directory in the created file structure.

`js
const api = createTeardown({
rootDir: './example',
paths: {
'file.txt': 'hello world',
},
})

const filePath = api.resolve('file.txt')
// "/Users/admin/example/file.txt"
`

$3

Reads a file at the given path.

By default, returns the Buffer of the read file. Provide the second encoding argument to convert the buffer to the given encoding.

`js
const api = createTeardown({
rootDir: './example',
paths: {
'file.txt': 'hello world'
}
})

// Read the "file.txt" content as Buffer.
const buffer = await api.readFile('file.txt')

// Read the "file.txt" content as text.
const text = await api.readFile('file.txt', 'utf8)
`

$3

Edits a file at the given path. Throws an error if the given file doesn't exist.

`js
const api = createTeardown({
rootDir: './example',
paths: {
'file.txt': 'hello world',
},
})

await api.edit('file.txt', 'welcome to the jungle')
`

$3

Executes the given command in the mocked directory.

`js
const api = createTeardown({
rootDir: 'exec',
})

// Initiates a new Git repository at the mocked directory.
await api.exec('git init')
`

$3

Resets the root directory to its initial state.

`js
const api = createTeardown({
rootDir: './example',
paths: {
'file.txt': 'hello world',
'dir/nested.txt': null,
},
})

// Runtime actions.
await api.edit('file.txt', 'welcome to the jungle')
await api.remove('dir')

await api.restore()
// - "file.txt" was restored to "hello world";
// - "dir" and "dir/nested.txt" were restored.
`

$3

Removes the root directory of the teardown. Returns a Promise that resolves once the directory is removed.

`js
await api.cleanup()
`

Recipes

$3

`js
fsMocks.create({
'filename.ext': null,
})
`

$3

`js
api.create({
'file.txt': 'hello world',
})
`

$3

`js
api.create({
'file.json': JSON.stringify({ a: 1 }, null, 2),
})
`

> Note that the JSON file's content must be a string. Object values are treated as nested files.

$3

`js
api.create({
'empty-dir': null,
})
`

> Keys without extensions are treated as directories.

$3

`js
api.create({
'one/to/three': null,
})
`

$3

`js
api.create({
'deeply/nested/directory': {
'one.txt': 'first file',
'two.txt': 'second file',
},
})
``