[8h] Look into GraphQL linting tools
Closed, ResolvedPublic
Actions

Assigned To

Authored By

	WMDE-leszek
	Oct 9 2025, 8:19 AM

Description

Check what tooling is there for linting GraphQL SDLs and see how they could be beneficial for Wikibase GraphQL SDL

An example could be checking that list fields are not nullable.

The task will be timeboxed to 8 work hours to check the existing tooling, and build the good-enough linting into our software.

Related Changes in Gerrit:

	Subject	Repo	Branch	Lines +/-
	GQL: Use UPPER_CASE names for enum type values	mediawiki/extensions/Wikibase	master	+35 -52
	GQL: Lint schema	mediawiki/extensions/Wikibase	master	+3 K -0

Restricted Application added a subscriber: Aklapper. · View Herald TranscriptOct 9 2025, 8:19 AM

WMDE-leszek renamed this task from Look into GraphQL linting tools to [8h] Look into GraphQL linting tools.Oct 9 2025, 10:10 AM

WMDE-leszek updated the task description. (Show Details)

Change #1207157 had a related patch set uploaded (by Jakob; author: Jakob):

[mediawiki/extensions/Wikibase@master] GQL: Lint schema

Change #1207158 had a related patch set uploaded (by Jakob; author: Jakob):

[mediawiki/extensions/Wikibase@master] GQL: Enable GraphQL type naming convention linting

I found three linting tools that are often recommended:

GraphQL-ESLint. This is the one I think we should choose. We already use ESLint in various places of the code base, it's actively maintained and works well.
graphql-schema-linter is recommended in the Production Ready GraphQL book, but it doesn't seem to be actively maintained anymore and has >10x fewer npm downloads.
GraphOS/rover schema linting appears to be the standard in the Apollo GraphQL ecosystem, but we're not using any other Apollo tooling at the moment and it all looked a bit too integrated into the whole "GraphOS platform" and too complicated for what we need.