dotansimha / dotansimha/graphql-code-generator

Reference to source Document

Open
#9,534 1 comment 1 reaction 0 assignees View on GitHub
Dominant language
TypeScript
Stars
11.3k
Forks
1.4k
Avg merge
1d 1h
Merged PRs (30d)
23

Description

### Is your feature request related to a problem? Please describe.

We have a ton of queries in our project.

Now we have the problem of locating the source file. For example we have multiple different GetReservation Queries serving different purposes. The Problem is to get from the generated typescript file to the source .graphql file

### Describe the solution you'd like

A solution would be generate a jsdoc @link above the generated output. Example:

```typescript
/**
{@link src/graphql_source/reservations/single.graphql}
*/
const getReservationDocument = {};
```
This would be supported on all major IDEs (Eclipse, Jetbrains, VS Code).
The same can also be used for types:
```typescript
/**
{@link src/graphql_source/reservations/single.graphql}
*/
interface GetReservationResultType {
typename: string
id: string
}
```

### Describe alternatives you've considered

Alternative:

Just write the file name into a comment above the generated definition so you can copy it and let the editor open it with the tools provided by the editor (ex. shift shift for Jetbrains IDEs)

### Is your feature request related to a problem? Please describe.

_No response_

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.