useBiomeIgnoreFolder

JSON (and super languages)

Summary

Diagnostic Category: lint/suspicious/useBiomeIgnoreFolder
This rule is recommended, which means is enabled by default.
This rule has a safe fix.
The default severity of this rule is warning.

How to configure

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

Description

Promotes the correct usage for ignoring folders in the configuration file.

Starting Biome v2.2, ignoring folders doesn’t require the use of the trailing /**. When using the pattern /**, you tell Biome to ignore all files inside a folder, but the folder is still crawled. This pattern can lead to poor performance, especially if the folder contains many files.

If the intention is to ignore specific files inside a folder, the trailing pattern /** shouldn’t be used.

Examples

Invalid

1
{
2
    "files": {
3
        "includes": ["**", "!dist/**", "!**/dist/**"]
4
    }
5
}

Valid

1
{
2
    "files": {
3
        "includes": ["**", "!dist", "!**/dist"]
4
    }
5
}