https://github.com/kaelzhang/node-test-fixture

Copy test-fixtures to temp dir and resolve files.
https://github.com/kaelzhang/node-test-fixture

nodejs test test-fixtures

Last synced: 8 days ago
JSON representation

Copy test-fixtures to temp dir and resolve files.

• Host: GitHub
• URL: https://github.com/kaelzhang/node-test-fixture
• Owner: kaelzhang
• License: other
• Created: 2014-06-07T13:58:04.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2019-08-17T02:56:55.000Z (over 5 years ago)
• Last Synced: 2024-12-06T05:16:31.103Z (17 days ago)
• Topics: nodejs, test, test-fixtures
• Language: JavaScript
• Size: 28.3 KB
• Stars: 1
• Watchers: 3
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Build Status](https://travis-ci.org/kaelzhang/node-test-fixture.svg?branch=master)](https://travis-ci.org/kaelzhang/node-test-fixture)

[![Coverage](https://codecov.io/gh/kaelzhang/node-test-fixture/branch/master/graph/badge.svg)](https://codecov.io/gh/kaelzhang/node-test-fixture)

# test-fixture

Copy test fixtures to a temp dir and get resolved file paths.

### Why?

I am tired of writing these:

```js

path.resolve(__dirname, 'test', 'fixtures')

tmp.dir(callback)

fse.copy(fixtures, dir)

path.join(fixtures, 'some-file.js')

```

**EVERY DAY!**

So, I got this.

## Install

```bash

$ npm i test-fixture -D

```

## Usage

```js

// By default, it will use 'test/fixtures' dir.

const {copy, resolve} = require('test-fixture')()

// copy 'test/fixtures' to the temp dir

;(async () => {

  await copy()

  console.log(resolve('foo.js'))

  // '//foo.js'

})

```

### fixtures(...paths): {resolve, copy, install, root}

- **paths** `Array` to define the root paths of the fixtures, which is similar as

Defines the root of the fixture

```js

const path = require('path')

const fixturesRoot = path.resolve(projectRoot, 'test', 'fixtures')

path.resolve(fixturesRoot, ...paths)

```

`...paths` | `base`(dir of test fixtures)

--------- | --------------------

`undefined` | `test/fixtures`

`'a'` | `test/fixtures/a`

`'a'`, `'b'` | `test/fixtures/a/b`

`'/path/to'` (absolute) | `/path/to`

`'/path/to'` (absolute), `'a'` | `/path/to/a`

Actually, the `base` is `path.resolve('text/fixtures', ...paths)`

#### Without copying

```js

const {resolve} = fixtures(p)

resolve('a.js')  // -> /path/to/
/a.js

```

#### Using `.copy()`

```js

const {copy, resolve} = fixtures(p)

await copy('/path/to')

resolve('a.js') // -> /path/to/a.js

```

### await copy(options?)

### await copy(to?)

- **options?** `Object`

  - **to?** `path=` the destination folder where the test fixtures will be copied to. If not specified, a temporary directory will be used.

  - **clean?** `boolean=false` whether should clean the directory `to` if `options.to` is specified.

  - **install?** `boolean=false` whether should run npm install after copying

Copy the test fixtures into another directory.

```js

copy('/path/to')

// is equivalent to

copy({

  to: '/path/to',

  install: false

})

```

### resolve(...paths)

Resolves the paths to get the path of the test fixtures

After `.copy()`ed, it will resolve paths based on the destination dir.

If not, it will use the base dir. But never use both of them simultaneously.

```

/path/to/

             |-- a.js

/path/to/

           |-- a.js

```

### await install(options?)

- **options?** `Object` options of [`npminstall`](https://npmjs.org/package/npminstall)

Install packages in the working directory. If run after `await copy()`, then it will install packages in the directory which fixtures copied to.

### getter: root `string`

The fixture root `//test/fixtures`

## License

[MIT](LICENSE)