1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
|
.TH phpcs 1
.SH NAME
phpcs - php code sniffer cli tool
.SH SYNOPSIS
.B phpcs
.B [\-nwlsapvi] [\-d key[=value]]
.B [\-\-report=<report>] [\-\-report\-file=<reportfile>] [\-\-report-<report>=<reportfile>] ...
.B [\-\-report\-width=<reportWidth>] [\-\-generator=<generator>] [\-\-tab\-width=<tabWidth>]
.B [\-\-severity=<severity>] [\-\-error\-severity=<severity>] [\-\-warning\-severity=<severity>]
.B [\-\-config\-set key value] [\-\-config\-delete key] [\-\-config-show]
.B [\-\-standard=<standard>] [\-\-sniffs=<sniffs>] [\-\-encoding=<encoding>]
.B [\-\-extensions=<extensions>] [\-\-ignore=<patterns>] <file> ...
.SH DESCRIPTION
.LP
.I phpcs
(or PHP_CodeSniffer) is a PHP5 script that tokenises PHP, JavaScript and CSS
files to detect violations of a defined coding standard. It is an essential
development tool that ensures your code remains clean and consistent. It can also help prevent some common semantic
errors made by developers.
.SH PARAMETERS
.LP
.I <file>
.IP
One or more files and/or directories to check
.LP
.I <extensions>
.IP
A comma separated list of file extensions to check (only valid if checking a directory)
.LP
.I <patterns>
.IP
A comma separated list of patterns to ignore files and directories
.LP
.I <encoding>
.IP
The encoding of the files being checked (default is iso-8859-1)
.LP
.I <sniffs>
.IP
A comma separated list of sniff codes to limit the check to (all sniffs must be part of the specified standard)
.LP
.I <severity>
.IP
The minimum severity required to display an error or warning
.LP
.I <standard>
.IP
The name or path of the coding standard to use
.LP
.I <tabWidth>
.IP
The number of spaces each tab represents
.LP
.I <generator>
.IP
The name of a doc generator to use (forces doc generation instead of checking)
.LP
.I <report>
.IP
Print either the "full", "xml", "checkstyle", "csv", "emacs", "source", "summary", "svnblame", "gitblame" or "hgblame" report (the "full" report is printed by default)
.LP
.I <reportfile>
.IP
Write the report to the specified file path
.LP
.I <reportWidth>
.IP
How many columns wide screen reports should be printed
.SH "OPTION"
.LP
.B \-n
.IP
Do not print warnings (shortcut for \-\-\-warning\-severity=0)
.LP
.B \-w
.IP
Print both warnings and errors (on by default)
.LP
.B \-l
.IP
Local directory only, no recursion
.LP
.B \-s
.IP
Show sniff codes in all reports
.LP
.B \-a
.IP
Run interactively
.LP
.B \-p
.IP
Show progress of the run
.LP
.B \-v[v][v]
.IP
Print verbose output
.LP
.B \-i
.IP
Show a list of installed coding standards
.LP
.B \-d
.IP
Set the [key] php.ini value to [value] or [true] if \-value is omitted
.LP
.B \-\-help
.IP
Print the help message
.LP
.B \-\-version
.IP
Print version information
|
