File: phpcbf.1

package info (click to toggle)
php-codesniffer 2.7.1-1
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 6,460 kB
  • ctags: 8,660
  • sloc: php: 40,311; xml: 9,505; pascal: 3,365; makefile: 16; sh: 6
file content (164 lines) | stat: -rw-r--r-- 2,612 bytes parent folder | download
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
.TH phpcbf 1 "2016-04-06"
.SH NAME
phpcbf - automatically fix errors found by PHPCS
.SH SYNOPSIS
.B phpcbf
.RB [ \-nwli ]
.RB [ \-d
.IR key [\c
.BI = value\c
.RB ]]\ [ \-\-stdin-path=\c
.IR stdinPath ]
.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 [ \-\-extensions=\c
.IR extensions ]
.RB [ \-\-ignore=\c
.IR patterns ]
.RB [ \-\-bootstrap=\c
.IR bootstrap ]
.RB [ \-\-file\-list=\c
.IR fileList ]
.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 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 stdinPath
.IP
If processing STDIN, the file path that STDIN will be processed as

.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
(extension filtering only valid when checking a directory).
The type of the file can be specified using: ext/type;
e.g., module/php,es/js

.LP
.I patterns
.IP
A comma separated list of patterns to ignore files and directories

.LP
.I sniffs
.IP
A comma separated list of sniff codes to include or exclude during checking
(all sniffs must be part of the specified standard)

.LP
.I severity
.IP
The minimum severity required to fix an error or warning

.LP
.I standard
.IP
The name or path of the coding standard to use

.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 \-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 \-\-no-patch
.IP
Do not make use of the "diff" or "patch" programs

.SH "SEE ALSO"
.BR phpcs (1)