Mark fields as deprecated in GraphQL

graphql
When removing fields from a GraphQL schema, follow a progressive deprecation process:
1. First, mark the field to be removed as deprecated using the `@deprecated` directive
2. Introduce the new alternative field in the same operation
3. Only remove deprecated fields after they have been deprecated for a sufficient time period
Bad:
```graphql

Install this rule for wispbit

Quick Install

Recommended
View install script

Run this one command to automatically install the rule:

curl -fsSL https://wispbit.com/api/install?rule=graphql-mark-fields-deprecated | bash

Manual install

1

Copy the rule

---
include: *.graphql
---
When removing fields from a GraphQL schema, follow a progressive deprecation process:
1. First, mark the field to be removed as deprecated using the `@deprecated` directive
2. Introduce the new alternative field in the same operation
3. Only remove deprecated fields after they have been deprecated for a sufficient time period
Bad:
```graphql
// Before
type User {
  id: ID!
  oldEmail: String!
}
// After (directly removing the field)
type User {
  id: ID!
}
```
Good:
```graphql
// Step 1: Mark as deprecated and introduce alternative
type User {
  id: ID!
  oldEmail: String! @deprecated(reason: "Use 'email' field instead")
  email: String!
}
// Step 2: Only later, remove the deprecated field
type User {
  id: ID!
  email: String!
}
```
2

Add the rule into your project

Save the copied content as: .wispbit/rules/graphql-mark-fields-deprecated.md

Install this rule for Coderabbit

Copy the configuration below and add it to your repository as .coderabbit.yml in your project root.

reviews:
  path_instructions:
    - path: "*.graphql"
      instructions: |
                
        When removing fields from a GraphQL schema, follow a progressive deprecation process:
        
        1. First, mark the field to be removed as deprecated using the `@deprecated` directive
        2. Introduce the new alternative field in the same operation
        3. Only remove deprecated fields after they have been deprecated for a sufficient time period
        
        Bad:
        
        ```graphql
        // Before
        type User {
          id: ID!
          oldEmail: String!
        }
        
        // After (directly removing the field)
        type User {
          id: ID!
        }
        ```
        
        Good:
        
        ```graphql
        // Step 1: Mark as deprecated and introduce alternative
        type User {
          id: ID!
          oldEmail: String! @deprecated(reason: "Use 'email' field instead")
          email: String!
        }
        
        // Step 2: Only later, remove the deprecated field
        type User {
          id: ID!
          email: String!
        }
        ```

Install this rule for Greptile

Greptile rules can be added through the web interface. Please see this documentation for details on how to add custom rules and context.

When removing fields from a GraphQL schema, follow a progressive deprecation process:
1. First, mark the field to be removed as deprecated using the `@deprecated` directive
2. Introduce the new alternative field in the same operation
3. Only remove deprecated fields after they have been deprecated for a sufficient time period
Bad:
```graphql
// Before
type User {
  id: ID!
  oldEmail: String!
}
// After (directly removing the field)
type User {
  id: ID!
}
```
Good:
```graphql
// Step 1: Mark as deprecated and introduce alternative
type User {
  id: ID!
  oldEmail: String! @deprecated(reason: "Use 'email' field instead")
  email: String!
}
// Step 2: Only later, remove the deprecated field
type User {
  id: ID!
  email: String!
}
```

File Path Patterns:

*.graphql

Install this rule for GitHub Copilot

Copilot instructions can be added through the interface. See the documentation for details on how to create coding guidelines.

When removing fields from a GraphQL schema, follow a progressive deprecation process:
1. First, mark the field to be removed as deprecated using the `@deprecated` directive
2. Introduce the new alternative field in the same operation
3. Only remove deprecated fields after they have been deprecated for a sufficient time period
Bad:
```graphql
// Before
type User {
  id: ID!
  oldEmail: String!
}
// After (directly removing the field)
type User {
  id: ID!
}
```
Good:
```graphql
// Step 1: Mark as deprecated and introduce alternative
type User {
  id: ID!
  oldEmail: String! @deprecated(reason: "Use 'email' field instead")
  email: String!
}
// Step 2: Only later, remove the deprecated field
type User {
  id: ID!
  email: String!
}
```

File Path Patterns:

*.graphql

Install this rule for Graphite Diamond

Diamond custom rules can be added through the interface. See the documentation for details on how to create custom rules.

When removing fields from a GraphQL schema, follow a progressive deprecation process:
1. First, mark the field to be removed as deprecated using the `@deprecated` directive
2. Introduce the new alternative field in the same operation
3. Only remove deprecated fields after they have been deprecated for a sufficient time period
Bad:
```graphql
// Before
type User {
  id: ID!
  oldEmail: String!
}
// After (directly removing the field)
type User {
  id: ID!
}
```
Good:
```graphql
// Step 1: Mark as deprecated and introduce alternative
type User {
  id: ID!
  oldEmail: String! @deprecated(reason: "Use 'email' field instead")
  email: String!
}
// Step 2: Only later, remove the deprecated field
type User {
  id: ID!
  email: String!
}
```

File Path Patterns:

*.graphql