useDeprecatedReason

import { Tabs, TabItem } from '@astrojs/starlight/components';

<Tabs> <TabItem label="GraphQL" icon="seti:graphql"> ## Summary - Rule available since: `v1.9.0` - Diagnostic Category: [`lint/style/useDeprecatedReason`](/reference/diagnostics#diagnostic-category) - This rule is **recommended**, meaning it is enabled by default. - This rule doesn't have a fix. - The default severity of this rule is [**warning**](/reference/diagnostics#warning). - Sources: - Same as [`@graphql-eslint/require-deprecation-reason`](https://the-guild.dev/graphql/eslint/rules/require-deprecation-reason)

How to configure

json

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

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

graphql

query {
  member @deprecated
}

<pre class="language-text"><code class="language-text">code-block.graphql:2:10 <a href="https://biomejs.dev/linter/rules/use-deprecated-reason">lint/style/useDeprecatedReason</a> ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ ⚠ The directive `@deprecated` should have a `reason` argument. 1 │ query { > 2 │ member @deprecated │ ^^^^^^^^^^^ 3 │ } 4 │ ℹ Add a `reason` argument to the directive. </code></pre>

Valid