useDeprecatedReason

GraphQL

Summary

Rule available since: v1.9.0
Diagnostic Category: lint/style/useDeprecatedReason
This rule is recommended, which means is enabled by default.
This rule doesn’t have a fix.
The default severity of this rule is warning.
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

1
query {
2
  member @deprecated
3
}

code-block.graphql:2:10 lint/style/useDeprecatedReason ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ⚠ The directive @deprecated should have a reason argument.
  
    1 │ query {
  > 2 │   member @deprecated
      │          ^^^^^^^^^^^
    3 │ }
    4 │ 
  
  ℹ Add a reason argument to the directive.

Valid

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

How to configure

1
{
2
  "linter": {
3
    "rules": {
4
      "style": {
5
        "useDeprecatedReason": "error"
6
      }
7
    }
8
  }
9
}