Skip to content

useDeprecatedReason

Diagnostic Category: lint/nursery/useDeprecatedReason

GraphQL

Since: v1.9.0

Sources:

Same as: graphql/require-deprecation-reason

Description

Require specifying the reason argument when using @deprecated directive

This rule checks the parameter of @deprecated directive for the use of reason argument, suggesting user to add it in case the argument is missing.

Examples

Invalid

query {
  member @deprecated
}

Valid

query {
  member @deprecated(reason: "Why?")
}

How to configure

{
  "linter": {
    "rules": {
      "nursery": {
        "useDeprecatedReason": "error"
      }
    }
  }
}