♻️ (helpers): remove redundant comments and simplify helper generation logic

Author: ViniciosLugli

examples/advanced-graphql/schema-helpers.ts

@@ -46,9 +46,6 @@ export interface ConnectionConfig {
 }
 
 export class ConnectionBuilder {
-	/**
-	 * Build connection configuration without executing queries
-	 */
 	static buildConfig(args: {
 		pagination: PaginationArgs
 		where?: any
@@ -71,28 +68,23 @@ export class ConnectionBuilder {
 		} = args
 		const { first, after, last, before } = pagination
 
-		// Calculate pagination parameters
 		let take = first || last || 10
 		if (last) take = -take
 
-		// For composite key models, we skip cursor-based pagination
 		const cursor = (hasIdField && (after || before)) 
 			? { [cursorField]: (after || before)! } 
 			: undefined
 		const skip = cursor ? 1 : 0
 
-		// Build include from GraphQL selection if info is provided
 		const finalInclude = info ? buildPrismaInclude(info, relationFields) : include
 
-		// Prepare query options
 		const findManyOptions: any = {
 			take: Math.abs(take) + 1, // Get one extra to check for next page
 			where,
 			orderBy,
 			include: finalInclude,
 		}
 
-		// Only add cursor and skip for models with ID field
 		if (hasIdField && cursor) {
 			findManyOptions.cursor = cursor
 			findManyOptions.skip = skip
@@ -113,31 +105,24 @@ export class ConnectionBuilder {
 		}
 	}
 
-	/**
-	 * Process query results into connection format
-	 */
 	static processResults<T>(
 		items: T[],
 		totalCount: number,
 		paginationInfo: ConnectionConfig['paginationInfo']
 	): ConnectionResult<T> {
 		const { first, last, cursorField, hasIdField } = paginationInfo
 
-		// Determine pagination info
 		const hasNextPage = first ? items.length > first : false
 		const hasPreviousPage = last ? items.length > Math.abs(last) : false
 
-		// Remove extra item if present
 		const resultItems = hasNextPage || hasPreviousPage ? items.slice(0, -1) : items
 
-		// Build edges - use composite key for cursor if no ID field
 		const edges = resultItems.map((item: any, index: number) => {
 			let cursor: string
 			if (hasIdField && item[cursorField]) {
 				cursor = item[cursorField]
 			} else {
-				// For composite key models, create a cursor from available fields or use index
-				cursor = item.postId && item.categoryId 
+					cursor = item.postId && item.categoryId 
 					? `${item.postId}:${item.categoryId}`
 					: String(index)
 			}
@@ -264,10 +249,6 @@ export class ConnectionBuilder {
 }
 
 export class FilterBuilder {
-	/**
-	 * Build Prisma where clause from GraphQL filter input dynamically
-	 * This approach uses runtime reflection to map filter operations
-	 */
 	static buildFilter(filter: any): any {
 		if (!filter || typeof filter !== 'object') return {}
 
@@ -279,10 +260,8 @@ export class FilterBuilder {
 			} else if (field === 'OR' && Array.isArray(value)) {
 				where.OR = value.map((f: any) => this.buildFilter(f))
 			} else if (value && typeof value === 'object') {
-				// Map filter operations dynamically
 				const fieldWhere: any = {}
 
-				// Copy all valid operations from the filter value
 				for (const [operation, operationValue] of Object.entries(value)) {
 					if (operationValue !== undefined && operationValue !== null) {
 						fieldWhere[operation] = operationValue
@@ -314,19 +293,14 @@ export class FilterBuilder {
 }
 
 export class SortBuilder {
-	/**
-	 * Build Prisma orderBy clause from GraphQL sort input dynamically
-	 * This approach uses runtime reflection to map sort fields
-	 */
 	static buildSort(sort: any, fallbackSort: any = { id: 'asc' }): any {
 		if (!sort || typeof sort !== 'object') return fallbackSort
 
 		const orderBy: any = {}
 
 		for (const [field, direction] of Object.entries(sort)) {
 			if (direction && typeof direction === 'string') {
-				// Convert enum values to lowercase for Prisma
-				orderBy[field] = direction.toLowerCase()
+					orderBy[field] = direction.toLowerCase()
 			}
 		}
 
@@ -335,22 +309,19 @@ export class SortBuilder {
 
 
 	static buildProductSort(sort?: ProductSortInput): any {
-		// For models without id field (like composite key models), don't use id as fallback
 		const fallbackSort = true ? { id: 'asc' } : {}
 		return this.buildSort(sort, fallbackSort)
 	}
 
 	static buildReviewSort(sort?: ReviewSortInput): any {
-		// For models without id field (like composite key models), don't use id as fallback
 		const fallbackSort = true ? { id: 'asc' } : {}
 		return this.buildSort(sort, fallbackSort)
 	}
 
 
 }
 
-// Simplified field selection utilities (GraphQL-import-free)
-// Uses static includes instead of dynamic GraphQL field parsing
+
 
 export interface ResolveTree {
 	name: string
@@ -363,10 +334,7 @@ export interface FieldsByTypeName {
 	[str: string]: { [str: string]: ResolveTree }
 }
 
-// Simplified version that doesn't require GraphQL imports
 export function buildPrismaInclude(_resolveInfo: any, relations: string[] = []): any {
-	// For now, return a simple include object based on available relations
-	// This avoids GraphQL module conflicts while maintaining basic functionality
 	const include: any = {}
 
 	relations.forEach(relation => {

examples/type-graphql/schema-helpers.ts

@@ -46,9 +46,6 @@ export interface ConnectionConfig {
 }
 
 export class ConnectionBuilder {
-	/**
-	 * Build connection configuration without executing queries
-	 */
 	static buildConfig(args: {
 		pagination: PaginationArgs
 		where?: any
@@ -71,28 +68,23 @@ export class ConnectionBuilder {
 		} = args
 		const { first, after, last, before } = pagination
 
-		// Calculate pagination parameters
 		let take = first || last || 10
 		if (last) take = -take
 
-		// For composite key models, we skip cursor-based pagination
 		const cursor = (hasIdField && (after || before)) 
 			? { [cursorField]: (after || before)! } 
 			: undefined
 		const skip = cursor ? 1 : 0
 
-		// Build include from GraphQL selection if info is provided
 		const finalInclude = info ? buildPrismaInclude(info, relationFields) : include
 
-		// Prepare query options
 		const findManyOptions: any = {
 			take: Math.abs(take) + 1, // Get one extra to check for next page
 			where,
 			orderBy,
 			include: finalInclude,
 		}
 
-		// Only add cursor and skip for models with ID field
 		if (hasIdField && cursor) {
 			findManyOptions.cursor = cursor
 			findManyOptions.skip = skip
@@ -113,31 +105,24 @@ export class ConnectionBuilder {
 		}
 	}
 
-	/**
-	 * Process query results into connection format
-	 */
 	static processResults<T>(
 		items: T[],
 		totalCount: number,
 		paginationInfo: ConnectionConfig['paginationInfo']
 	): ConnectionResult<T> {
 		const { first, last, cursorField, hasIdField } = paginationInfo
 
-		// Determine pagination info
 		const hasNextPage = first ? items.length > first : false
 		const hasPreviousPage = last ? items.length > Math.abs(last) : false
 
-		// Remove extra item if present
 		const resultItems = hasNextPage || hasPreviousPage ? items.slice(0, -1) : items
 
-		// Build edges - use composite key for cursor if no ID field
 		const edges = resultItems.map((item: any, index: number) => {
 			let cursor: string
 			if (hasIdField && item[cursorField]) {
 				cursor = item[cursorField]
 			} else {
-				// For composite key models, create a cursor from available fields or use index
-				cursor = item.postId && item.categoryId 
+					cursor = item.postId && item.categoryId 
 					? `${item.postId}:${item.categoryId}`
 					: String(index)
 			}
@@ -289,10 +274,6 @@ export class ConnectionBuilder {
 }
 
 export class FilterBuilder {
-	/**
-	 * Build Prisma where clause from GraphQL filter input dynamically
-	 * This approach uses runtime reflection to map filter operations
-	 */
 	static buildFilter(filter: any): any {
 		if (!filter || typeof filter !== 'object') return {}
 
@@ -304,10 +285,8 @@ export class FilterBuilder {
 			} else if (field === 'OR' && Array.isArray(value)) {
 				where.OR = value.map((f: any) => this.buildFilter(f))
 			} else if (value && typeof value === 'object') {
-				// Map filter operations dynamically
 				const fieldWhere: any = {}
 
-				// Copy all valid operations from the filter value
 				for (const [operation, operationValue] of Object.entries(value)) {
 					if (operationValue !== undefined && operationValue !== null) {
 						fieldWhere[operation] = operationValue
@@ -346,19 +325,14 @@ export class FilterBuilder {
 }
 
 export class SortBuilder {
-	/**
-	 * Build Prisma orderBy clause from GraphQL sort input dynamically
-	 * This approach uses runtime reflection to map sort fields
-	 */
 	static buildSort(sort: any, fallbackSort: any = { id: 'asc' }): any {
 		if (!sort || typeof sort !== 'object') return fallbackSort
 
 		const orderBy: any = {}
 
 		for (const [field, direction] of Object.entries(sort)) {
 			if (direction && typeof direction === 'string') {
-				// Convert enum values to lowercase for Prisma
-				orderBy[field] = direction.toLowerCase()
+					orderBy[field] = direction.toLowerCase()
 			}
 		}
 
@@ -367,28 +341,24 @@ export class SortBuilder {
 
 
 	static buildUserSort(sort?: UserSortInput): any {
-		// For models without id field (like composite key models), don't use id as fallback
 		const fallbackSort = true ? { id: 'asc' } : {}
 		return this.buildSort(sort, fallbackSort)
 	}
 
 	static buildPostSort(sort?: PostSortInput): any {
-		// For models without id field (like composite key models), don't use id as fallback
 		const fallbackSort = true ? { id: 'asc' } : {}
 		return this.buildSort(sort, fallbackSort)
 	}
 
 
 
 	static buildCommentSort(sort?: CommentSortInput): any {
-		// For models without id field (like composite key models), don't use id as fallback
 		const fallbackSort = true ? { id: 'asc' } : {}
 		return this.buildSort(sort, fallbackSort)
 	}
 }
 
-// Simplified field selection utilities (GraphQL-import-free)
-// Uses static includes instead of dynamic GraphQL field parsing
+
 
 export interface ResolveTree {
 	name: string
@@ -401,10 +371,7 @@ export interface FieldsByTypeName {
 	[str: string]: { [str: string]: ResolveTree }
 }
 
-// Simplified version that doesn't require GraphQL imports
 export function buildPrismaInclude(_resolveInfo: any, relations: string[] = []): any {
-	// For now, return a simple include object based on available relations
-	// This avoids GraphQL module conflicts while maintaining basic functionality
 	const include: any = {}
 
 	relations.forEach(relation => {

src/generators/strategies/graphql-helper-strategy.ts

@@ -3,7 +3,6 @@ import { TypeScriptHelperStrategy } from './typescript-helper-strategy'
 
 export class GraphQLHelperStrategy extends TypeScriptHelperStrategy {
 	override generateHelpers(helpers: ModelHelper[], context: HelperGenerationContext): string[] {
-		// Always generate TypeScript helpers, even for GraphQL output
 		return super.generateHelpers(helpers, context)
 	}
-}
+}

src/generators/strategies/typescript-helper-strategy.ts

@@ -247,8 +247,6 @@ export interface ConnectionConfig {
 	}
 
 	private getSchemaImportPath(context: HelperGenerationContext): string {
-		// Determine the correct import path based on where the schema.ts file is generated
-		// Default to './schema' but can be customized based on output configuration
 		return './schema'
 	}
-}
+}

src/generators/unified/unified-helper-generator.ts

@@ -51,7 +51,6 @@ export class UnifiedHelperGenerator extends UnifiedGeneratorBase {
 		return this.models
 			.filter((model) => !this.shouldSkipModel(model))
 			.map((model) => {
-				// Get the GraphQL name from the attribute processor
 				const graphqlName = this.attributeProcessor.model(model).name()
 				return {
 					modelName: graphqlName,

src/orchestrator/helper-file-writer.ts

@@ -8,10 +8,8 @@ export class HelperFileWriter {
 	async writeHelperFiles(_outputFormat: OutputFormat, outputPath: string, helperCode?: string): Promise<string[]> {
 		const files: string[] = []
 
-		// Write helper code if provided (always as TypeScript)
 		if (helperCode) {
 			const helperPath = this.resolveHelperPath(outputPath)
-			// Combine GraphQL field selection utility with helper code in one file
 			const completeHelperCode = this.combineHelperCode(helperCode)
 			await this.fileWriter.write(completeHelperCode, helperPath, 'Helper utilities')
 			files.push(helperPath)
@@ -23,14 +21,11 @@ export class HelperFileWriter {
 	private resolveHelperPath(basePath: string): string {
 		const baseDir = path.dirname(basePath)
 		const baseName = path.basename(basePath, path.extname(basePath))
-		
-		// Always generate TypeScript helpers
+
 		return path.join(baseDir, `${baseName}-helpers.ts`)
 	}
 
 	private combineHelperCode(helperCode: string): string {
-		// No longer combining with field selection code - it's handled by templates
 		return helperCode
 	}
-
-}
+}

src/orchestrator/output-writer.ts

@@ -10,7 +10,7 @@ export class OutputWriter {
 
 	async write(result: UnifiedGenerationResult, outputPath: string): Promise<string> {
 		const finalOutputPath = this.resolveOutputPath(result.outputFormat, outputPath)
-		
+
 		if (result.outputFormat === OutputFormat.TYPE_GRAPHQL) {
 			if (!result.code) {
 				throw new Error('TypeGraphQL code is required but missing')
@@ -23,7 +23,6 @@ export class OutputWriter {
 			await this.fileWriter.write(result.sdl, finalOutputPath, 'GraphQL schema')
 		}
 
-		// Write helper files if generated
 		if (result.helperCode) {
 			await this.helperFileWriter.writeHelperFiles(result.outputFormat, outputPath, result.helperCode)
 		}
@@ -33,11 +32,8 @@ export class OutputWriter {
 
 	private resolveOutputPath(outputFormat: OutputFormat, basePath: string): string {
 		if (outputFormat === OutputFormat.TYPE_GRAPHQL) {
-			return path.join(
-				path.dirname(basePath),
-				path.basename(basePath, path.extname(basePath)) + '.ts'
-			)
+			return path.join(path.dirname(basePath), path.basename(basePath, path.extname(basePath)) + '.ts')
 		}
 		return basePath
 	}
-}
+}