forked from PHPCheckstyle/phpcheckstyle
/
run.php
179 lines (144 loc) · 4.21 KB
/
run.php
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
#!/usr/bin/php
<?php
/**
* CLI file to run the PHPCheckstyle
*
* @version 1.12.0
*/
function usage() {
$options = array(
"--src" =>
"Root of the source directory tree or a file (can be repeated for multiple sources).",
"--exclude" =>
"[Optional] A directory or file that needs to be excluded (can be repeated for multiple exclusions).",
"--format" =>
"[Optional] Output format (html/text/xml/xml_console/console/html_console). Defaults to 'html'.",
"--outdir" =>
"[Optional] Report Directory. Defaults to './style-report'.",
"--config" =>
"[Optional] The name of the config file'.",
"--debug" =>
"[Optional] Add some debug logs (warning, very verbose)'.",
"--linecount" =>
"[Optional] Generate a report on the number of lines of code (JavaNCSS format)'.",
"--progress" =>
"[Optional] Prints a message noting the file and every line that is covered by PHPCheckStyle.",
"--lang" =>
"[Optional] Language file to use for the result (en-us by default).",
"--quiet" =>
"[Optional] Quiet mode.",
"--help" =>
"Display this usage information.",
);
echo "Usage: " . $_SERVER['argv'][0] . " <options>\n";
echo "\n";
echo " Options: \n";
foreach ($options as $option => $description) {
echo " " . str_pad($option, 16, " ") . $description . "\n";
}
exit();
}
// default values
$options['src'] = false;
$options['exclude'] = array();
$options['format'] = "html"; // default format
$options['outdir'] = "./style-report"; // default ouput directory
$options['config'] = "default.cfg.xml";
$options['debug'] = false;
$options['progress'] = false;
$options['lang'] = 'en-us';
$options['quiet'] = false;
$lineCountFile = null;
// loop through user input
for ($i = 1; $i < $_SERVER["argc"]; $i ++) {
switch ($_SERVER["argv"][$i]) {
case "--src":
$i++;
$options['src'][] = $_SERVER['argv'][$i];
break;
case "--outdir":
$i++;
$options['outdir'] = $_SERVER['argv'][$i];
break;
case "--exclude":
$i++;
$options['exclude'][] = $_SERVER['argv'][$i];
break;
case "--format":
$i++;
$options['format'] = $_SERVER['argv'][$i];
break;
case "--lang":
$i++;
$options['lang'] = $_SERVER['argv'][$i];
break;
case "--config":
$i++;
$options['config'] = $_SERVER['argv'][$i];
break;
case "--debug":
$options['debug'] = true;
break;
case "--linecount":
$options['linecount'] = true;
break;
case "--progress":
$options['progress'] = true;
break;
case "--quiet":
$options['quiet'] = true;
break;
case "--help":
usage();
break;
default:
usage();
break;
}
}
define("PHPCHECKSTYLE_HOME_DIR", dirname(__FILE__));
// require_once PHPCHECKSTYLE_HOME_DIR."/src/PHPCheckstyle.php";
require_once "vendor/autoload.php";
// check for valid format and set the output file name
// right now the output file name is not configurable, only
// the output directory is configurable (from command line)
$knownFormats = array(
'html',
'html_console',
'console',
'text',
'xml',
'xml_console',
'array'
);
$formats = explode(',', $options['format']);
$unknownFormats = array_diff($formats, $knownFormats);
if (!empty($unknownFormats)) {
echo sprintf("\nUnknown format %s.\n\n", implode(', ', $unknownFormats));
usage();
}
// check that source directory is specified and is valid
if (!$options['src']) {
echo "\nPlease specify a source directory/file using --src option.\n\n";
usage();
}
if (!empty($options['linecount'])) {
$lineCountFile = "ncss.xml";
}
$style = new PHPCheckstyle\PHPCheckstyle($formats, $options['outdir'], $options['config'], $lineCountFile, $options['debug'], $options['progress']);
if (file_exists(__DIR__ . '/src/PHPCheckstyle/Lang/' . $options['lang'] . '.ini')) {
$style->setLang($options['lang']);
}
$style->processFiles($options['src'], $options['exclude']);
$errorCounts = $style->getErrorCounts();
if (!$options['quiet']) {
echo PHP_EOL . "Summary" . PHP_EOL;
echo "=======" . PHP_EOL . PHP_EOL;
echo "Errors: " . $errorCounts[ERROR] . PHP_EOL;
echo "Ignores: " . $errorCounts[IGNORE] . PHP_EOL;
echo "Infos: " . $errorCounts[INFO] . PHP_EOL;
echo "Warnings: " . $errorCounts[WARNING] . PHP_EOL;
echo "=======" . PHP_EOL . PHP_EOL;
echo "Reporting Completed." . PHP_EOL;
}
exit(0);