wispbit logo

wispbit GraphQL standards

graphql
Follow these patterns for GraphQL mutations to ensure consistency and extensibility:
Input Parameters
Use a single `input` parameter instead of individual parameters for all mutations.
Naming Conventions
- Input types: `...Input` (e.g., `UpdateRepositoryInput`, `CreateUserInput`)
- Return types: `...Payload` (e.g., `UpdateRepositoryPayload`, `CreateUserPayload`)

Install this rule for wispbit Cloud

Add this rule to wispbit and it will run when you open a pull request

Install this rule with wispbit CLI

Run this command in your terminal to install the rule locally

npx @wispbit/cli rule install wispbit-graphql

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: |
                Follow these patterns for GraphQL mutations to ensure consistency and extensibility:
        
        Input Parameters
        Use a single `input` parameter instead of individual parameters for all mutations.
        
        Naming Conventions
        
        - Input types: `...Input` (e.g., `UpdateRepositoryInput`, `CreateUserInput`)
        - Return types: `...Payload` (e.g., `UpdateRepositoryPayload`, `CreateUserPayload`)
        
        Update Mutations
        Use a single generic update method per entity that can be extended by adding fields to the input type.
        
        Bad:
        
        ```graphql
        updateRepositorySkippedBranches(
          repositoryId: ID!
          skippedBranches: [String!]!
        ): Repository!
        
        updateRepositoryName(
          repositoryId: ID!
          name: String!
        ): Repository!
        ```
        
        Good:
        
        ```graphql
        updateRepository(input: UpdateRepositoryInput!): UpdateRepositoryPayload!
        
        input UpdateRepositoryInput {
          repositoryId: ID!
          skippedBranches: [String!]
          name: String
        }
        
        type UpdateRepositoryPayload {
          repository: Repository!
        }
        ```

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.

Follow these patterns for GraphQL mutations to ensure consistency and extensibility:
Input Parameters
Use a single `input` parameter instead of individual parameters for all mutations.
Naming Conventions
- Input types: `...Input` (e.g., `UpdateRepositoryInput`, `CreateUserInput`)
- Return types: `...Payload` (e.g., `UpdateRepositoryPayload`, `CreateUserPayload`)
Update Mutations
Use a single generic update method per entity that can be extended by adding fields to the input type.
Bad:
```graphql
updateRepositorySkippedBranches(
  repositoryId: ID!
  skippedBranches: [String!]!
): Repository!
updateRepositoryName(
  repositoryId: ID!
  name: String!
): Repository!
```
Good:
```graphql
updateRepository(input: UpdateRepositoryInput!): UpdateRepositoryPayload!
input UpdateRepositoryInput {
  repositoryId: ID!
  skippedBranches: [String!]
  name: String
}
type UpdateRepositoryPayload {
  repository: Repository!
}
```

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.

Follow these patterns for GraphQL mutations to ensure consistency and extensibility:
Input Parameters
Use a single `input` parameter instead of individual parameters for all mutations.
Naming Conventions
- Input types: `...Input` (e.g., `UpdateRepositoryInput`, `CreateUserInput`)
- Return types: `...Payload` (e.g., `UpdateRepositoryPayload`, `CreateUserPayload`)
Update Mutations
Use a single generic update method per entity that can be extended by adding fields to the input type.
Bad:
```graphql
updateRepositorySkippedBranches(
  repositoryId: ID!
  skippedBranches: [String!]!
): Repository!
updateRepositoryName(
  repositoryId: ID!
  name: String!
): Repository!
```
Good:
```graphql
updateRepository(input: UpdateRepositoryInput!): UpdateRepositoryPayload!
input UpdateRepositoryInput {
  repositoryId: ID!
  skippedBranches: [String!]
  name: String
}
type UpdateRepositoryPayload {
  repository: Repository!
}
```

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.

Follow these patterns for GraphQL mutations to ensure consistency and extensibility:
Input Parameters
Use a single `input` parameter instead of individual parameters for all mutations.
Naming Conventions
- Input types: `...Input` (e.g., `UpdateRepositoryInput`, `CreateUserInput`)
- Return types: `...Payload` (e.g., `UpdateRepositoryPayload`, `CreateUserPayload`)
Update Mutations
Use a single generic update method per entity that can be extended by adding fields to the input type.
Bad:
```graphql
updateRepositorySkippedBranches(
  repositoryId: ID!
  skippedBranches: [String!]!
): Repository!
updateRepositoryName(
  repositoryId: ID!
  name: String!
): Repository!
```
Good:
```graphql
updateRepository(input: UpdateRepositoryInput!): UpdateRepositoryPayload!
input UpdateRepositoryInput {
  repositoryId: ID!
  skippedBranches: [String!]
  name: String
}
type UpdateRepositoryPayload {
  repository: Repository!
}
```

File Path Patterns:

*.graphql

Use with Cline

Copy the rule below and ask Cline to review your code using this rule

Follow these patterns for GraphQL mutations to ensure consistency and extensibility:
Input Parameters
Use a single `input` parameter instead of individual parameters for all mutations.
Naming Conventions
- Input types: `...Input` (e.g., `UpdateRepositoryInput`, `CreateUserInput`)
- Return types: `...Payload` (e.g., `UpdateRepositoryPayload`, `CreateUserPayload`)
Update Mutations
Use a single generic update method per entity that can be extended by adding fields to the input type.
Bad:
```graphql
updateRepositorySkippedBranches(
  repositoryId: ID!
  skippedBranches: [String!]!
): Repository!
updateRepositoryName(
  repositoryId: ID!
  name: String!
): Repository!
```
Good:
```graphql
updateRepository(input: UpdateRepositoryInput!): UpdateRepositoryPayload!
input UpdateRepositoryInput {
  repositoryId: ID!
  skippedBranches: [String!]
  name: String
}
type UpdateRepositoryPayload {
  repository: Repository!
}
```

Use with OpenAI Codex

Copy the rule below and ask OpenAI Codex to review your code using this rule

Follow these patterns for GraphQL mutations to ensure consistency and extensibility:
Input Parameters
Use a single `input` parameter instead of individual parameters for all mutations.
Naming Conventions
- Input types: `...Input` (e.g., `UpdateRepositoryInput`, `CreateUserInput`)
- Return types: `...Payload` (e.g., `UpdateRepositoryPayload`, `CreateUserPayload`)
Update Mutations
Use a single generic update method per entity that can be extended by adding fields to the input type.
Bad:
```graphql
updateRepositorySkippedBranches(
  repositoryId: ID!
  skippedBranches: [String!]!
): Repository!
updateRepositoryName(
  repositoryId: ID!
  name: String!
): Repository!
```
Good:
```graphql
updateRepository(input: UpdateRepositoryInput!): UpdateRepositoryPayload!
input UpdateRepositoryInput {
  repositoryId: ID!
  skippedBranches: [String!]
  name: String
}
type UpdateRepositoryPayload {
  repository: Repository!
}
```

Use with Cursor

Copy the rule below and ask Cursor to review your code using this rule

Follow these patterns for GraphQL mutations to ensure consistency and extensibility:
Input Parameters
Use a single `input` parameter instead of individual parameters for all mutations.
Naming Conventions
- Input types: `...Input` (e.g., `UpdateRepositoryInput`, `CreateUserInput`)
- Return types: `...Payload` (e.g., `UpdateRepositoryPayload`, `CreateUserPayload`)
Update Mutations
Use a single generic update method per entity that can be extended by adding fields to the input type.
Bad:
```graphql
updateRepositorySkippedBranches(
  repositoryId: ID!
  skippedBranches: [String!]!
): Repository!
updateRepositoryName(
  repositoryId: ID!
  name: String!
): Repository!
```
Good:
```graphql
updateRepository(input: UpdateRepositoryInput!): UpdateRepositoryPayload!
input UpdateRepositoryInput {
  repositoryId: ID!
  skippedBranches: [String!]
  name: String
}
type UpdateRepositoryPayload {
  repository: Repository!
}
```

Use with Claude Code

Copy the rule below and ask Claude Code to review your code using this rule

Follow these patterns for GraphQL mutations to ensure consistency and extensibility:
Input Parameters
Use a single `input` parameter instead of individual parameters for all mutations.
Naming Conventions
- Input types: `...Input` (e.g., `UpdateRepositoryInput`, `CreateUserInput`)
- Return types: `...Payload` (e.g., `UpdateRepositoryPayload`, `CreateUserPayload`)
Update Mutations
Use a single generic update method per entity that can be extended by adding fields to the input type.
Bad:
```graphql
updateRepositorySkippedBranches(
  repositoryId: ID!
  skippedBranches: [String!]!
): Repository!
updateRepositoryName(
  repositoryId: ID!
  name: String!
): Repository!
```
Good:
```graphql
updateRepository(input: UpdateRepositoryInput!): UpdateRepositoryPayload!
input UpdateRepositoryInput {
  repositoryId: ID!
  skippedBranches: [String!]
  name: String
}
type UpdateRepositoryPayload {
  repository: Repository!
}
```

Install this rule for Windsurf

To set up rules for Windsurf Reviews, please see this documentation 

Follow these patterns for GraphQL mutations to ensure consistency and extensibility:
Input Parameters
Use a single `input` parameter instead of individual parameters for all mutations.
Naming Conventions
- Input types: `...Input` (e.g., `UpdateRepositoryInput`, `CreateUserInput`)
- Return types: `...Payload` (e.g., `UpdateRepositoryPayload`, `CreateUserPayload`)
Update Mutations
Use a single generic update method per entity that can be extended by adding fields to the input type.
Bad:
```graphql
updateRepositorySkippedBranches(
  repositoryId: ID!
  skippedBranches: [String!]!
): Repository!
updateRepositoryName(
  repositoryId: ID!
  name: String!
): Repository!
```
Good:
```graphql
updateRepository(input: UpdateRepositoryInput!): UpdateRepositoryPayload!
input UpdateRepositoryInput {
  repositoryId: ID!
  skippedBranches: [String!]
  name: String
}
type UpdateRepositoryPayload {
  repository: Repository!
}
```