Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
swissspidy committed Oct 31, 2023
1 parent 824691c commit c8fd8be
Showing 1 changed file with 34 additions and 2 deletions.
36 changes: 34 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,12 +35,44 @@ jobs:
uses: swissspidy/wp-plugin-check-action@main
```
### Inputs
The following inputs are supported:
* `build-dir` (string): path to the build directory if there is a build process involved.
**Note:** file annotations will still be made against the source files.
* `checks` (string): only run specific checks, separated by comma.
* `categories` (string): only run checks from specific categories, separated by comma.
* `checks` (string): only run specific checks, separated by comma or newline.
* `categories` (string): only run checks from specific categories, separated by comma or newline.
* `ignore-warnings` (bool): ignore warnings.
* `ignore-errors` (bool): ignore errors.
* `include-experimental` (bool): include experimental checks.

#### Supported Checks

At the moment, the following checks exist:

* `i18n_usage`
* `enqueued_scripts_size`
* `code_obfuscation`
* `file_type`
* `plugin_header_text_domain`
* `late_escaping`
* `plugin_updater`
* `plugin_review_phpcs`
* `performant_wp_query_params`
* `enqueued_scripts_in_footer`
* `plugin_readme`
* `enqueued_styles_scope`
* `localhost`
* `no_unfiltered_uploads`
* `trademarks`

#### Supported Categories

At the moment, the following categories exist:

* `general`
* `plugin_repo`
* `security`
* `performance`
* `accessibility`

0 comments on commit c8fd8be

Please sign in to comment.