Skip to content

noHashtagDescription

PropertyValue
Config namenoHashtagDescription
Default severitywarn
ContextSchema
In recommendedYes

Disallow # comments as type descriptions.

# ❌ Bad — comment used as description
# A user type
type User {
id: ID!
}
# ✅ Good — proper description string
"A user type"
type User {
id: ID!
}
extensions:
graphql-analyzer:
lint:
rules:
noHashtagDescription: warn