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
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
|
.TH phpcbf 1 "2018-02-27"
.SH NAME
phpcbf - automatically fix errors found by PHPCS
.SH SYNOPSIS
.B phpcbf
.RB [ \-nwli ]
.RB [ \-d
.IR key [\c
.BI = value\c
.RB ]]\ [ \-\-ignore-annotations ]
.RB [ \-\-bootstrap=\c
.IR bootstrap ]
.RB [ \-\-standard=\c
.IR standard ]
.RB [ \-\-sniffs=\c
.IR sniffs ]
.RB [ \-\-exclude=\c
.IR sniffs ]
.RB [ \-\-suffix=\c
.IR suffix ]
.RB [ \-\-severity=\c
.IR severity ]
.RB [ \-\-error\-severity=\c
.IR severity ]
.RB [ \-\-warning\-severity=\c
.IR severity ]
.RB [ \-\-tab\-width=\c
.IR tabWidth ]
.RB [ \-\-encoding=\c
.IR encoding ]
.RB [ \-\-parallel=\c
.IR processes ]
.RB [ \-\-basepath=\c
.IR basepath ]
.RB [ \-\-extensions=\c
.IR extensions ]
.RB [ \-\-ignore=\c
.IR patterns ]
.RB [ \-\-stdin-path=\c
.IR stdinPath ]
.RB [ \-\-file\-list=\c
.IR fileList ]
.RB [ \-\-filter=\c
.IR filter ]
.IR file \ \.\.\.
.SH DESCRIPTION
.LP
.B phpcbf
(or PHP Code Beautifier and Fixer) is a PHP script to automatically fix as many sniff violations as possible.
.SH PARAMETERS
.LP
.I basepath
.IP
A path to strip from the front of file paths inside reports
.LP
.I bootstrap
.IP
A comma separated list of files to run before processing starts
.LP
.I encoding
.IP
The encoding of the files being fixed (default is iso-8859-1)
.LP
.I extensions
.IP
A comma separated list of file extensions to fix.
The type of the file can be specified using: ext/type;
e.g., module/php,es/js
.LP
.I file
.IP
One or more files and/or directories to fix
.LP
.I fileList
.IP
A file containing a list of files and/or directories to check (one per line)
.LP
.I filter
.IP
Use either the
.BR GitModified
or
.BR GitStaged
filter, or specify the path to a custom filter class
.LP
.I patterns
.IP
A comma separated list of patterns to ignore files and directories
.LP
.I processes
.IP
How many files should be fixed simultaneously (default is 1)
.LP
.I severity
.IP
The minimum severity required to fix an error or warning
.LP
.I sniffs
.IP
A comma separated list of sniff codes to include or exclude from fixing
(all sniffs must be part of the specified standard)
.LP
.I standard
.IP
The name or path of the coding standard to use
.LP
.I stdinPath
.IP
If processing STDIN, the file path that STDIN will be processed as
.LP
.I suffix
.IP
Write modified files to a filename using this suffix
("diff" and "patch" are not used in this mode)
.LP
.I tabWidth
.IP
The number of spaces each tab represents
.SH OPTION
.LP
.B \-n
.IP
Do not fix warnings (shortcut for
.BR \-\-warning\-severity=0 )
.LP
.B \-w
.IP
Fix both warnings and errors (on by default)
.LP
.B \-l
.IP
Local directory only, no recursion
.LP
.B \-p
.IP
Show progress of the run
.LP
.B \-q
.IP
Quiet mode; disables progress and verbose output
.LP
.BR \-v
.IP
Print processed files
.LP
.BR \-vv
.IP
Print ruleset and token output
.LP
.BR \-vvv
.IP
Print sniff processing information
.LP
.B \-i
.IP
Show a list of installed coding standards
.LP
.B \-d
.IP
Set the
.I key
php.ini value to
.I value
or
.B true
if
.I value
is omitted
.LP
.B \-\-help
.IP
Print the help message
.LP
.B \-\-version
.IP
Print version information
.LP
.B \-\-ignore\-annotations
.IP
Ignore all phpcs: annotations in code comments
.SH "SEE ALSO"
.BR phpcs (1)
|
