@eddeee888/gcg-typescript-resolver-files

This GraphQL Code Generator plugin creates resolvers given GraphQL schema.

This relies on types generated from typescript and @graphql-codegen/typescript-resolvers plugins.

yarn add -D @eddeee888/gcg-typescript-resolver-files
yarn add graphql-scalars

Features

• Generates opinionated folder/file structure with type-safety in mind to help finding query, mutation or object types easily
• Does NOT overwrite existing resolver logic
• Detects missing / wrong resolver exports and adds them to resolver files
• Automatically sets up GraphQL Scalars with types and config from graphql-scalars with ability to opt-out
• Automatically extracts object type mapper interfaces and types (marked with Mapper suffix) from accompanying .mappers.ts files in each module. For example, if the schema file is /path/to/schema.graphql, the mapper file is /path/to/schema.mappers.ts.

Example

Setup

# src/graphql/modules/base/schema.graphqls
type Query

# src/graphql/modules/user/schema.graphqls
extend type Query {
  user(id: ID!): User
}

type User {
  id: ID!
  fullName: String!
}

type Address {
  id: ID!
  address: String!
}

// src/graphql/modules/user/schema.mappers.graphqls

// Exporting the following Mapper interfaces and types is the equivalent of this codegen config:
// ```yml
// mappers:
//   Address: './user/schema.mappers#AddressMapper'
//   User: './user/schema.mappers#UserMapper'
// ```

export { Address as AddressMapper } from 'address-package';

export interface UserMapper {
  id: string;
  firstName: string;
  lastName: string;
}

# codegen.yml
schema: '**/*.graphqls'
generates:
  src/graphql/modules:
    preset: '@eddeee888/gcg-typescript-resolver-files'

Result

Running codegen will generate the following files:

• src/graphql/modules/user/resolvers/Query/user.ts
• src/graphql/modules/user/resolvers/User.ts
• src/graphql/modules/user/resolvers/Address.ts
• src/graphql/modules/resolvers.generated.ts
• src/graphql/modules/typeDefs.generated.ts
• src/graphql/modules/types.generated.ts

Config