Skip to content

Commit dfdd77a

Browse files
author
Greg Bowler
committed
feature: add other arguments
1 parent 189f76c commit dfdd77a

File tree

3 files changed

+217
-1
lines changed

3 files changed

+217
-1
lines changed

‎README.md

+76-1
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,79 @@
33
Run PHP Code Sniffer tests in Github Actions.
44
=============================================
55

6-
// TODO.
6+
PHP_CodeSniffer is a script that tokenizes PHP, JavaScript and CSS files to detect violations of a defined coding standard - an essential development tool that ensures your code remains clean and consistent.
7+
8+
Common standards that can be checked include:
9+
10+
+ Use of camel case in variable, function, class names
11+
+ Indentation rules, such as using tabs vs. spaces
12+
+ Forbidden functions, such as `die()`
13+
+ Checking that PHP files are side-effect-free
14+
15+
Usage
16+
-----
17+
18+
```yaml
19+
name: CI
20+
21+
on: [push]
22+
23+
jobs:
24+
build-and-test:
25+
runs-on: ubuntu-latest
26+
27+
steps:
28+
- uses: actions/checkout@v3
29+
30+
- name: Composer install
31+
uses: php-actions/composer@v6
32+
33+
- name: PHP Code Sniffer
34+
uses: php-actions/phpcs@v1
35+
with:
36+
php_version: 8.1
37+
path: src/
38+
standard: phpcs.xml
39+
```
40+
41+
Version numbers
42+
---------------
43+
44+
This action is released with semantic version numbers, but also tagged so the latest major release's tag always points to the latest release within the matching major version.
45+
46+
Please feel free to use uses: php-actions/phpcs@v1 to always run the latest version of v1, or uses: php-actions/[email protected] to specify the exact release.
47+
48+
Inputs
49+
------
50+
51+
The following configuration options are available:
52+
53+
+ `version` - What version of PHPCS to use
54+
+ `php_version` - What version of PHP to use
55+
+ `vendored_phpcs_path` - Path to a vendored phpcs binary
56+
+ `path` - One or more files and/or directories to check
57+
+ `standard` - The name or path of the coding standard to use
58+
+ `sniffs` - A comma separated list of sniff codes to include checking (all sniffs must be part of the specified standard)
59+
+ `exclude` - A comma separated list of sniff codes to exclude from checking (all sniffs must be part of the specified standard)
60+
+ `ignore` - A comma separated list of patterns to ignore files and directories
61+
+ `tab_width` - The number of spaces each tab represents
62+
+ `report` - Print either the "full", "xml", "checkstyle", "csv", "json", "junit", "emacs", "source", "summary", "diff", "svnblame", "gitblame", "hgblame" or "notifysend" report, or specify the path to a custom report class, (the "full" report is printed by default)
63+
+ `report_file` - Write the report to the specified file path
64+
+ `report_width` - How many columns wide screen reports should be printed or set to "auto" to use current screen width, where supported
65+
+ `basepath` - A path to strip from the front of file paths inside reports
66+
+ `bootstrap` - A comma separated list of files to run before processing begins
67+
+ `encoding` - The encoding of the files being checked (default is utf-8)
68+
+ `extensions` - "A comma separated list of file extensions to check. The type of the file can be specified using: ext/type e.g., module/php,es/js"
69+
+ `severity` - The minimum severity required to display an error or warning
70+
+ `error_severity` - The minimum severity required to display an error
71+
+ `warning_severity` - The minimum severity required to display a warning
72+
+ `args` - Extra arguments to pass to the phpcs binary
73+
74+
If you require other configurations of PHPMD, please request them in the [Github issue tracker].
75+
76+
*****
77+
78+
If you found this repository helpful, please consider [sponsoring the developer][sponsor].
79+
80+
[Github issue tracker]: https://github.com/php-actions/phpcs/issues
81+
[sponsor]: https://github.com/sponsors/g105b

‎action.yml

+71
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,63 @@ inputs:
2424
description: The name or path of the coding standard to use
2525
required: true
2626

27+
sniffs:
28+
description: A comma separated list of sniff codes to include checking (all sniffs must be part of the specified standard)
29+
required: false
30+
31+
exclude:
32+
description: A comma separated list of sniff codes to exclude from checking (all sniffs must be part of the specified standard)
33+
required: false
34+
35+
ignore:
36+
description: A comma separated list of patterns to ignore files and directories
37+
required: false
38+
39+
tab_width:
40+
description: The number of spaces each tab represents
41+
required: false
42+
43+
report:
44+
description: Print either the "full", "xml", "checkstyle", "csv", "json", "junit", "emacs", "source", "summary", "diff", "svnblame", "gitblame", "hgblame" or "notifysend" report, or specify the path to a custom report class, (the "full" report is printed by default)
45+
required: true
46+
default: full
47+
48+
report_file:
49+
description: Write the report to the specified file path
50+
required: false
51+
52+
report_width:
53+
description: How many columns wide screen reports should be printed or set to "auto" to use current screen width, where supported
54+
required: false
55+
56+
basepath:
57+
description: A path to strip from the front of file paths inside reports
58+
required: false
59+
60+
bootstrap:
61+
description: A comma separated list of files to run before processing begins
62+
required: false
63+
64+
encoding:
65+
description: The encoding of the files being checked (default is utf-8)
66+
required: false
67+
68+
extensions:
69+
description: "A comma separated list of file extensions to check. The type of the file can be specified using: ext/type e.g., module/php,es/js"
70+
required: false
71+
72+
severity:
73+
description: The minimum severity required to display an error or warning
74+
required: false
75+
76+
error_severity:
77+
description: The minimum severity required to display an error
78+
required: false
79+
80+
warning_severity:
81+
description: The minimum severity required to display a warning
82+
required: false
83+
2784
args:
2885
description: Extra arguments to pass to the phpcs binary
2986
required: false
@@ -38,6 +95,20 @@ runs:
3895
ACTION_PHPCS_PATH: ${{ inputs.vendored_phpcs_path }}
3996
ACTION_PATH: ${{ inputs.path }}
4097
ACTION_STANDARD: ${{ inputs.standard }}
98+
ACTION_SNIFFS: ${{ inputs.sniffs }}
99+
ACTION_EXCLUDE: ${{ inputs.exclude }}
100+
ACTION_IGNORE: ${{ inputs.ignore }}
101+
ACTION_TAB_WIDTH: ${{ inputs.tab_width }}
102+
ACTION_REPORT: ${{ inputs.report }}
103+
ACTION_REPORT_FILE: ${{ inputs.report_file }}
104+
ACTION_REPORT_WIDTH: ${{ inputs.report_width }}
105+
ACTION_BASEPATH: ${{ inputs.basepath }}
106+
ACTION_BOOTSTRAP: ${{ inputs.bootstrap }}
107+
ACTION_ENCODING: ${{ inputs.encoding }}
108+
ACTION_EXTENSIONS: ${{ inputs.extensions }}
109+
ACTION_SEVERITY: ${{ inputs.severity }}
110+
ACTION_ERROR_SEVERITY: ${{ inputs.error_severity }}
111+
ACTION_WARNING_SEVERITY: ${{ inputs.warning_severity }}
41112
ACTION_ARGS: ${{ inputs.args }}
42113

43114
id: phpcs_run

‎phpcs-action.bash

+70
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,76 @@ then
2525
command_string+=(--standard="$ACTION_STANDARD")
2626
fi
2727

28+
if [ -n "$ACTION_SNIFFS" ]
29+
then
30+
command_string+=(--snifs="$ACTION_SNIFFS")
31+
fi
32+
33+
if [ -n "$ACTION_EXCLUDE" ]
34+
then
35+
command_string+=(--exclude="$ACTION_EXCLUDE")
36+
fi
37+
38+
if [ -n "$ACTION_IGNORE" ]
39+
then
40+
command_string+=(--ignore="$ACTION_IGNORE")
41+
fi
42+
43+
if [ -n "$ACTION_TAB_WIDTH" ]
44+
then
45+
command_string+=(--tab-width="$ACTION_TAB_WIDTH")
46+
fi
47+
48+
if [ -n "$ACTION_REPORT" ]
49+
then
50+
command_string+=(--report="$ACTION_REPORT")
51+
fi
52+
53+
if [ -n "$ACTION_REPORT_FILE" ]
54+
then
55+
command_string+=(--report-file="$ACTION_REPORT_FILE")
56+
fi
57+
58+
if [ -n "$ACTION_REPORT_WIDTH" ]
59+
then
60+
command_string+=(--report-width="$REPORT_WIDTH")
61+
fi
62+
63+
if [ -n "$ACTION_BASEPATH" ]
64+
then
65+
command_string+=(--basepath="$ACTION_BASEPATH")
66+
fi
67+
68+
if [ -n "$ACTION_BOOTSTRAP" ]
69+
then
70+
command_string+=(--bootstrap="$ACTION_BOOTSTRAP")
71+
fi
72+
73+
if [ -n "$ACTION_ENCODING" ]
74+
then
75+
command_string+=(--encoding="$ACTION_ENCODING")
76+
fi
77+
78+
if [ -n "$ACTION_EXTENSIONS" ]
79+
then
80+
command_string+=(--extensions="$ACTION_EXTENSIONS")
81+
fi
82+
83+
if [ -n "$ACTION_SEVERITY" ]
84+
then
85+
command_string+=(--severity="$ACTION_SEVERITY")
86+
fi
87+
88+
if [ -n "$ACTION_ERROR_SEVERITY" ]
89+
then
90+
command_string+=(--error-severity="$ACTION_ERROR_SEVERITY")
91+
fi
92+
93+
if [ -n "$ACTION_WARNING_SEVERITY" ]
94+
then
95+
command_string+=(--warning-severity="$ACTION_WARNING_SEVERITY")
96+
fi
97+
2898
if [ -n "$ACTION_ARGS" ]
2999
then
30100
command_string+=($ACTION_ARGS)

0 commit comments

Comments
 (0)