feat: support @gql-tada-ignore-unused comment to suppress unused field diagnostics - #433
Open
OMD-123 wants to merge 1 commit into
Open
feat: support @gql-tada-ignore-unused comment to suppress unused field diagnostics#433OMD-123 wants to merge 1 commit into
OMD-123 wants to merge 1 commit into
Conversation
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR introduces support for suppressing "unused field" diagnostics in GraphQL documents using a specific comment directive. This allows developers to explicitly mark a query as "used" even if not all fields are accessed within the same file—a common scenario when passing a full data object to another function or storage mechanism (e.g.,
localStorage.setItem, caching, or passing to external APIs).Fixes #269
Changes
hasIgnoreUnusedCommentinpackages/graphqlsp/src/fieldUsage.tsthat scans for@gql-tada-ignore-unusedor@gql-tada-mark-usedin the leading/trailing comments of agraphql()call expression.checkFieldUsageInFile(Phase C) to skip unused field reporting if this comment is present.test/e2e/fixture-project-unused-fields/fixtures/ignore-test.tsxto verify the behavior.Example Usage
Testing