requireDeprecationReason
| Property | Value |
|---|---|
| Config name | requireDeprecationReason |
| Default severity | warn |
| Context | Schema |
| In recommended | Yes |
What it checks
Section titled “What it checks”Require reason in @deprecated directives.
Examples
Section titled “Examples”# ❌ Bad — @deprecated without reasontype User { id: ID! oldField: String @deprecated}# ✅ Good — @deprecated with reasontype User { id: ID! oldField: String @deprecated(reason: "Use newField instead")}Configuration
Section titled “Configuration”extensions: graphql-analyzer: lint: rules: requireDeprecationReason: warn