Skip to content

Commit

Permalink
Add docs for all three commands
Browse files Browse the repository at this point in the history
  • Loading branch information
ernilambar committed Jan 22, 2024
1 parent 2807dc4 commit 3c405cf
Show file tree
Hide file tree
Showing 3 changed files with 106 additions and 35 deletions.
105 changes: 105 additions & 0 deletions docs/CLI.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,105 @@
[Back to overview](./README.md)

# wp plugin check

Runs plugin check.

## OPTIONS
```
<plugin>
: The plugin to check. Plugin name.
[--checks=<checks>]
: Only runs checks provided as an argument in comma-separated values, e.g. i18n_usage, late_escaping. Otherwise runs all checks.
[--exclude-checks=<checks>]
: Exclude checks provided as an argument in comma-separated values, e.g. i18n_usage, late_escaping.
Applies after evaluating `--checks`.
[--format=<format>]
: Format to display the results. Options are table, csv, and json. The default will be a table.
---
default: table
options:
- table
- csv
- json
---
[--categories]
: Limit displayed results to include only specific categories Checks.
[--fields=<fields>]
: Limit displayed results to a subset of fields provided.
[--ignore-warnings]
: Limit displayed results to exclude warnings.
[--ignore-errors]
: Limit displayed results to exclude errors.
[--include-experimental]
: Include experimental checks.
[--exclude-directories=<directories>]
: Additional directories to exclude from checks
By default, `.git`, `vendor` and `node_modules` directories are excluded.
```
## EXAMPLES
```
wp plugin check akismet
wp plugin check akismet --checks=late_escaping
wp plugin check akismet --format=json
```

# wp plugin list-checks

Lists the available checks for plugins.

## OPTIONS
```
[--fields=<fields>]
: Limit displayed results to a subset of fields provided.
[--format=<format>]
: Format to display the results. Options are table, csv, and json. The default will be a table.
---
default: table
options:
- table
- csv
- json
---
[--categories]
: Limit displayed results to include only specific categories.
[--include-experimental]
: Include experimental checks.
```

# wp plugin list-check-categories

Lists the available check categories for plugins.

## OPTIONS
```
[--fields=<fields>]
: Limit displayed results to a subset of fields provided.
[--format=<format>]
: Format to display the results. Options are table, csv, and json. The default will be a table.
---
default: table
options:
- table
- csv
- json
---
```
## EXAMPLES
```
wp plugin list-check-categories
wp plugin list-check-categories --format=json
```

2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@
* [Technical Overview](technical-overview.md)
* [Creating a Static Check](creating-a-static-check.md)
* [Creating a Runtime Check](creating-a-runtime-check.md)
* [Plugin Check CLI Command](wp-plugin-check.md)
* [CLI Commands](CLI.md)
34 changes: 0 additions & 34 deletions docs/wp-plugin-check.md

This file was deleted.

0 comments on commit 3c405cf

Please sign in to comment.