-
Notifications
You must be signed in to change notification settings - Fork 37
/
Gruntfile.js
270 lines (201 loc) · 8.11 KB
/
Gruntfile.js
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
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
var fs = require('fs');
module.exports = function(grunt) {
grunt.initConfig(
{
/**
* Reads the 'package.json' file and puts it content into a 'pkg' Javascript object.
*/
pkg : grunt.file.readJSON('package.json'),
/**
* Clean task.
*/
clean : ['build'],
/**
* Copy task.
*/
copy : {
/**
* Copy test resource files to the build.
*/
'test-resources' : {
files : [
{
cwd: 'src/test/resources',
expand: true,
src: '**',
dest: 'build/test-resources/'
}
]
}
}, /* Copy task */
/**
* Shell Task
*/
shell : {
pdepend : {
command : function() {
var command = 'php vendor/pdepend/pdepend/src/bin/pdepend';
command += ' --jdepend-chart=build/reports/pdepend/jdepend-chart.svg';
command += ' --jdepend-xml=build/reports/pdepend/jdepend.xml';
command += ' --overview-pyramid=build/reports/pdepend/overview-pyramid.svg';
command += ' --summary-xml=build/reports/pdepend/summary.xml';
command += ' src/main/php';
return command;
}
},
phpcs : {
command : function() {
var command = 'php ./vendor/squizlabs/php_codesniffer/bin/phpcs';
command += ' --cache';
command += ' --filter=GitModified';
command += ' --parallel=16'; // Requires PHP to be compiled with PCNTL package
command += ' --standard=PSR2';
command += ' -v';
if(grunt.option('checkstyle') === true) {
command += ' --report=checkstyle';
command += ' --report-file=target/reports/phpcs/phpcs.xml';
}
command += ' src/main/php';
command += ' src/test/php/Gomoob';
return command;
}
},
phpcbf : {
command : function() {
var command = 'php ./vendor/squizlabs/php_codesniffer/bin/phpcbf';
command += ' --cache';
command += ' --filter=GitModified';
command += ' --parallel=16'; // Requires PHP to be compiled with PCNTL package
command += ' --standard=PSR2';
command += ' src/main/php';
command += ' src/test/php';
return command;
}
},
phpcpd : {
command : function() {
return 'php vendor/sebastian/phpcpd/phpcpd src/main/php';
}
},
phpdocumentor : {
command : function() {
return 'php vendor/phpdocumentor/phpdocumentor/bin/phpdoc.php --target=build/reports/phpdocumentor --directory=src/main/php';
}
},
phploc : {
command : function() {
return 'php vendor/phploc/phploc/phploc src/main/php';
}
},
phpmd : {
command : function() {
var command = 'php vendor/phpmd/phpmd/src/bin/phpmd ';
command += 'src/main/php ';
command += 'html ';
command += 'cleancode,codesize,controversial,design,naming,unusedcode ';
command += '--reportfile=build/reports/phpmd/phpmd.html';
return command;
},
options : {
callback : function(err, stdout, stderr, cb) {
grunt.file.write('build/reports/phpmd/phpmd.html', stdout);
cb();
}
}
},
phpunit : {
command: (function() {
var commandLine = 'php vendor/phpunit/phpunit/phpunit ';
commandLine += '--configuration phpunit.xml.dist ';
commandLine += '--colors=auto ';
if(typeof grunt.option('group') !== 'undefined') {
commandLine += '--group=' + grunt.option('group') + ' ';
}
commandLine += 'src/test/php/ ';
return commandLine;
}),
options : {
execOptions : {
maxBuffer : 1000 * 1000 * 64 // 64 MB
}
}
}
} /* Shell Task */
}
); /* Grunt initConfig call */
// Load the Grunt Plugins
require('load-grunt-tasks')(grunt);
/**
* Task used to create directories needed by PDepend to generate its report.
*/
grunt.registerTask('before-pdepend' , 'Creating directories required by PDepend...', function() {
if(!fs.existsSync('build')) {
fs.mkdirSync('build');
}
if(!fs.existsSync('build/reports')) {
fs.mkdirSync('build/reports');
}
if(!fs.existsSync('build/reports/pdepend')) {
fs.mkdirSync('build/reports/pdepend');
}
});
/**
* Task used to create directories needed by PHP_CodeSniffer to generate its report.
*/
grunt.registerTask('before-phpcs', 'Creating directories required by PHP Code Sniffer...', function() {
if(grunt.option('checkstyle') === true) {
if(!fs.existsSync('build')) {
fs.mkdirSync('build');
}
if(!fs.existsSync('build/reports')) {
fs.mkdirSync('build/reports');
}
if(!fs.existsSync('build/reports/phpcs')) {
fs.mkdirSync('build/reports/phpcs');
}
}
});
/**
* Task used to create directories needed by PHPMD to generate its report.
*/
grunt.registerTask('before-phpmd', 'Creating directories required by PHP Mess Detector...', function() {
if(!fs.existsSync('build')) {
fs.mkdirSync('build');
}
if(!fs.existsSync('build/reports')) {
fs.mkdirSync('build/reports');
}
if(!fs.existsSync('build/reports/phpmd')) {
fs.mkdirSync('build/reports/phpmd');
}
});
/**
* Task used to generate a PDepend report.
*/
grunt.registerTask('pdepend', ['before-pdepend', 'shell:pdepend']);
/**
* Task used to automatically fix PHP_CodeSniffer errors.
*/
grunt.registerTask('phpcbf', ['shell:phpcbf']);
/**
* Task used to check the code using PHP_CodeSniffer.
*/
grunt.registerTask('phpcs', ['before-phpcs', 'shell:phpcs']);
/**
* Task used to generate a PHPMD report.
*/
grunt.registerTask('phpmd', ['before-phpmd', 'shell:phpmd']);
/**
* Task used to create the project documentation.
*/
grunt.registerTask('generate-documentation', ['pdepend', 'phpcs', 'phpmd', 'shell:phpdocumentor']);
/**
* Task used to execute the project tests.
*/
grunt.registerTask('test', ['copy:test-resources', 'shell:phpunit']);
/**
* Default task, this task executes the following actions :
* - Clean the previous build folder
*/
grunt.registerTask('default', ['clean', 'test', 'generate-documentation']);
};