Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zhouzi/graphql-codegen-factories
Generate factories from a GraphQL schema and operations to mock data.
https://github.com/zhouzi/graphql-codegen-factories
factories graphql graphql-codegen mocking plugin testing
Last synced: about 12 hours ago
JSON representation
Generate factories from a GraphQL schema and operations to mock data.
- Host: GitHub
- URL: https://github.com/zhouzi/graphql-codegen-factories
- Owner: zhouzi
- License: mit
- Created: 2020-06-26T14:40:38.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-03-03T09:24:34.000Z (8 months ago)
- Last Synced: 2024-10-31T15:47:39.499Z (7 days ago)
- Topics: factories, graphql, graphql-codegen, mocking, plugin, testing
- Language: TypeScript
- Homepage: https://gabinaureche.com/graphql-codegen-factories/
- Size: 2.12 MB
- Stars: 29
- Watchers: 3
- Forks: 5
- Open Issues: 13
-
Metadata Files:
- Readme: readme.md
- Changelog: changelog.md
- Contributing: contributing.md
- License: license
Awesome Lists containing this project
README
# graphql-codegen-factories
  
`graphql-codegen-factories` is a plugin for [GraphQL Code Generator](https://www.graphql-code-generator.com/) that generates factories from a GraphQL schema and operations.
The factories can then be used to mock data, e.g for testing or seeding a database.
For example, given this GraphQL schema:
```graphql
type User {
id: ID!
username: String!
}
```
The following factory will be generated:
```typescript
export type User = /* generated by @graphql-codegen/typescript */;
export function createUserMock(props: Partial = {}): User {
return {
__typename: "User",
id: "",
username: "",
...props,
};
}
```
It is also possible to generate factories from an operation, for example:
```graphql
query GetUser {
user {
id
username
}
}
```
Will result in the following factories:
```typescript
export type GetUserQuery = /* generated by @graphql-codegen/typescript-operations */;
export function createGetUserQueryMock(props: Partial = {}): GetUserQuery {
return {
__typename: "Query",
user: createGetUserQueryMock_user({}),
...props,
};
}
export function createGetUserQueryMock_user(props: Partial = {}): GetUserQuery["user"] {
return {
__typename: "User",
id: "",
username: "",
...props,
};
}
```
You can also use a fake data generator to generate realistic factories such as:
```typescript
import { faker } from "@faker-js/faker";
export function createUserMock(props: Partial = {}): User {
return {
__typename: "User",
id: faker.random.alphaNumeric(16),
username: faker.lorem.word(),
...props,
};
}
```
- [Documentation](https://gabinaureche.com/graphql-codegen-factories/)
- [Examples](https://github.com/zhouzi/graphql-codegen-factories/tree/main/examples)
- [Minimal](https://stackblitz.com/github/zhouzi/graphql-codegen-factories/tree/main/examples/minimal)
- [Usage with near-operation-file-preset](https://stackblitz.com/github/zhouzi/graphql-codegen-factories/tree/main/examples/usage-with-near-operation-file-preset)
- [Usage with faker](https://stackblitz.com/github/zhouzi/graphql-codegen-factories/tree/main/examples/usage-with-faker)
## Showcase
- [yummy-recipes/yummy](https://github.com/yummy-recipes/yummy)
Are you using this plugin? [Let us know!](https://github.com/zhouzi/graphql-codegen-factories/issues/new)
## Contributors
[](https://github.com/zhouzi)
[](https://github.com/ertrzyiks)
[](https://github.com/jongbelegen)