require-deprecation-reason
✅ The "extends": "plugin:@graphql-eslint/schema-recommended" property in a configuration file
enables this rule.
- Category:
Schema - Rule name:
@graphql-eslint/require-deprecation-reason - Requires GraphQL Schema:
falseℹ️ - Requires GraphQL Operations:
falseℹ️
Require all deprecation directives to specify a reason.
Usage Examples
Incorrect
# eslint @graphql-eslint/require-deprecation-reason: 'error'
type MyType {
name: String @deprecated
}Incorrect
# eslint @graphql-eslint/require-deprecation-reason: 'error'
type MyType {
name: String @deprecated(reason: "")
}Correct
# eslint @graphql-eslint/require-deprecation-reason: 'error'
type MyType {
name: String @deprecated(reason: "no longer relevant, please use fullName field")
}