@graphql-eslint/eslint-plugin
Version:
GraphQL plugin for ESLint
60 lines (41 loc) • 1.41 kB
Markdown
# `require-deprecation-date`
💡 This rule provides
[suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions)
- Category: `Schema`
- Rule name: `-eslint/require-deprecation-date`
- Requires GraphQL Schema: `false` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
- Requires GraphQL Operations: `false`
[ℹ️](../../README.md#extended-linting-rules-with-siblings-operations)
Require deletion date on `` directive. Suggest removing deprecated things after
deprecated date.
## Usage Examples
### Incorrect
```graphql
# eslint @graphql-eslint/require-deprecation-date: 'error'
type User {
firstname: String
firstName: String
}
```
### Incorrect
```graphql
# eslint @graphql-eslint/require-deprecation-date: 'error'
type User {
firstname: String (reason: "Use 'firstName' instead")
firstName: String
}
```
### Correct
```graphql
# eslint @graphql-eslint/require-deprecation-date: 'error'
type User {
firstname: String (reason: "Use 'firstName' instead", deletionDate: "25/12/2022")
firstName: String
}
```
## Config Schema
The schema defines the following properties:
### `argumentName` (string)
## Resources
- [Rule source](../../packages/plugin/src/rules/require-deprecation-date.ts)
- [Test source](../../packages/plugin/tests/require-deprecation-date.spec.ts)