rodmax/factory-t

Library for building JavaScript/TypeScript objects... with strong typing in mind

factory-t

pronounced like ˈfakt(ə)rē tē

TypeScript library for building data objects.
Useful for unit tests and mocking data during development
With strong typing in mind

Goals

• Provide factory for building data objects based on predefined config
• Factory instance should strongly depends from target TypeScript interface, so if interface will changed factory should not be built until syncing with interface changes
• All kind of API "sugar" appreciated but with typings in mind

Install

npm install factory-t

Usage

To start you need

• Design your data type

interface UserDto {
    id: number;
    email: string;
    phone: string | null;
    profile: {
        avatarUrl: string;
        language: 'EN' | 'RU';
        statusString?: string;
    };
}

• Import right tools

import { factoryT, fields } from 'factory-t';

• create factory (or bunch of factories)

const profileFactory = factoryT<UserDto['profile']>({
    avatarUrl: 'my.site/avatar',
    language: fields.sequence(['EN', 'RU']),
    statusString: fields.optional('sleeping'),
});

const userFactory = factoryT<UserDto>({
    id: fields.index(),
    email: (ctx) => `user-${ctx.index}@g.com`,
    phone: fields.nullable('+127788'),
    profile: (ctx) => profileFactory.item({ avatarUrl: `/avatars/${ctx.index}` }),
});

• and use it to build objects

expect(userFactory.item({ phone: null })).toStrictEqual({
    id: 1,
    email: '[email protected]',
    phone: null, // override by passed partial to item(...)
    profile: {
        avatarUrl: '/avatars/1', // override by userFactory using its index
        language: 'EN',
        statusString: 'sleeping',
    },
});

See tutorial or/and unit test for details

Status

I use this library in all current projects (mostly for unit tests)

In my opinion it has simple implementation so if you like its API, you can try use it too

Similar projects

rosie - nice library, good intuitive API.

if you write on JavaScript, it should solve all your needs.

The main drawback is typings. This library has @types/rosie but it uses "builder" pattern which not allows to strong type checking between factory and target interface

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

For more details see development guide

License

MIT

factory-t's Issues

bug: handle case when object or array passed to key directly

const factory = new FactoryT<{key: {nested: string}}>({
    key: {nested: '123'} // !!! seems not working
});
``

Add prettier

Action Required: Fix Renovate Configuration

There is an error with this repository's Renovate configuration that needs to be fixed. As a precaution, Renovate will stop PRs until it is resolved.

Location: .github/renovate.json
Error type: The renovate configuration file contains some invalid settings
Message: Configuration option 'ignorePaths' should be a list (Array)

chore: use sonar's code coverage instead of separate codecov service if possible

It seems sonar has its own coverage ability. if it is suitable, we need use it and remove codecov service from CI flow

Remove `makeSequenceFromEnum` helper due to wrong typing

TODO: explain reason and new approach

Optional properties cannot be added with partial param unless defined in the factory

Hi @rodmax,

First, I wanted to thank you for this great library. Lightweight, with strong typings, and it has covered all my use cases so far. Awesome job!

I found an issue when working with optional properties, though. Usually, optional properties are not included in the factory definition (that's why they are optional, right?). However, at this point, it's not possible to add a value for an optional property using the partial param of .item(..) for example.

The only workaround I found is to set the property in the factory definition as undefined. But IMHO, I think that defies the purpose of an optional property, and it's also a little cumbersome to add undefined for all optional properties to avoid this issue.

Here's an example in a small playground I created: https://codesandbox.io/s/factory-t-playground-r9ueq?file=/src/index.ts

Let me know if this makes sense to you. Also, I'll be happy to help out with a PR if you point me in the right direction.

Cheers!

README: add info about release workflow

changelog bump, etc

bug: exception when call buildList({count: 0})

When call buildList with only count param which equal to 0 method throws error

factory.buildList({ count: 0})

Fix typo: makeSequen**s**eFromEnum -> makeSequen**c**eFromEnum

chore(ci): migrate from travis-ci.org to travis-ci.com

Dependency Dashboard

This issue provides visibility into Renovate updates and their statuses. Learn more

Other Branches

These updates are pending. To force PRs open, click the checkbox below.

• chore(deps): update dependency semver-regex to 3.1.3 [security]
• chore(deps): update dependency tmpl to 1.0.5 [security]

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• chore(deps): update dependency @types/jest to v27.0.2
• chore(deps): update dependency jest to v27.2.5
• fix(deps): update dependency typescript to v3.9.10
• chore(deps): update commitlint monorepo (@commitlint/cli, @commitlint/config-conventional)
• chore(deps): update dependency eslint-plugin-jest to v24.7.0
• chore(deps): update typescript-eslint monorepo to v4.33.0 (@typescript-eslint/eslint-plugin, @typescript-eslint/parser)
• chore(deps): update actions/setup-node action to v2
• chore(deps): update dependency eslint to v8
• chore(deps): update dependency eslint-plugin-jest to v25
• chore(deps): update typescript-eslint monorepo to v5 (major) (@typescript-eslint/eslint-plugin, @typescript-eslint/parser)
• fix(deps): update dependency typescript to v4
• Click on this checkbox to rebase all open PRs at once

---

• Check this box to trigger a request for Renovate to run again on this repository

Migrate from ts-lint to eslint