platformio check¶
Helper command for PIO Check.
Contents
Usage¶
platformio check [OPTIONS]
pio check [OPTIONS]
Description¶
Perform static analysis check on PlatformIO based project. By default Cppcheck analysis tool is used.
More details about PlatformIO PIO Check.
Options¶
- -e, --environment¶
Process specified environments.
- --pattern¶
You can specify which source files or folders should be included/excluded from check
process. By default only src_dir and include_dir
are checked. Multiple --pattern
options and GLOB Patterns are allowed.
Example: platformio check --pattern="tests" --pattern="src/*.cpp"
- --flags¶
Specify additional flags that need to be passed to the analysis tool. If multiple tools set in check_tool option, the flags are passed to all of them. Individual flags for each tool can be added using a special suffix with the tool name.
Flag |
Meaning |
---|---|
|
Execute addon. i.e. cert. |
|
Define preprocessor symbol. |
Multiple --flags
options are allowed.
Example: platformio check --flags "-DDEBUG cppcheck: --std=c++11 --platform=avr8"
- --severity¶
Specify the Defect severity types which will be reported by the Check tools.
Possible values described in Defect severity section. Multiple --severity
options are allowed.
Example: platformio check --severity=high
- -d, --project-dir¶
Specify the path to project directory. By default, --project-dir
is equal
to the current working directory (CWD
).
- -c, --project-conf¶
Process project with a custom “platformio.ini” (Project Configuration File).
- --json-output¶
Return the output in JSON format.
- --fail-on-defect¶
Fail (exit with non-zero code) if there is a defect found with specified
severity. By default exit code is the same as the exit code returned by
a tool selected for performing check. Possible values described in
Defect severity section. Multiple --fail-on-defect
options are allowed.
Example: platformio check --fail-on-defect=low --fail-on-defect=medium
- -s, --silent¶
Suppress progress reporting and show only defects with high
severity.
See Defect severity.
- -v, --verbose¶
Show detailed information when processing environments.
This option can also be set globally using force_verbose setting
or by environment variable PLATFORMIO_SETTING_FORCE_VERBOSE
.
Examples¶
For the examples please follow to PIO Check page.