Skip to content

descriptionStyle

Property Value
Config name descriptionStyle
Default severity
Context Schema
In recommended No

Enforce block vs inline description style.

# ❌ Bad — inline description on multi-line type
"A user"
type User {
id: ID!
name: String
}
# ✅ Good — block description
"""
A user
"""
type User {
id: ID!
name: String
}
extensions:
graphql-analyzer:
lint:
rules:
descriptionStyle: warn