Skip to content

Commit bc685cf

Browse files
committed
Add PHP Mess Detector
1 parent ec4a2c4 commit bc685cf

File tree

4 files changed

+21
-5
lines changed

4 files changed

+21
-5
lines changed

.travis.yml

+3-2
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,12 @@ before_script:
1919
- sleep 2m
2020

2121
script:
22-
- sudo make gen-certs
2322
- sudo make apidoc
24-
- sudo make test
23+
- sudo make gen-certs
2524
- sudo make mysql-dump
2625
- sudo make mysql-restore
26+
- sudo make phpmd
27+
- sudo make test
2728

2829
after_script:
2930
- sudo make docker-stop

Makefile

+7
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ help:
2020
@echo " logs Follow log output"
2121
@echo " mysql-dump Create backup of whole database"
2222
@echo " mysql-restore Restore backup from whole database"
23+
@echo " phpmd Analyse the API with PHP Mess Detector"
2324
@echo " test Test application"
2425

2526
init:
@@ -66,6 +67,12 @@ mysql-dump:
6667
mysql-restore:
6768
@docker exec -i $(shell docker-compose ps -q mysqldb) mysql -u"$(MYSQL_ROOT_USER)" -p"$(MYSQL_ROOT_PASSWORD)" < $(MYSQL_DUMPS_DIR)/db.sql 2>/dev/null
6869

70+
phpmd:
71+
@docker-compose exec -T php \
72+
./app/vendor/bin/phpmd \
73+
./app/src \
74+
text cleancode,codesize,controversial,design,naming,unusedcode
75+
6976
test: code-sniff
7077
@docker-compose exec -T php ./app/vendor/bin/phpunit --colors=always --configuration ./app/
7178
@make resetOwner

README.md

+7
Original file line numberDiff line numberDiff line change
@@ -237,6 +237,7 @@ When developing, you can use [Makefile](https://en.wikipedia.org/wiki/Make_(soft
237237
| logs | Follow log output |
238238
| mysql-dump | Create backup of whole database |
239239
| mysql-restore | Restore backup from whole database |
240+
| phpmd | Analyse the API with PHP Mess Detector |
240241
| test | Test application with phpunit |
241242

242243
### Examples
@@ -287,6 +288,12 @@ sudo docker-compose exec -T php ./app/vendor/bin/phpunit --colors=always --confi
287288
sudo docker-compose exec -T php ./app/vendor/bin/phpcs -v --standard=PSR2 ./app/src
288289
```
289290

291+
### Analyzing source code with [PHP Mess Detector](https://phpmd.org/)
292+
293+
```sh
294+
sudo docker-compose exec -T php ./app/vendor/bin/phpmd ./app/src text cleancode,codesize,controversial,design,naming,unusedcode
295+
```
296+
290297
### Checking installed PHP extensions
291298

292299
```sh

web/app/composer.json.dist

+4-3
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,11 @@
33

44
},
55
"require-dev": {
6-
"squizlabs/php_codesniffer": "3.*",
7-
"phpunit/phpunit": "^7.0",
86
"apigen/apigen": "dev-master",
9-
"roave/better-reflection": "dev-master#c87d856"
7+
"phpmd/phpmd": "@stable",
8+
"phpunit/phpunit": "^7.0",
9+
"roave/better-reflection": "dev-master#c87d856",
10+
"squizlabs/php_codesniffer": "3.*"
1011
},
1112
"autoload": {
1213
"psr-4": {

0 commit comments

Comments
 (0)