feat: introduce graphql linting#2856
Merged
Merged
Conversation
🦋 Changeset detectedLatest commit: e4237dc The changes in this PR will be included in the next version bump. This PR includes changesets to release 3 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
Contributor
Contributor
Performance Benchmark (Lower is Faster)
|
RomanHotsiy
reviewed
Jun 8, 2026
| "operation-summary": "error", | ||
| }, | ||
| "graphql": { | ||
| "no-empty-servers": "error", |
Collaborator
Author
There was a problem hiding this comment.
Those are unused rules propagated from the root rules config section.
tatomyr
force-pushed
the
feat/lint-graphql
branch
from
7f3750d to
7bd109c
Compare
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
JLekawa
reviewed
Jun 12, 2026
JLekawa
reviewed
Jun 12, 2026
JLekawa
approved these changes
Jun 12, 2026
tatomyr
force-pushed
the
feat/lint-graphql
branch
2 times, most recently
from
8723a0d to
73e2aff
Compare
tatomyr
force-pushed
the
feat/lint-graphql
branch
from
73e2aff to
6bdd8fe
Compare
tatomyr
force-pushed
the
feat/lint-graphql
branch
from
2b29c2e to
c580a1b
Compare
|
|
||
| // GraphQL SDL is not a JSON/YAML tree, so it runs through a separate engine. | ||
| if (isGraphqlRef(document.source.absoluteRef)) { | ||
| return lintGraphqlDocument({ document, config }); |
Contributor
There was a problem hiding this comment.
I think, that we can add dynamic imports for the GraphQL in the lint command, because now we have esbuild and chunks, so the dynamic import should go to the separate chunk. It should decrease the influence of the GraphQL on the performance.
tatomyr
force-pushed
the
feat/lint-graphql
branch
from
b69ae8e to
9c8e4ce
Compare
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes using default effort and found 1 potential issue.
❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.
Reviewed by Cursor Bugbot for commit 9c8e4ce. Configure here.
tatomyr
force-pushed
the
feat/lint-graphql
branch
from
64dd060 to
c94d2b8
Compare
Co-authored-by: Jacek Łękawa <164185257+JLekawa@users.noreply.github.com>
tatomyr
force-pushed
the
feat/lint-graphql
branch
from
964cf73 to
e4237dc
Compare
vadyvas
approved these changes
Jul 2, 2026
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
5 participants
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.
What/Why/How?
Added experimental graphql linting.
Reference
Testing
Tests passed here: https://github.com/Redocly/redocly/pull/24589
Screenshots (optional)
Check yourself
Security
Note
Medium Risk
Touches core
lintDocumentand document resolution paths but gates behavior on file extension; new dependency and a parallel rule engine increase surface area while marked experimental.Overview
Adds experimental lint support for GraphQL SDL (
.graphql/.gql) alongside OpenAPI-family formats.redocly lintdetects GraphQL by file extension, keeps SDL as raw text instead of YAML parsing, and runs a dedicated pipeline built on thegraphqlpackage (parse → AST visitors).Built-in GraphQL rules include
struct(syntax +validateSchema),no-unused-types, andtype-description, wired throughgraphqlRulesin presets (recommended,all, etc.) and the default plugin. Configurablerule/*assertions work against GraphQL AST kinds (ObjectTypeDefinition,FieldDefinition, …) via a new GraphQL assertions visitor, withredocly.yamlsubject enums extended accordingly.Config/plugins gain a
graphqlrules bucket; common ref-resolution rules likeno-unresolved-refsare omitted from the GraphQL ruleset. Bundling explicitly skips GraphQL. Docs add a GraphQL lint guide and updatelint/ configurable-rules pages; enum validation errors for huge subject lists now link to documentation instead of dumping all values.Reviewed by Cursor Bugbot for commit e4237dc. Bugbot is set up for automated code reviews on this repo. Configure here.