gruft

Appearance

Root ​

The top-level configuration for gruft. It is used to define the project's settings and options, and is typically located in the root directory of the project.

root ​

Flag to indicate that the configuration file is the root configuration file. This is used when using the nested configuration feature.

This is a required field and must be set to true unless it is a nested configuration file.

  • Type: boolean

Example:

toml
root = true

version ​

The version of CLI to use.

This is a required field and will be set to the version of the CLI that created the configuration file.

  • Type: string

Example:

toml
version = "2024.06.1"

include ​

A list of glob patterns to include files for processing files. It uses doublestar glob notation.

  • Default: ["**/*]
  • Type: []string

Example:

toml
include = ["docs/**/*.md", "src/**/*.html"]

exclude ​

A list of glob patterns to exclude files from processing files. It uses doublestar glob notation. When include is present, exclude will take predence.

  • Default: []
  • Type: []string

Example:

toml
exclude = ["dist/**"]

NOTE

We automatically exclude certain directories and files from processing, such as .git or node_modules. The full list can be found in the known exclusions list.

max_diagnostics ​

The maximum number of error diagnostics to display. If set to 0, all diagnostics will be hidden.

  • Type: int
  • Default: 10

Example:

toml
max_diagnostics = 5