dotansimha/graphql-code-generator

Add return type to function to avoid eslint warning explicit-module-boundary-types

Open

#5,348 opened on Jan 3, 2021

View on GitHub
 (0 comments) (13 reactions) (0 assignees)TypeScript (10,341 stars) (1,295 forks)batch import
corehelp wantedkind/enhancementplugins

Description

I'm using strict typescript and I want all functions to explicitly define their return types. However, when generating the types using code generator, the function have no return type.

Of course I can disabled eslint for the file (/* eslint-disable @typescript-eslint/explicit-module-boundary-types */), but this is messy

Example ;

export function useFindRefBudgetEntityQuery(
	baseOptions?: Apollo.QueryHookOptions<
		FindRefBudgetEntityQuery,
		FindRefBudgetEntityQueryVariables
	>
) {
	return Apollo.useQuery<
		FindRefBudgetEntityQuery,
		FindRefBudgetEntityQueryVariables
	>(FindRefBudgetEntityDocument, baseOptions);
}

the returnType is compiled but not set to this function

export type FindRefBudgetEntityQueryResult = Apollo.QueryResult<
	FindRefBudgetEntityQuery,
	FindRefBudgetEntityQueryVariables
>;

adding it works fine

export function useFindRefBudgetEntityQuery(
	baseOptions?: Apollo.QueryHookOptions<
		FindRefBudgetEntityQuery,
		FindRefBudgetEntityQueryVariables
	>
):Apollo.QueryResult<
FindRefBudgetEntityQuery,
FindRefBudgetEntityQueryVariables
> {
	return Apollo.useQuery<
		FindRefBudgetEntityQuery,
		FindRefBudgetEntityQueryVariables
	>(FindRefBudgetEntityDocument, baseOptions);
}

Contributor guide

Tech stack
typescriptgraphql
Domain
tooling
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
TypeScriptGraphQLcode generator plugins
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
The issue requests adding explicit return types to generated React Apollo hook functions. Examine the `typescript operations` plugin in the `graphql code generator` repository (likely under `packages/plugins/typescript/operations`). The return type is already defined as a type alias; the fix involves modifying the visitor to include the return type annotation in the function declaration. Look for how function signatures are generated, possibly in the visitor's `OperationDefinition` or `FragmentDefinition` handlers. Consider using the type alias name directly. No linked PRs or maintainer comments exist, so focus on the code generation templates and ensure consistency with existing ESLint rules.