Process Improvement - PHP Static Analysis

[cpalv]

Important notices

Before you add a new report, we ask you kindly to acknowledge the following:

• [yes] I have read the contributing guide lines at https://github.com/opnsense/core/blob/master/CONTRIBUTING.md
• [yes] I am convinced that my issue is new after having checked both open and closed issues at https://github.com/opnsense/core/issues?q=is%3Aissue

Is your feature request related to a problem? Please describe.

A clear and concise description of what the problem is including your motivation for the request,
i.e. "For the purpose of [...] I am missing a solution that will [...]."

Not really a problem, mostly just a process improvement. I'd like to suggest adding a static analysis build option to ensure code quality.

Describe the solution you like

A clear and concise description of what you want to happen.
(e.g. I would like an input field in the /ui/firewall/alias which would add .... to ....)

Include phpstan or another PHP static analyzer.

Describe alternatives you considered

A clear and concise description of any alternative solutions or features you considered.

none

Additional context

Add any other context or screenshots about the feature request here or links to relevant forum thread or similar

[cpalv]

I've done some preliminary research on this and at a minimum PHP Composer would need to be added to the OPNsense repositories.

After going through some of the initial steps on a plain FreeBSD install I ran into the following error

# vendor/bin/phpstan anaylse src/opnsense/mvc/app/controllers/OPNsense/
Fatal error: Uncaught Error: Class "PhpToken" not found in phar:///usr/opnsense/core/vendor/phpstan/phpstan/phpstan.phar/vendor/nikic/php-parser/lib/PhpParser/Internal/TokenPolyfill.php:7
Stack trace:
#0 phar:///usr/opnsense/core/vendor/phpstan/phpstan/phpstan.phar/preload.php(1329): require_once()
#1 phar:///usr/opnsense/core/vendor/phpstan/phpstan/phpstan.phar/bin/phpstan(20): require_once('phar:///usr/opn...')
#2 phar:///usr/opnsense/core/vendor/phpstan/phpstan/phpstan.phar/bin/phpstan(115): _PHPStan_c684505c9\{closure}()
#3 /usr/opnsense/core/vendor/phpstan/phpstan/phpstan(8): require('phar:///usr/opn...')
#4 /usr/opnsense/core/vendor/bin/phpstan(119): include('/usr/opnsense/c...')
#5 {main}
  thrown in phar:///usr/opnsense/core/vendor/phpstan/phpstan/phpstan.phar/vendor/nikic/php-parser/lib/PhpParser/Internal/TokenPolyfill.php on line 7

But from what I can tell TokenPolyfill.php is included in phpstan.phar

# grep -rni 'TokenPolyfill.php' **
Binary file vendor/phpstan/phpstan/phpstan.phar matches

After resolving this, sifting through the results from phpstan would take some effort