If you've tried to introduce advanced static analysis tools (e.g. Psalm, PHPStan) to legacy projects the tools have probably reported thousands of problems. It's unrealistic to fix all but the most critical ones before continuing development.
SARB is used to create a baseline of these results. As work on the project progresses SARB takes the latest static analysis results, removes those issues in the baseline and report the issues raised since the baseline. SARB does this, in conjunction with git, by tracking lines of code between commits. Currently, SARB only supports git, but it is possible to add support for other SCMs.
SARB is written in PHP, however it can be used to baseline results for any language and any static analysis tool.
SARB should not be used on greenfield projects. If you're lucky enough to work on a greenfield project make sure you fix all problems raised by static analysis as you go along.
Currently, SARB only supports projects that use git.
SARB requires PHP >= 8.0 to run. The project being analysed does not need to run PHP 8.0 or even be a PHP project at all.
You can either add directly to the project you wish to run analysis on:
composer require --dev dave-liddament/sarb
Or you can install SARB globally (e.g. if you want to use it on a non PHP project):
composer global require dave-liddament/sarb
If you install globally make sure the composer bin directory is in your path.
If you're using version 0.x see the old documentation and how to upgrade.
When creating the baseline, SARB needs to know the git commit SHA of the baseline. Make sure your code is in the state you want it to be in for the baseline and that the current commit represents that state.
Run the static analyser of choice and pipe the results into SARB:
E.g. using Psalm's JSON output:
vendor/bin/psalm --output-format=json | vendor/bin/sarb create --input-format="psalm-json" psalm.baselineThis creates a baseline file called psalm.baseline. You'll want to check this in to your repository.
Continue coding. Then rerun static analyser and pipe results into SARB:
vendor/bin/psalm --output-format=json | vendor/bin/sarb remove psalm.baselineIf you are running SARB from a global installation you will need to specify the root of the project (where the .git directory lives).
The above would become:
psalm --output-format=json | sarb create --project-root=/path/to/project/root --input-format="psalm-json" psalm.baselineTo see a list of supported tools and formats use:
vendor/bin/sarb list-static-analysis-tools
How to create and remove baseline for each supported tool:
vendor/bin/phpcs src --report=json | vendor/bin/sarb create --input-format="phpcodesniffer-json" phpcs.baseline
vendor/bin/phpcs src --report=json | vendor/bin/sarb remove phpcs.baselinevendor/bin/phan -m json | vendor/bin/sarb create --input-format="phan-json" phan.baseline
vendor/bin/phan -m json | vendor/bin/sarb remove phan.baselineSee notes on relative paths.
php exakat.phar report -p <project> -format sarb | vendor/bin/sarb create --input-format="exakat-sarb" exakat.baseline
php exakat.phar report -p <project> -format sarb | vendor/bin/sarb remove exakat.baselinevendor/bin/phpmd src json <ruleset> | vendor/bin/sarb create --input-format="phpmd-json" phpmd.baseline
vendor/bin/phpmd src json <ruleset> | vendor/bin/sarb remove phpmd.baselinevendor/bin/psalm --output-format=json | vendor/bin/sarb create --input-format="psalm-json" psalm.baseline
vendor/bin/psalm --output-format=json | vendor/bin/sarb remove psalm.baselineNOTE: Checkout Psalm's built in baseline feature. Learn how it differs from SARB.
vendor/bin/phpstan analyse --error-format=json | vendor/bin/sarb create --input-format="phpstan-json" phpstan.baseline
vendor/bin/phpstan analyse --error-format=json | vendor/bin/sarb remove phpstan.baselineNOTE: Checkout PHPStan's built in baseline feature. Learn how it differs from SARB.
vendor/bin/phpmnd . | vendor/bin/sarb create --input-format="phpmnd" phpmnd.baseline
vendor/bin/phpmnd . | vendor/bin/sarb remove phpmnd.baselineSee notes on relative paths.
That's no problem there are 3 methods to integrate a static analysis tool with SARB.
The format for showing issues after the baseline is removed can be specified using --output-format option.
Possible values are: table, text, json or github (for Github actions).
Some static analysis tools (e.g. PHP Code Sniffer) classify issues wth a severity or either error or warning.
By default, SARB will report all of these. If you wish to ignore warnings you can use the --ignore-warnings option.
E.g.
vendor/bin/phpcs src --report=json | vendor/bin/sarb remove phpcs.baseline --ignore-warningsIf you're using actions/checkout@v2 to check out your code you'll need to add set fetch-depth to 0.
By default checkout only gets that latest state of the code and none of the history.
SARB uses git, which needs the full git history, to track file changes since the baseline.
To get the full history checked out use this:
- uses: actions/checkout@v2
with:
fetch-depth: 0
Also don't forget to use the SARB option --output-format=github.
It will annotate your PR with any issues that have been added since the baseline.
In an ideal world SARB should not be required. SARB prevents you from adding new issues to your codebase.
It also provides a --clean-up option when running remove.
Running SARB with this option will pick out 5 random issues that are still in the baseline.
Challenge your team to fix 5 issues in the baseline every day.
Over a working year that'll be 1000 issues gone from the baseline!
Soon you'll be able to ditch SARB for good!