Skip to content

fix(enum): propagate namingConvention.transformUnderscore to convertNameParts #828

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Nov 7, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -215,8 +215,6 @@ type: `NamingConventionMap` default: `{ enumValues: "change-case-all#pascalCase"

Uses the full path of the enum type as the default value instead of the stringified value.

Note: This option has not been tested with `namingConvention.transformUnderscore` and `namingConvention.typeNames` options and may not work as expected.

Related: https://the-guild.dev/graphql/codegen/docs/config-reference/naming-convention#namingconvention

### `directives`
Expand Down
2 changes: 1 addition & 1 deletion src/directive.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import type { ConstArgumentNode, ConstDirectiveNode, ConstValueNode } from 'graphql';
import { Kind, valueFromASTUntyped } from 'graphql';
import type { DirectiveConfig, DirectiveObjectArguments } from './config.js';

import { Kind, valueFromASTUntyped } from 'graphql';
import { isConvertableRegexp } from './regexp.js';

export interface FormattedDirectiveConfig {
Expand Down
2 changes: 1 addition & 1 deletion src/graphql.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ import type {
GraphQLSchema,
InterfaceTypeDefinitionNode,
ListTypeNode,
NamedTypeNode,
NameNode,
NamedTypeNode,
NonNullTypeNode,
ObjectTypeDefinitionNode,
TypeNode,
Expand Down
4 changes: 2 additions & 2 deletions src/index.ts
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
import type { PluginFunction, Types } from '@graphql-codegen/plugin-helpers';
import type { GraphQLSchema } from 'graphql';
import { transformSchemaAST } from '@graphql-codegen/schema-ast';
import { buildSchema, printSchema, visit } from 'graphql';
import type { ValidationSchemaPluginConfig } from './config.js';
import type { SchemaVisitor } from './types.js';

import { transformSchemaAST } from '@graphql-codegen/schema-ast';
import { buildSchema, printSchema, visit } from 'graphql';
import { isGeneratedByIntrospection, topologicalSortAST } from './graphql.js';
import { MyZodSchemaVisitor } from './myzod/index.js';
import { ValibotSchemaVisitor } from './valibot/index.js';
Expand Down
14 changes: 7 additions & 7 deletions src/myzod/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,23 +10,23 @@ import type {
TypeNode,
UnionTypeDefinitionNode,
} from 'graphql';
import type { ValidationSchemaPluginConfig } from '../config.js';
import type { Visitor } from '../visitor.js';

import { resolveExternalModuleAndFn } from '@graphql-codegen/plugin-helpers';
import { convertNameParts, DeclarationBlock, indent } from '@graphql-codegen/visitor-plugin-common';
import { DeclarationBlock, convertNameParts, indent } from '@graphql-codegen/visitor-plugin-common';
import {
Kind,
} from 'graphql';
import type { Visitor } from '../visitor.js';
import type { ValidationSchemaPluginConfig } from '../config.js';
import { buildApi, formatDirectiveConfig } from '../directive.js';
import {
escapeGraphQLCharacters,
InterfaceTypeDefinitionBuilder,
ObjectTypeDefinitionBuilder,
escapeGraphQLCharacters,
isInput,
isListType,
isNamedType,
isNonNullType,
ObjectTypeDefinitionBuilder,
} from '../graphql.js';
import { BaseSchemaVisitor } from '../schema_visitor.js';

Expand Down Expand Up @@ -290,10 +290,10 @@ function generateFieldTypeMyZodSchema(config: ValidationSchemaPluginConfig, visi

if (defaultValue?.kind === Kind.STRING || defaultValue?.kind === Kind.ENUM) {
if (config.useEnumTypeAsDefaultValue && defaultValue?.kind !== Kind.STRING) {
let value = convertNameParts(defaultValue.value, resolveExternalModuleAndFn('change-case-all#pascalCase'));
let value = convertNameParts(defaultValue.value, resolveExternalModuleAndFn('change-case-all#pascalCase'), config?.namingConvention?.transformUnderscore);

if (config.namingConvention?.enumValues)
value = convertNameParts(defaultValue.value, resolveExternalModuleAndFn(config.namingConvention?.enumValues));
value = convertNameParts(defaultValue.value, resolveExternalModuleAndFn(config.namingConvention?.enumValues), config?.namingConvention?.transformUnderscore);

appliedDirectivesGen = `${appliedDirectivesGen}.default(${visitor.convertName(type.name.value)}.${value})`;
}
Expand Down
4 changes: 2 additions & 2 deletions src/valibot/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,18 +10,18 @@ import type {
TypeNode,
UnionTypeDefinitionNode,
} from 'graphql';
import { DeclarationBlock, indent } from '@graphql-codegen/visitor-plugin-common';
import type { ValidationSchemaPluginConfig } from '../config.js';

import type { Visitor } from '../visitor.js';
import { DeclarationBlock, indent } from '@graphql-codegen/visitor-plugin-common';
import { buildApiForValibot, formatDirectiveConfig } from '../directive.js';
import {
InterfaceTypeDefinitionBuilder,
ObjectTypeDefinitionBuilder,
isInput,
isListType,
isNamedType,
isNonNullType,
ObjectTypeDefinitionBuilder,
} from '../graphql.js';
import { BaseSchemaVisitor } from '../schema_visitor.js';

Expand Down
2 changes: 1 addition & 1 deletion src/visitor.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,12 @@ import type {
NameNode,
ObjectTypeDefinitionNode,
} from 'graphql';
import type { ValidationSchemaPluginConfig } from './config.js';
import { TsVisitor } from '@graphql-codegen/typescript';

import {
specifiedScalarTypes,
} from 'graphql';
import type { ValidationSchemaPluginConfig } from './config.js';

export class Visitor extends TsVisitor {
constructor(
Expand Down
14 changes: 7 additions & 7 deletions src/yup/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,23 +10,23 @@ import type {
TypeNode,
UnionTypeDefinitionNode,
} from 'graphql';
import type { ValidationSchemaPluginConfig } from '../config.js';
import type { Visitor } from '../visitor.js';

import { resolveExternalModuleAndFn } from '@graphql-codegen/plugin-helpers';
import { convertNameParts, DeclarationBlock, indent } from '@graphql-codegen/visitor-plugin-common';
import { DeclarationBlock, convertNameParts, indent } from '@graphql-codegen/visitor-plugin-common';
import {
Kind,
} from 'graphql';
import type { Visitor } from '../visitor.js';
import type { ValidationSchemaPluginConfig } from '../config.js';
import { buildApi, formatDirectiveConfig } from '../directive.js';
import {
escapeGraphQLCharacters,
InterfaceTypeDefinitionBuilder,
ObjectTypeDefinitionBuilder,
escapeGraphQLCharacters,
isInput,
isListType,
isNamedType,
isNonNullType,
ObjectTypeDefinitionBuilder,
} from '../graphql.js';
import { BaseSchemaVisitor } from '../schema_visitor.js';

Expand Down Expand Up @@ -292,10 +292,10 @@ function shapeFields(fields: readonly (FieldDefinitionNode | InputValueDefinitio

if (defaultValue?.kind === Kind.STRING || defaultValue?.kind === Kind.ENUM) {
if (config.useEnumTypeAsDefaultValue && defaultValue?.kind !== Kind.STRING) {
let value = convertNameParts(defaultValue.value, resolveExternalModuleAndFn('change-case-all#pascalCase'));
let value = convertNameParts(defaultValue.value, resolveExternalModuleAndFn('change-case-all#pascalCase'), config?.namingConvention?.transformUnderscore);

if (config.namingConvention?.enumValues)
value = convertNameParts(defaultValue.value, resolveExternalModuleAndFn(config.namingConvention?.enumValues));
value = convertNameParts(defaultValue.value, resolveExternalModuleAndFn(config.namingConvention?.enumValues), config?.namingConvention?.transformUnderscore);

fieldSchema = `${fieldSchema}.default(${visitor.convertName(field.name.value)}.${value})`;
}
Expand Down
14 changes: 7 additions & 7 deletions src/zod/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,23 +10,23 @@ import type {
TypeNode,
UnionTypeDefinitionNode,
} from 'graphql';
import type { ValidationSchemaPluginConfig } from '../config.js';
import type { Visitor } from '../visitor.js';

import { resolveExternalModuleAndFn } from '@graphql-codegen/plugin-helpers';
import { convertNameParts, DeclarationBlock, indent } from '@graphql-codegen/visitor-plugin-common';
import { DeclarationBlock, convertNameParts, indent } from '@graphql-codegen/visitor-plugin-common';
import {
Kind,
} from 'graphql';
import type { Visitor } from '../visitor.js';
import type { ValidationSchemaPluginConfig } from '../config.js';
import { buildApi, formatDirectiveConfig } from '../directive.js';
import {
escapeGraphQLCharacters,
InterfaceTypeDefinitionBuilder,
ObjectTypeDefinitionBuilder,
escapeGraphQLCharacters,
isInput,
isListType,
isNamedType,
isNonNullType,
ObjectTypeDefinitionBuilder,
} from '../graphql.js';
import { BaseSchemaVisitor } from '../schema_visitor.js';

Expand Down Expand Up @@ -306,10 +306,10 @@ function generateFieldTypeZodSchema(config: ValidationSchemaPluginConfig, visito

if (defaultValue?.kind === Kind.STRING || defaultValue?.kind === Kind.ENUM) {
if (config.useEnumTypeAsDefaultValue && defaultValue?.kind !== Kind.STRING) {
let value = convertNameParts(defaultValue.value, resolveExternalModuleAndFn('change-case-all#pascalCase'));
let value = convertNameParts(defaultValue.value, resolveExternalModuleAndFn('change-case-all#pascalCase'), config.namingConvention?.transformUnderscore);

if (config.namingConvention?.enumValues)
value = convertNameParts(defaultValue.value, resolveExternalModuleAndFn(config.namingConvention?.enumValues));
value = convertNameParts(defaultValue.value, resolveExternalModuleAndFn(config.namingConvention?.enumValues), config.namingConvention?.transformUnderscore);

appliedDirectivesGen = `${appliedDirectivesGen}.default(${type.name.value}.${value})`;
}
Expand Down
2 changes: 1 addition & 1 deletion tests/directive.spec.ts
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
import type { ConstArgumentNode, ConstDirectiveNode, ConstValueNode, NameNode } from 'graphql';
import { Kind, parseConstValue } from 'graphql';
import type { DirectiveConfig, DirectiveObjectArguments } from '../src/config';

import type {
FormattedDirectiveArguments,
FormattedDirectiveConfig,
FormattedDirectiveObjectArguments,
} from '../src/directive';
import { Kind, parseConstValue } from 'graphql';
import {
buildApi,
buildApiForValibot,
Expand Down
4 changes: 2 additions & 2 deletions tests/graphql.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,16 @@ import type {
} from 'graphql';
import { Graph } from 'graphlib';
import {
Kind,
buildClientSchema,
buildSchema,
introspectionFromSchema,
Kind,
parse,
print,
} from 'graphql';
import dedent from 'ts-dedent';

import { escapeGraphQLCharacters, isGeneratedByIntrospection, ObjectTypeDefinitionBuilder, topologicalSortAST, topsort } from '../src/graphql';
import { ObjectTypeDefinitionBuilder, escapeGraphQLCharacters, isGeneratedByIntrospection, topologicalSortAST, topsort } from '../src/graphql';

describe('graphql', () => {
describe('objectTypeDefinitionBuilder', () => {
Expand Down
73 changes: 73 additions & 0 deletions tests/myzod.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1444,4 +1444,77 @@ describe('myzod', () => {
expect(result.content).toContain('ratio: myzod.number().default(0.5).optional().nullable()');
expect(result.content).toContain('isMember: myzod.boolean().default(true).optional().nullable()');
});

it('with default input values as enum types with underscores', async () => {
const schema = buildSchema(/* GraphQL */ `
enum PageType {
PUBLIC
BASIC_AUTH
}
input PageInput {
pageType: PageType! = BASIC_AUTH
greeting: String = "Hello"
score: Int = 100
ratio: Float = 0.5
isMember: Boolean = true
}
`);
const result = await plugin(
schema,
[],
{
schema: 'myzod',
importFrom: './types',
useEnumTypeAsDefaultValue: true,
},
{},
);

expect(result.content).toContain('export const PageTypeSchema = myzod.enum(PageType)');
expect(result.content).toContain('export function PageInputSchema(): myzod.Type<PageInput>');

expect(result.content).toContain('pageType: PageTypeSchema.default(PageType.Basic_Auth)');
expect(result.content).toContain('greeting: myzod.string().default("Hello").optional().nullable()');
expect(result.content).toContain('score: myzod.number().default(100).optional().nullable()');
expect(result.content).toContain('ratio: myzod.number().default(0.5).optional().nullable()');
expect(result.content).toContain('isMember: myzod.boolean().default(true).optional().nullable()');
});

it('with default input values as enum types with no underscores', async () => {
const schema = buildSchema(/* GraphQL */ `
enum PageType {
PUBLIC
BASIC_AUTH
}
input PageInput {
pageType: PageType! = BASIC_AUTH
greeting: String = "Hello"
score: Int = 100
ratio: Float = 0.5
isMember: Boolean = true
}
`);
const result = await plugin(
schema,
[],
{
schema: 'myzod',
importFrom: './types',
useEnumTypeAsDefaultValue: true,
namingConvention: {
transformUnderscore: true,
},
},
{},
);

expect(result.content).toContain('export const PageTypeSchema = myzod.enum(PageType)');
expect(result.content).toContain('export function PageInputSchema(): myzod.Type<PageInput>');

expect(result.content).toContain('pageType: PageTypeSchema.default(PageType.BasicAuth)');
expect(result.content).toContain('greeting: myzod.string().default("Hello").optional().nullable()');
expect(result.content).toContain('score: myzod.number().default(100).optional().nullable()');
expect(result.content).toContain('ratio: myzod.number().default(0.5).optional().nullable()');
expect(result.content).toContain('isMember: myzod.boolean().default(true).optional().nullable()');
});
});
77 changes: 77 additions & 0 deletions tests/yup.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1470,4 +1470,81 @@ describe('yup', () => {
expect(result.content).toContain('ratio: yup.number().defined().nullable().default(0.5).optional()');
expect(result.content).toContain('isMember: yup.boolean().defined().nullable().default(true).optional()');
});

it('with default input values as enum types with underscores', async () => {
const schema = buildSchema(/* GraphQL */ `
enum PageType {
PUBLIC
BASIC_AUTH
}
input PageInput {
pageType: PageType! = BASIC_AUTH
greeting: String = "Hello"
score: Int = 100
ratio: Float = 0.5
isMember: Boolean = true
}
`);
const result = await plugin(
schema,
[],
{
schema: 'yup',
importFrom: './types',
useEnumTypeAsDefaultValue: true,
},
{},
);

expect(result.content).toContain(
'export const PageTypeSchema = yup.string<PageType>().oneOf(Object.values(PageType)).defined()',
);
expect(result.content).toContain('export function PageInputSchema(): yup.ObjectSchema<PageInput>');

expect(result.content).toContain('pageType: PageTypeSchema.nonNullable().default(PageType.Basic_Auth)');
expect(result.content).toContain('greeting: yup.string().defined().nullable().default("Hello").optional()');
expect(result.content).toContain('score: yup.number().defined().nullable().default(100).optional()');
expect(result.content).toContain('ratio: yup.number().defined().nullable().default(0.5).optional()');
expect(result.content).toContain('isMember: yup.boolean().defined().nullable().default(true).optional()');
});

it('with default input values as enum types with no underscores', async () => {
const schema = buildSchema(/* GraphQL */ `
enum PageType {
PUBLIC
BASIC_AUTH
}
input PageInput {
pageType: PageType! = BASIC_AUTH
greeting: String = "Hello"
score: Int = 100
ratio: Float = 0.5
isMember: Boolean = true
}
`);
const result = await plugin(
schema,
[],
{
schema: 'yup',
importFrom: './types',
useEnumTypeAsDefaultValue: true,
namingConvention: {
transformUnderscore: true,
},
},
{},
);

expect(result.content).toContain(
'export const PageTypeSchema = yup.string<PageType>().oneOf(Object.values(PageType)).defined()',
);
expect(result.content).toContain('export function PageInputSchema(): yup.ObjectSchema<PageInput>');

expect(result.content).toContain('pageType: PageTypeSchema.nonNullable().default(PageType.BasicAuth)');
expect(result.content).toContain('greeting: yup.string().defined().nullable().default("Hello").optional()');
expect(result.content).toContain('score: yup.number().defined().nullable().default(100).optional()');
expect(result.content).toContain('ratio: yup.number().defined().nullable().default(0.5).optional()');
expect(result.content).toContain('isMember: yup.boolean().defined().nullable().default(true).optional()');
});
});
Loading
Loading