# typeorm-fixturio

> TypeORM fixtures

Latest version **1.0.5** (published 2024-05-10) · MIT license · 0 weekly downloads

## Install

```sh
npm install typeorm-fixturio
pnpm add typeorm-fixturio
yarn add typeorm-fixturio
bun add typeorm-fixturio
```

Provides the command `typeorm-fixturio`.

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.5 |
| Published | 2024-05-10 |
| First published | 2023-07-03 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=18.12.1 |
| Dependencies | 2 |
| Unpacked size | 16.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | pashak09 |
| Maintainers | pashak09 |
| Keywords | typeorm, fixture, test, testing, e2e testing, database, mysql, postgresql |

## Links

- npm: https://www.npmjs.com/package/typeorm-fixturio
- Repository: https://github.com/pashak09/typeorm-fixturio
- npm.io page: https://npm.io/package/typeorm-fixturio

## Dependencies (2)

- [fixturio](https://npm.io/package/fixturio.md) ^1.0.2
- [typeorm-extension](https://npm.io/package/typeorm-extension.md) ^3.5.1

## Alternatives

- [@libsql/sqlite3](https://npm.io/package/@libsql/sqlite3.md) — 39.8K weekly downloads
- [@fortemi/core](https://npm.io/package/@fortemi/core.md) — 461 weekly downloads
- [cdb-converter](https://npm.io/package/cdb-converter.md) — 341 weekly downloads
- [@uplo/adapter-prisma](https://npm.io/package/@uplo/adapter-prisma.md) — 75 weekly downloads
- [typeorm-aios](https://npm.io/package/typeorm-aios.md) — 30 weekly downloads

## Recent versions

- 1.0.5 (latest) — 2024-05-10
- 1.0.4 — 2023-09-14
- 1.0.3 — 2023-09-14
- 1.0.2 — 2023-09-14
- 0.0.9 — 2023-07-11
- 0.0.2 — 2023-07-03

## README

# typeorm-fixturio

<p align="center">
  <a href="https://github.com/pashak09/typeorm-fixturio/actions">
    <img src="https://github.com/pashak09/typeorm-fixturio/actions/workflows/ci.yml/badge.svg" alt="test" />
  </a>
  <a href="https://coveralls.io/github/pashak09/typeorm-fixturio?branch=master">
    <img src="https://coveralls.io/repos/github/pashak09/typeorm-fixturio/badge.svg?branch=master" alt="Coverage Status" />
  </a>
  <a href="https://www.npmjs.com/package/typeorm-fixturio">
    <img src="https://img.shields.io/npm/v/typeorm-fixturio" alt="npm shield" />
  </a>
</p>

### Installation

```bash
yarn add -D typeorm-fixturio
```

### Options

| Option         | Short | Type     | Description                                                   |
|----------------|-------|----------|---------------------------------------------------------------|
| recreate       |       | boolean  | Determines whether to recreate the database                   |
| runMigration   |       | boolean  | Determines whether to run the migration                       |
| quiet          |       | boolean  | Suppresses console output during execution                    |
| autoPersist    |       | boolean  | Automatic entity saving                                       |
| dataSourceFile | -d    | string   | Path to the orm data source file                              |
| containerFile  |       | string   | Path to the container file                                    |
| filePatterns   |       | string[] | Array of fixture patterns to match and process multiple files |

For `autoPersist` flag you don't need to save entities manually you need just return the entities for saving in fixture'
s
install method. Notice that entity resolver can work only with a flat object and an array returned types. An example

```ts
async install(): Promise < UserFixtureResultOf > {
  const tag1 = new Tag('tag_1');
  const tag2 = new Tag('tag_1');

  return {tag1, tag1}
  //or
  return [tag2, tag2]
}
```

if `autoPersist` option is disabled the entities have to be saved manually. EntityManager is provided by default(configured
from the `dataSourceFile` option).

```ts
import { FixtureInterface } from 'fixturio';
import { EntityManager } from 'typeorm';
import { User } from '../entity/User';

type UserFixtureResultOf = {
    readonly firstUser: User;
};

export class UserFixture implements FixtureInterface<UserFixtureResultOf>, DependencyInjectable {
    constructor(private readonly entityManager: EntityManager) {}

    getInjectDependencies(): readonly InjectDependency[] {
        return [EntityManager];
    }

    async install(): Promise<UserFixtureResultOf> {
        const firstUser = new User(1, 'user_1');

        await this.entityManager.save([firstUser]);

        return {
            firstUser,
        };
    }
}
```

An example how to run cli command

```json
//package.json
...
"scripts": {
"prepare-database": "node -r ts-node/register -r tsconfig-paths/register ./node_modules/typeorm-fixturio/dist/cli.js -d ormconfig.ts --filePatterns 'tests/fixtures/**/*.ts' --recreate --runMigration"
}
//...
```

This library is based on https://github.com/pashak09/fixturio

### Examples

Examples of usage can be found in <a href="https://github.com/pashak09/typeorm-fixturio/tree/master/examples">
examples</a> folder

### License

MIT

---
_Source: https://npm.io/package/typeorm-fixturio · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._