Merged
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.
Add Node Interface Linting Rule
Summary
This PR adds a new GraphQL linting rule that enforces the Node interface to be properly defined as an interface type with exactly one field:
id: ID!.Changes Made
New Linting Rule
node-interface-structureRule Behavior
The rule checks for the following conditions:
type Node { ... }is foundidID!(non-nullable ID)Implementation Details
ObjectTypeDefinitionvisitor to detect when Node is incorrectly defined as a typeInterfaceTypeDefinitionvisitor to validate Node interface structureTest Coverage
Added 5 new test cases:
interface Node { id: ID! })Configuration
The rule is enabled by default and can be disabled via VS Code settings:
{ "stepzen.graphqlLintRules": { "node-interface-structure": false } }Testing
Impact
This enhancement helps developers maintain GraphQL schemas that conform to the Relay specification for Node interfaces, improving schema consistency and reducing potential runtime errors.
Files Changed
src/services/graphqlLinter.ts- Added Node interface rule implementationsrc/test/unit/services/graphqlLinter.test.ts- Added comprehensive test coveragesrc/test/unit/graphqlLinter.test.ts- Updated configuration test