Skip to content

Clarify ignore-codes CLI documentation #1332

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ekamran wants to merge 1 commit into
base: trunk
Choose a base branch
from
Open

Clarify ignore-codes CLI documentation #1332

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion docs/CLI.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,11 @@ Runs plugin check.
Applies after evaluating `--checks`.

[--ignore-codes=<codes>]
: Ignore error codes provided as an argument in comma-separated values.
: Ignore result codes provided as an argument in comma-separated values, e.g. missing_composer_json_file.
Result codes are individual findings emitted by checks. They are different from check slugs used with
`--checks` and `--exclude-checks`.
Use an output format such as `--format=json` or `--format=csv` to inspect result codes.
For example: `wp plugin check akismet --format=csv --fields=code,message`.

[--format=<format>]
: Format to display the results. Options are table, csv, json, ctrf, strict-table, strict-csv, strict-json, and strict-ctrf. The default will be a table.
Expand Down Expand Up @@ -52,9 +56,13 @@ options:
[--exclude-directories=<directories>]
: Additional directories to exclude from checks.
By default, `.git`, `vendor`, `vendor_prefixed`, `vendor-prefixed` and `node_modules` directories are excluded.
This only excludes files from file-based scans. It does not suppress plugin-level findings such as
missing_composer_json_file; use `--ignore-codes` for specific result codes.

[--exclude-files=<files>]
: Additional files to exclude from checks.
This only excludes files from file-based scans. It does not suppress plugin-level findings such as
missing_composer_json_file; use `--ignore-codes` for specific result codes.

[--severity=<severity>]
: Severity level.
Expand Down Expand Up @@ -87,6 +95,8 @@ options:
```
wp plugin check akismet
wp plugin check akismet --checks=late_escaping
wp plugin check akismet --format=csv --fields=code,message
wp plugin check akismet --ignore-codes=missing_composer_json_file
wp plugin check akismet --format=json
wp plugin check akismet --format=ctrf
wp plugin check akismet --mode=update
Expand Down
12 changes: 11 additions & 1 deletion includes/CLI/Plugin_Check_Command.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,11 @@ public function __construct( Plugin_Context $plugin_context ) {
* Applies after evaluating `--checks`.
*
* [--ignore-codes=<codes>]
* : Ignore error codes provided as an argument in comma-separated values.
* : Ignore result codes provided as an argument in comma-separated values, e.g. missing_composer_json_file.
* Result codes are individual findings emitted by checks. They are different from check slugs used with
* `--checks` and `--exclude-checks`.
* Use an output format such as `--format=json` or `--format=csv` to inspect result codes.
* For example: `wp plugin check akismet --format=csv --fields=code,message`.
*
* [--format=<format>]
* : Format to display the results. Options are table, csv, json, ctrf, strict-table, strict-csv, strict-json, and strict-ctrf. The default will be a table.
Expand Down Expand Up @@ -112,9 +116,13 @@ public function __construct( Plugin_Context $plugin_context ) {
* [--exclude-directories=<directories>]
* : Additional directories to exclude from checks.
* By default, `.git`, `vendor`, `vendor_prefixed`, `vendor-prefixed` and `node_modules` directories are excluded.
* This only excludes files from file-based scans. It does not suppress plugin-level findings such as
* missing_composer_json_file; use `--ignore-codes` for specific result codes.
*
* [--exclude-files=<files>]
* : Additional files to exclude from checks.
* This only excludes files from file-based scans. It does not suppress plugin-level findings such as
* missing_composer_json_file; use `--ignore-codes` for specific result codes.
*
* [--severity=<severity>]
* : Severity level.
Expand Down Expand Up @@ -153,6 +161,8 @@ public function __construct( Plugin_Context $plugin_context ) {
*
* wp plugin check akismet
* wp plugin check akismet --checks=late_escaping
* wp plugin check akismet --format=csv --fields=code,message
* wp plugin check akismet --ignore-codes=missing_composer_json_file
* wp plugin check akismet --format=json
* wp plugin check akismet --mode=update
* wp plugin check akismet --ai
Expand Down
Loading