Skip to content

feat: add typesTransformUnderscore config option #61

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.

Sign up for GitHub

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
Oct 20, 2021
Merged

feat: add typesTransformUnderscore config option #61

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
911c51d
feat: add `typesTransformUnderscore` config option
sebvilhelm Oct 19, 2021
7ca81bf
fix: Rename option to `transformUnderscore`
sebvilhelm Oct 20, 2021
5110dd4
fix: Pass `transformUnderscore` to all conversions
sebvilhelm Oct 20, 2021
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
4 changes: 4 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,10 @@ export const aUser = (overrides?: Partial<User>): User => {
}
```

### transformUnderscore (`boolean`, defaultValue: `true`)

When disabled, underscores will be retained for type names when the case is changed. It has no effect if `typenames` is set to `keep`.

## Example of usage

**codegen.yml**
Expand Down
48 changes: 38 additions & 10 deletions src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,21 +20,34 @@ type Options<T = TypeNode> = {
enumsPrefix: string;
currentType: T;
customScalars?: ScalarMap;
transformUnderscore: boolean;
};

const convertName = (value: string, fn: (v: string) => string, transformUnderscore: boolean): string => {
if (transformUnderscore) {
return fn(value);
}

return value
.split('_')
.map((s) => fn(s))
.join('_');
};

const createNameConverter =
(convention: NamingConvention) =>
(convention: NamingConvention, transformUnderscore: boolean) =>
(value: string, prefix = '') => {
switch (convention) {
case 'upper-case#upperCase':
return `${prefix}${upperCase(value || '')}`;
case 'upper-case#upperCase': {
return `${prefix}${convertName(value, (s) => upperCase(s || ''), transformUnderscore)}`;
}
case 'keep':
return `${prefix}${value}`;
case 'pascal-case#pascalCase':
// fallthrough
default:
// default to pascal case in case of unknown values
return `${prefix}${pascalCase(value || '')}`;
return `${prefix}${convertName(value, (s) => pascalCase(s || ''), transformUnderscore)}`;
}
};

Expand All @@ -46,8 +59,8 @@ const toMockName = (typedName: string, casedName: string, prefix?: string) => {
return `${a(firstWord, { articleOnly: true })}${casedName}`;
};

const updateTextCase = (str: string, enumValuesConvention: NamingConvention) => {
const convert = createNameConverter(enumValuesConvention);
const updateTextCase = (str: string, enumValuesConvention: NamingConvention, transformUnderscore: boolean) => {
const convert = createNameConverter(enumValuesConvention, transformUnderscore);

if (str.charAt(0) === '_') {
return str.replace(
Expand Down Expand Up @@ -91,7 +104,7 @@ const getNamedType = (opts: Options<NamedTypeNode>): string | number | boolean =

casual.seed(hashedString(opts.typeName + opts.fieldName));
const name = opts.currentType.name.value;
const casedName = createNameConverter(opts.typenamesConvention)(name);
const casedName = createNameConverter(opts.typenamesConvention, opts.transformUnderscore)(name);
switch (name) {
case 'String':
return `'${casual.word}'`;
Expand All @@ -109,11 +122,15 @@ const getNamedType = (opts: Options<NamedTypeNode>): string | number | boolean =
switch (foundType.type) {
case 'enum': {
// It's an enum
const typenameConverter = createNameConverter(opts.typenamesConvention);
const typenameConverter = createNameConverter(
opts.typenamesConvention,
opts.transformUnderscore,
);
const value = foundType.values ? foundType.values[0] : '';
return `${typenameConverter(foundType.name, opts.enumsPrefix)}.${updateTextCase(
value,
opts.enumValuesConvention,
opts.transformUnderscore,
)}`;
}
case 'union':
Expand Down Expand Up @@ -206,8 +223,9 @@ const getMockString = (
addTypename = false,
prefix,
typesPrefix = '',
transformUnderscore: boolean,
) => {
const typenameConverter = createNameConverter(typenamesConvention);
const typenameConverter = createNameConverter(typenamesConvention, transformUnderscore);
const casedName = typenameConverter(typeName);
const casedNameWithPrefix = typenameConverter(typeName, typesPrefix);
const typename = addTypename ? `\n __typename: '${casedName}',` : '';
Expand Down Expand Up @@ -246,15 +264,17 @@ const getImportTypes = ({
typesFile,
typesPrefix,
enumsPrefix,
transformUnderscore,
}: {
typenamesConvention: NamingConvention;
definitions: any;
types: TypeItem[];
typesFile: string;
typesPrefix: string;
enumsPrefix: string;
transformUnderscore: boolean;
}) => {
const typenameConverter = createNameConverter(typenamesConvention);
const typenameConverter = createNameConverter(typenamesConvention, transformUnderscore);
const typeImports = typesPrefix?.endsWith('.')
? [typesPrefix.slice(0, -1)]
: definitions
Expand Down Expand Up @@ -296,6 +316,7 @@ export interface TypescriptMocksPluginConfig {
terminateCircularRelationships?: boolean;
typesPrefix?: string;
enumsPrefix?: string;
transformUnderscore?: boolean;
}

interface TypeItem {
Expand All @@ -316,6 +337,7 @@ export const plugin: PluginFunction<TypescriptMocksPluginConfig> = (schema, docu

const enumValuesConvention = config.enumValues || 'pascal-case#pascalCase';
const typenamesConvention = config.typenames || 'pascal-case#pascalCase';
const transformUnderscore = config.transformUnderscore ?? true;
// List of types that are enums
const types: TypeItem[] = [];
const visitor: VisitorType = {
Expand Down Expand Up @@ -357,6 +379,7 @@ export const plugin: PluginFunction<TypescriptMocksPluginConfig> = (schema, docu
enumsPrefix: config.enumsPrefix,
currentType: node.type,
customScalars: config.scalars,
transformUnderscore,
});

return ` ${fieldName}: overrides && overrides.hasOwnProperty('${fieldName}') ? overrides.${fieldName}! : ${value},`;
Expand Down Expand Up @@ -384,6 +407,7 @@ export const plugin: PluginFunction<TypescriptMocksPluginConfig> = (schema, docu
enumsPrefix: config.enumsPrefix,
currentType: field.type,
customScalars: config.scalars,
transformUnderscore,
});

return ` ${field.name.value}: overrides && overrides.hasOwnProperty('${field.name.value}') ? overrides.${field.name.value}! : ${value},`;
Expand All @@ -399,6 +423,7 @@ export const plugin: PluginFunction<TypescriptMocksPluginConfig> = (schema, docu
false,
config.prefix,
config.typesPrefix,
transformUnderscore,
);
},
};
Expand All @@ -421,6 +446,7 @@ export const plugin: PluginFunction<TypescriptMocksPluginConfig> = (schema, docu
!!config.addTypename,
config.prefix,
config.typesPrefix,
transformUnderscore,
);
},
};
Expand All @@ -441,6 +467,7 @@ export const plugin: PluginFunction<TypescriptMocksPluginConfig> = (schema, docu
!!config.addTypename,
config.prefix,
config.typesPrefix,
transformUnderscore,
);
},
};
Expand All @@ -467,6 +494,7 @@ export const plugin: PluginFunction<TypescriptMocksPluginConfig> = (schema, docu
typesFile,
typesPrefix: config.typesPrefix,
enumsPrefix: config.enumsPrefix,
transformUnderscore: transformUnderscore,
});
// List of function that will generate the mock.
// We generate it after having visited because we need to distinct types from enums
Expand Down
Loading