Rules
Match Document Filename

match-document-filename

  • Category: Operations
  • Rule name: @graphql-eslint/match-document-filename
  • Requires GraphQL Schema: false ℹ️
  • Requires GraphQL Operations: false ℹ️

This rule allows you to enforce that the file name should match the operation name.

Usage Examples

Correct

# eslint @graphql-eslint/match-document-filename: ['error', { fileExtension: '.gql' }]
 
# user.gql
type User {
  id: ID!
}

Correct

# eslint @graphql-eslint/match-document-filename: ['error', { query: 'snake_case' }]
 
# user_by_id.gql
query UserById {
  userById(id: 5) {
    id
    name
    fullName
  }
}

Correct

# eslint @graphql-eslint/match-document-filename: ['error', { fragment: { style: 'kebab-case', suffix: '.fragment' } }]
 
# user-fields.fragment.gql
fragment user_fields on User {
  id
  email
}

Correct

# eslint @graphql-eslint/match-document-filename: ['error', { mutation: { style: 'PascalCase', suffix: 'Mutation' } }]
 
# DeleteUserMutation.gql
mutation DELETE_USER {
  deleteUser(id: 5)
}

Incorrect

# eslint @graphql-eslint/match-document-filename: ['error', { fileExtension: '.graphql' }]
 
# post.gql
type Post {
  id: ID!
}

Incorrect

# eslint @graphql-eslint/match-document-filename: ['error', { query: 'PascalCase' }]
 
# user-by-id.gql
query UserById {
  userById(id: 5) {
    id
    name
    fullName
  }
}

Correct

# eslint @graphql-eslint/match-document-filename: ['error', { fragment: { style: 'kebab-case', prefix: 'mutation.' } }]
 
# mutation.add-alert.graphql
mutation addAlert {
  foo
}

Correct

# eslint @graphql-eslint/match-document-filename: ['error', { fragment: { prefix: 'query.' } }]
 
# query.me.graphql
query me {
  foo
}

Config Schema

The schema defines the following properties:

fileExtension (enum)

This element must be one of the following enum values:

  • .gql
  • .graphql

query

The object must be one of the following types:

  • asString
  • asObject

mutation

The object must be one of the following types:

  • asString
  • asObject

subscription

The object must be one of the following types:

  • asString
  • asObject

fragment

The object must be one of the following types:

  • asString
  • asObject

Sub Schemas

The schema defines the following additional types:

asString (enum)

One of: camelCase, PascalCase, snake_case, UPPER_CASE, kebab-case, matchDocumentStyle

asObject (object)

Properties of the asObject object:

style (enum)

This element must be one of the following enum values:

  • camelCase
  • PascalCase
  • snake_case
  • UPPER_CASE
  • kebab-case
  • matchDocumentStyle

suffix (string)

prefix (string)

Resources

Lone Executable DefinitionNo Anonymous Operations