checkPath

Check the existence and, optionally, the type of path.

Parameters

checkPath: str

Path to check, which may include environment variables for substitution

aliases: checkPath, CheckPath

type: str (Optional)

Additionally check whether the path corresponds to a valid 'file' or 'dir'.

desc: str (Optional)

The description for the check

substitute: bool (Optional)

Whether to substitute environment variables in check values

default: True

aliases: substitute, env_substitute

Example 1 (yaml)

The checkPath check in YAML format.

checks:
  Pyproject:
    desc: A project's pyprojectfile
    checkPath: ./pyproject.toml
    type: file

Example 2 (toml)

The checkPath check in TOML format.

[checks.Environment.Pyproject]
desc = "A project's pyprojectfile"
checkPath = "./pyproject.toml"
type = "file"

Example 3 (toml)

The checkPath check in abbreviated TOML format.

[checks.Environment]
Pyproject = { checkPath = "./pyproject.toml", type = "file" }