Janis-Rullis-IT / pr1-symfony5-api

Dockerized Symfony 5 API
MIT License
0 stars 0 forks source link

Lint code #58

Closed janis-rullis closed 4 years ago

janis-rullis commented 4 years ago

Try new tools if necessary.

janis-rullis commented 4 years ago

standards

suggester

linters

janis-rullis commented 4 years ago

Symfony

janis-rullis commented 4 years ago

https://en.wikipedia.org/wiki/Smoke_testing_(software)

janis-rullis commented 4 years ago

https://phpunit.de/manual/6.5/en/writing-tests-for-phpunit.html#writing-tests-for-phpunit.data-providers

janis-rullis commented 4 years ago

About CS fixer removing param and return annotations

In https://github.com/Janis-Rullis-IT/pr1-symfony5-api/commit/5b90823b350170ef85d303cf0f55a9c5cebf40aa from all the methods were removed annotations @param and @return. This is not a bug but a best practice. The idea is to remove duplicate content and those annotations are exactly that because the method contains the same information. Also, The CS Fixer is smart enough to leave those annotations when they are not duplicate (there are no type-hints or they have custom info). See https://discourse.laminas.dev/t/php-7-1-and-phpdocs/171/2 for more information.

janis-rullis commented 4 years ago

Shell

janis-rullis commented 4 years ago

Docker

janis-rullis commented 4 years ago

PHP

https://github.com/Janis-Rullis-IT/pr1-symfony5-api/blob/0cbcd08fc39960054223ad9c819d85f027e4415e/symfony5/lint.sh

janis-rullis commented 4 years ago

docker-compose