# Config

# preflight.toml

Although the package comes with a sane default configuration, nothing stops you from customizing it for your specific needs.

A preflight.toml looks like this:

[my-checker-id-1]
enabled = false

[my-checker-id-2]
blacklist = [
  'bad-1',
  'bad-2',
]
whitelist = [
  'remove-me-from-blacklist',
]

[my-checker-id-3]
includes = [
  'must-have-1',
  'must-have-2',
]
excludes = [
  'remove-me-from-includes',
]

Learn more about checker configuration.

# Where to put preflight.toml?

By default, the package looks for preflight.toml under ABSPATH, usually this mean same level with wp-config.php.

/my/htdocs/wordpress
├── ...
├── preflight.toml
└── wp-config.php

# PREFLIGHT_DIR

For Bedrock or other custom WordPress structures, which not suitable for adding config files under ABSPATH. You can use PREFLIGHT_DIR to define an alternative path.

define('PREFLIGHT_DIR', '/my/absolute/path');

The package looks for /my/absolute/path/preflight.toml.

# $ wp preflight config paths

# get the paths to all config files
$ wp preflight config paths
Success: 3 config files found.
Success: The later ones override any previous configurations.
/root/.wp-cli/packages/vendor/itinerisltd/preflight-command/config/default.toml
/app/public/preflight.toml
/app/preflight.toml

# TOML

Key Points:

• file extension is .toml (e.g: preflight.toml)
• TOML is case sensitive
• empty array is invalid
• indentation doesn't matter
• tabs or spaces doesn't matter

Learn more about TOML on its GitHub repo.

# $ wp preflight config validate

Worry not. We check your config files as well.

# validate all the config files including the package default ones
$ wp preflight config validate
====> Validating /root/.wp-cli/packages/vendor/itinerisltd/preflight-command/config/default.toml
Success: File '/root/.wp-cli/packages/vendor/itinerisltd/preflight-command/config/default.toml' is valid.

====> Validating /app/public/preflight.toml

  Syntax error: unexpected token "T_NEWLINE" at line 2 with value "". Expected "T_RIGHT_SQUARE_BRAKET" in "\/app\/public\/preflight.toml".

Warning: File '/app/public/preflight.toml' will be ignored.