@graphql-eslint/eslint-plugin/docs/rules/match-document-filename.md

GraphQL plugin for ESLint

# `match-document-filename`

- Category: `Operations`
- Rule name: `@graphql-eslint/match-document-filename`
- Requires GraphQL Schema: `false` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
- Requires GraphQL Operations: `false`
  [ℹ️](../../README.md#extended-linting-rules-with-siblings-operations)

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

## Usage Examples

### Correct

```graphql
# eslint @graphql-eslint/match-document-filename: ['error', { fileExtension: '.gql' }]

# user.gql
type User {
  id: ID!
}
```

### Correct

```graphql
# eslint @graphql-eslint/match-document-filename: ['error', { query: 'snake_case' }]

# user_by_id.gql
query UserById {
  userById(id: 5) {
    id
    name
    fullName
  }
}
```

### Correct

```graphql
# 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

```graphql
# eslint @graphql-eslint/match-document-filename: ['error', { mutation: { style: 'PascalCase', suffix: 'Mutation' } }]

# DeleteUserMutation.gql
mutation DELETE_USER {
  deleteUser(id: 5)
}
```

### Incorrect

```graphql
# eslint @graphql-eslint/match-document-filename: ['error', { fileExtension: '.graphql' }]

# post.gql
type Post {
  id: ID!
}
```

### Incorrect

```graphql
# eslint @graphql-eslint/match-document-filename: ['error', { query: 'PascalCase' }]

# user-by-id.gql
query UserById {
  userById(id: 5) {
    id
    name
    fullName
  }
}
```

### Correct

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

# mutation.add-alert.graphql
mutation addAlert {
  foo
}
```

### Correct

```graphql
# 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

- [Rule source](../../packages/plugin/src/rules/match-document-filename.ts)
- [Test source](../../packages/plugin/tests/match-document-filename.spec.ts)