require-deprecation-reason.md

Require all deprecation directives to specify a reason

Deprecation reason will document your decisions for others.

Rule Details

This rule will require all @deprecated directives to specify deprecation reason

Examples of incorrect code for this rule:

# eslint @graphql-eslint/require-deprecation-reason: "error"
...
  name: String @deprecated
...

Examples of correct code for this rule:

# eslint @graphql-eslint/require-deprecation-reason: "error"
...
  name: String @depecated(reason: "Removing in 2 releases. Use fullname instead")
...

This rule doesn't have any options