Adding Static Code Analysis using phpstan

[pamtbaau]

Analysing code using a static code analyser like phpstan of psalm reduces the changes on bugs.

Here is a step-by-step manual to add phpstan.

In the root of the website used for developing pushy, do the following:

• Run $ composer update
  This will install the development dependencies used by Grav
• Run code analysis
  $ vendor/bin/phpstan analyse -l 6 ./user/plugins/pushy/pushy.php ./user/plugins/pushy/classes
  Arg -l denotes the strictness of the analysis. The higher the more strict. Level 6 might be a bit overwhelming on first use.

See the docs of phpstan for more information.

[hughbris]

Nice. I installed and ran this and will run again after applying your latest changes, making any fixes suggested. I'll look into integrating this with a pre-commit hook, too. Thank for this!

Not sure when you consider this closeable, I'll let you decide :)

[pamtbaau]

Forgot to add one thing... You'll need to add config file phpstan.neon to the root of the site and add the following content:

parameters:
    scanDirectories:
      - user/plugins/pushy/vendor/czproject/git-php/src

This will tell phpstan where the git library can be found. That will reduce the number of errors listed by phpstan on calls to library methods...