Does it format both queries and schema definitions?

Yes. Operation documents (query, mutation, subscription) and SDL type definitions are both supported. Type extensions and custom directives are kept intact.

Is the document sent to a GraphQL server?

No. The formatter only reformats text in your browser. It never executes the operation or contacts an endpoint.

Will descriptions and comments survive?

Triple-quoted block descriptions on SDL types and fields are preserved. Hash comments inside operations are also kept.

What if my query has a syntax error?

The parser will report the location of the first error. Formatting only proceeds when the document parses cleanly.

prettier · graphql · queries & SDL · live

Format GraphQL queries & schemas

Prettier's GraphQL printer handles both query documents and SDL — types, interfaces, unions, directives, and fragments. Runs locally.

GraphQL Formatter

Input

179 B

1 lines

Output

0 B

1 lines

Status

parser…

Ratio

0.00×

out/in

input · graphql

output · formatted graphql

Loading parser…

Quick Start

How to format GraphQL

Drop in either a query document or SDL; Prettier parses both and reprints with consistent indent, argument wrapping, and selection-set spacing.

01
Paste query or SDL
Anonymous queries, named operations, fragments, unions, interfaces — all welcome.
Parsing runs through Prettier’s standalone bundle (or the language-specific equivalent) loaded lazily — no parser ships until the tool is opened.
gqlPrettierASTstandalonelazy
input · sourceraw · AST
```
{me{id}}
```
loaded · parsedAST · ready
02
Tune indent & width
Long argument lists break at the wrap column; nested selections indent by tab width.
Indent width, tab style, and print-width re-format through a memoised pass — switching 2 → 4 spaces never re-parses, only re-prints.
optionsindentprint-widthmemoisedlive
opts · optionstab/width · live
```
tab=2
```
options applied · livelive
03
Watch it reflow
Trailing commas vanish, directives align, deeply nested selections indent cleanly.
The formatter is deterministic and idempotent: running it twice produces byte-identical output, which keeps diffs and git noise to a minimum.
liveidempotentdeterministicdiff-cleanstable
out · formattedpretty · ready
```
{
  me {
    id
  }
}
```
formatted · liveidempotent
04
Copy or download
Export as .graphql or copy to clipboard — input stays in your browser.
Download writes a Blob with the language-appropriate extension; copy uses navigator.clipboard.writeText so the output preserves all whitespace exactly.
exportclipboardbloblanguage MIMEclient-side
ok · copiedready · done
```
✓ Copied
```
shipped · ready to shipsuccess

Pro tips

Formatting tips that keep diffs sane

Pick one config and pin it

Inconsistent formatting causes diff churn. Commit .prettierrc / .editorconfig and enforce in CI.

Format on save

Editor integration is faster feedback than a pre-commit hook. Use both for belt-and-braces.

Idempotency matters

Running the formatter twice should produce identical output. Test this on a representative file.

Match the language community

Default to community conventions: 2 spaces for JS/CSS, 4 for Python, tabs for Go. Fights over indent are a productivity tax.

Print-width drives wrapping

80, 100, and 120 are the common targets. Wider lines parse fast but review slower side-by-side.

Don’t mix formatters and linters

Prettier handles whitespace; ESLint handles correctness. Disable overlapping rules to avoid fight-club configs.

Use Cases

When to format GraphQL

Schema reviews, query inspection, code-gen output.

Schema PRs

Format SDL before opening a pull request. Idempotent: running the formatter twice produces byte-identical output, which is the foundation of a clean CI gate. Pair with a pre-commit hook so PRs arrive already formatted, focusing review on logic.

idempotent

Apollo Studio export

Make exported documents readable for review. Pairs with EditorConfig + .prettierrc for end-to-end consistency. Whitespace-only changes vanish so reviewers see real diffs, and git blame stays honest about who wrote what.

CI-ready

DevTools capture

Pretty-print a minified query captured from network panel. Output respects your indent width, tab style, and print-width — settings carry over for repeat runs. Switching 2-space to 4-space costs nothing in CPU but standardises an entire codebase.

diff-clean

Codegen review

Inspect graphql-codegen output for unexpected churn. Format-on-save is the fastest feedback loop; CI is the safety net. Together they make inconsistent indentation a thing of the past and free up review cycles for genuine concerns.

PR-friendly

Persisted queries

Format hashed queries before pushing to a registry. Whitespace-only changes don't trigger downstream content-hash invalidations, so CDN cache keys and CI cache layers stay warm. Real changes get all the rebuild budget.

review-ready

Docs examples

Standardise example operations for developer docs. Pairs with linters (ESLint, Stylelint, pylint) that catch what formatting alone can't — bugs, unused imports, dead code. Each tool stays in its lane, and the codebase stays clean.

deterministic

FAQ

Frequently asked questions

Schema vs query?

Both — Prettier auto-detects whether the document is SDL or executable.

Does it validate against a schema?

No — only syntax is parsed. Validation needs the schema; use a GraphQL client for that.

Comments preserved?

Yes — # comments and triple-quoted descriptions both survive.

Directives reordered?

No — directive order is preserved.

Is anything sent to a server?

No — Prettier runs locally in your browser tab.

Suggest a tool

Something missing?

Tell us what you need. We ship the top requests every two weeks.

47 in queue·8 shipped this month

Request queued. Thanks!