support new config option mappersRelativeTargetDir (#345)

* support mappersRelativeTargetDir

* add documentation

* remove package-lock

* reset yarn lock

---------

Co-authored-by: Eddy Nguyen <[email protected]>

Author: HunterLarco

packages/typescript-resolver-files-e2e/src/test-mappers/codegen.ts

@@ -22,6 +22,7 @@ const config: CodegenConfig = {
           interface: '*',
           enum: '',
         },
+        mappersRelativeTargetDir: 'mappers',
         mappersFileExtension: '.type-mappers.ts',
         mappersSuffix: '_Mapper',
       }),

packages/typescript-resolver-files-e2e/src/test-mappers/modules/pet/schema.type-mappers.ts renamed to packages/typescript-resolver-files-e2e/src/test-mappers/modules/pet/mappers/schema.type-mappers.ts

@@ -3,8 +3,8 @@ import {
   GraphQLScalarType,
   GraphQLScalarTypeConfig,
 } from 'graphql';
-import { Pet_Mapper } from './pet/schema.type-mappers';
-import { Profile_Mapper } from './user/profile.type-mappers';
+import { Pet_Mapper } from './pet/mappers/schema.type-mappers';
+import { Profile_Mapper } from './user/mappers/profile.type-mappers';
 export type Maybe<T> = T | null | undefined;
 export type InputMaybe<T> = T | null | undefined;
 export type Exact<T extends { [key: string]: unknown }> = {

packages/typescript-resolver-files-e2e/src/test-mappers/modules/types.generated.ts

@@ -328,6 +328,12 @@ Experimental options:
 
 - `namingConvention`
 
+### mappersRelativeTargetDir
+
+`string` (Default: `./`)
+
+By default, mappers must be siblings with the schema they represent. For example, if the schema file is `/path/to/schema.graphql`, the mapper file is `/path/to/schema.mappers.ts`. This extension allows mappers to reside in a different directory relative to the schema file using the pattern `<schemaPath>/<mappersRelativeTargetDir>/<schemaName><mappersFileExtension>`.
+
 ### mappersFileExtension
 
 `string` (Default: `.mappers.ts`)

packages/typescript-resolver-files-e2e/src/test-mappers/modules/user/profile.type-mappers.ts renamed to packages/typescript-resolver-files-e2e/src/test-mappers/modules/user/mappers/profile.type-mappers.ts

@@ -6,6 +6,7 @@ import { collectTypeMappersFromSourceFile } from './collectTypeMappersFromSource
 export interface ParseTypeMappersParams {
   sourceMap: ParseSourcesResult['sourceMap'];
   resolverTypesPath: string;
+  typeMappersRelativeTargetDir: string;
   typeMappersFileExtension: string;
   typeMappersSuffix: string;
   tsMorphProject: Project;
@@ -31,6 +32,7 @@ export type TypeMappersMap = Record<string, TypeMapperDetails>;
 export const parseTypeMappers = ({
   sourceMap,
   resolverTypesPath,
+  typeMappersRelativeTargetDir,
   typeMappersFileExtension,
   typeMappersSuffix,
   tsMorphProject,
@@ -40,6 +42,7 @@ export const parseTypeMappers = ({
     (res, [_, { sourcePath }]) => {
       const typeMapperFilePath = path.posix.join(
         sourcePath.dir,
+        typeMappersRelativeTargetDir,
         `${sourcePath.name}${typeMappersFileExtension}`
       );
 

packages/typescript-resolver-files/README.md

@@ -51,6 +51,7 @@ export const preset: Types.OutputPreset<RawPresetConfig> = {
       add,
       resolverTypesPath: relativeResolverTypesPathFromBaseOutputDir,
       resolverRelativeTargetDir,
+      mappersRelativeTargetDir: typeMappersRelativeTargetDir,
       mappersFileExtension: typeMappersFileExtension,
       mappersSuffix: typeMappersSuffix,
       resolverMainFile,
@@ -90,6 +91,7 @@ export const preset: Types.OutputPreset<RawPresetConfig> = {
         parseTypeMappers({
           sourceMap,
           resolverTypesPath,
+          typeMappersRelativeTargetDir,
           typeMappersFileExtension,
           typeMappersSuffix,
           tsMorphProject,

packages/typescript-resolver-files/src/parseTypeMappers/parseTypeMappers.ts

@@ -30,6 +30,7 @@ const defaultExpected: ParsedPresetConfig = {
   },
   typeDefsFilePath: './typeDefs.generated.ts',
   typeDefsFileMode: 'merged',
+  mappersRelativeTargetDir: './',
   mappersFileExtension: '.mappers.ts',
   mappersSuffix: 'Mapper',
   scalarsModule: 'graphql-scalars',

packages/typescript-resolver-files/src/preset.ts

@@ -53,6 +53,7 @@ export interface ParsedPresetConfig {
   resolverGeneration: NormalizedResolverGeneration;
   typeDefsFilePath: string | false;
   typeDefsFileMode: TypeDefsFileMode;
+  mappersRelativeTargetDir: string;
   mappersFileExtension: string;
   mappersSuffix: string;
   scalarsModule: string | false;
@@ -82,6 +83,7 @@ export interface RawPresetConfig {
   resolverGeneration?: string | Record<string, string | string[]>;
   typeDefsFilePath?: string | boolean;
   typeDefsFileMode?: string;
+  mappersRelativeTargetDir?: string;
   mappersFileExtension?: string;
   mappersSuffix?: string;
   scalarsModule?: string | boolean;
@@ -126,6 +128,7 @@ export const validatePresetConfig = ({
   resolverGeneration = 'recommended',
   typeDefsFilePath = defaultTypeDefsFilePath,
   typeDefsFileMode: inputTypeDefsFileMode = 'merged',
+  mappersRelativeTargetDir = './',
   mappersFileExtension = '.mappers.ts',
   mappersSuffix = 'Mapper',
   mergeSchema,
@@ -305,6 +308,7 @@ export const validatePresetConfig = ({
     typeDefsFileMode,
     mergeSchema: parseMergeSchema(mergeSchema),
     mode,
+    mappersRelativeTargetDir,
     mappersFileExtension,
     mappersSuffix,
     scalarsModule: finalScalarsModule,