kettanaito / fs-teardown Goto Github PK

Specification

Lists a file tree under a given base directory. If no base directory is provided, lists the entire file tree.

• .ls(baseDir?: string): Promise<void>

Usage

const fsMock = fsTeardown(...)

// A bunch of runtime operations.

// List the entire file tree.
fsMock.ls()

// List a file tree at the given path.
fsMock.ls('dir/nested')

Useful to have a shorthand for:

const fs = require('fs')
const fsMock = fsTeardown({ ... })

const content = fs.readFileSync(fsMock.resolve('file.txt'))

// instead
fsMock.read('file.txt') // Promise<Buffer>

Creating utils that accept the pubilc API of fsTeardown is cumbersome:

function myUtil(fsMock: ReturnType<typeof fsTeardown>): void

Consider exporting the return type of the fsTeardown function.

fsMock.create({ '.eslintrc': null })

Creates a directory called .eslintrc instead of a dot-file. The issue is related to how path.extname extracts the extension of dot-files:

First off, thanks for creating this. It works exactly how I hoped it would. You've saved me a ton of time.

I wanted to suggest an alternate API that I've found a bit more useful. Rather than passing in multiple arguments for each file and directory, what do you think of something like this?

const { prepare, cleanup, getPath } = createTeardown({

    // specify the root directory
    root: "./foo",

    // specify the empty directories to create
    directories: [
        "bar",
        "baz"
    ],

    // specify the files to create
   files: {
       "foo.txt": "hello world"
   }
});

I ended up creating a function that let me pass in this format in my test: https://github.com/eslint/eslint/pull/13709/files#diff-b3f6d058d49aaa6e22207209e60174e9R38

Thanks again!