24 lines
880 B
Markdown
24 lines
880 B
Markdown
# Coding standards
|
|
|
|
farmOS follows [Drupal coding standards](https://www.drupal.org/docs/develop/standards).
|
|
|
|
The farmOS development Docker image comes pre-installed with
|
|
[PHP CodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer) for detecting
|
|
code standard violations, and [PHPStan](https://phpstan.org) for static
|
|
analysis. All farmOS code must pass both.
|
|
|
|
The following command will run PHP CodeSniffer on all farmOS code:
|
|
|
|
docker exec -it -u www-data farmos_www_1 phpcs /opt/drupal/web/profiles/farm
|
|
|
|
If you see no output, then there are no issues.
|
|
|
|
In some cases, code standard violations can be fixed automatically with
|
|
`phpcbf`:
|
|
|
|
docker exec -it -u www-data farmos_www_1 phpcbf /opt/drupal/web/profiles/farm
|
|
|
|
The following command will run PHPStan on all farmOS code:
|
|
|
|
docker exec -it -u www-data farmos_www_1 phpstan analyze /opt/drupal/web/profiles/farm
|