noExcessiveLinesPerFile (GraphQL)

Summary

Rule available since: v2.3.12
Diagnostic Category: lint/style/noExcessiveLinesPerFile
This rule isn’t recommended, so you need to enable it.
This rule doesn’t have a fix.
The default severity of this rule is information.

How to configure

1
{
2
  "linter": {
3
    "rules": {
4
      "style": {
5
        "noExcessiveLinesPerFile": "error"
6
      }
7
    }
8
  }
9
}

Description

Restrict the number of lines in a file.

Large GraphQL documents are harder to navigate and maintain. A line limit can encourage splitting unrelated definitions into focused files.

Examples

Invalid

This example reports a diagnostic when maxLines is 2:

1
{
2
  "linter": {
3
    "rules": {
4
      "style": {
5
        "noExcessiveLinesPerFile": {
6
          "level": "on",
7
          "options": {
8
            "maxLines": 2
9
          }
10
        }
11
      }
12
    }
13
  }
14
}

1
query Foo { id }
2
query Bar { id }
3
query Baz { id }

code-block.graphql:1:1 lint/style/noExcessiveLinesPerFile ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ℹ This file has too many lines (3). Maximum allowed is 2.
  
  > 1 │ query Foo { id }
      │ ^^^^^^^^^^^^^^^^
  > 2 │ query Bar { id }
  > 3 │ query Baz { id }
      │ ^^^^^^^^^^^^^^^^
    4 │ 
  
  ℹ Consider splitting this file into smaller files.

Valid

1
query Foo { id }
2
query Bar { id }

Options

`maxLines`

Sets the maximum number of lines allowed in a file. Defaults to 300.

This example lowers the limit to 4 and reports a five-line file:

1
{
2
  "linter": {
3
    "rules": {
4
      "style": {
5
        "noExcessiveLinesPerFile": {
6
          "level": "on",
7
          "options": {
8
            "maxLines": 4
9
          }
10
        }
11
      }
12
    }
13
  }
14
}

1
query Foo { id }
2
query Bar { id }
3
query Baz { id }
4
query Qux { id }
5
query Quux { id }

code-block.graphql:1:1 lint/style/noExcessiveLinesPerFile ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ℹ This file has too many lines (5). Maximum allowed is 4.
  
  > 1 │ query Foo { id }
      │ ^^^^^^^^^^^^^^^^
  > 2 │ query Bar { id }
  > 3 │ query Baz { id }
  > 4 │ query Qux { id }
  > 5 │ query Quux { id }
      │ ^^^^^^^^^^^^^^^^^
    6 │ 
  
  ℹ Consider splitting this file into smaller files.

`skipBlankLines`

Excludes blank lines from the line count when set to true. Defaults to false.

Here, the blank lines do not count toward the limit:

1
{
2
  "linter": {
3
    "rules": {
4
      "style": {
5
        "noExcessiveLinesPerFile": {
6
          "level": "on",
7
          "options": {
8
            "maxLines": 2,
9
            "skipBlankLines": true
10
          }
11
        }
12
      }
13
    }
14
  }
15
}

1
query Foo { id }
2

3

4
query Bar { id }

Suppressions

If you need to exceed the line limit in a specific file, you can suppress this rule at the top of the file:

1
{
2
  "linter": {
3
    "rules": {
4
      "style": {
5
        "noExcessiveLinesPerFile": {
6
          "level": "on",
7
          "options": {
8
            "maxLines": 2
9
          }
10
        }
11
      }
12
    }
13
  }
14
}

1
# biome-ignore-all lint/style/noExcessiveLinesPerFile: generated file
2
query Foo { id }
3
query Bar { id }
4
query Baz { id }