Backward Compatibility Promise

There are multiple aspects to backward compatibility in case of PHPStan. This article talks about what users can expect when upgrading minor versions and how PHPStan honors semantic versioning.

In context of PHPStan, upgrading a minor version means increasing y in 0.x.y before 1.0, and increasing y in x.y.z after 1.0 release. Upgrading a patch version means increasing z.

CLI arguments and options #

Their meaning does not change in minor/patch versions. No options are removed. New options can be added.

Configuration options #

The meaning of existing configuration options and the file format does not change in minor/patch versions. No options are removed. New options can be added.

Checks performed on analysed code #

The library of performed rules on analysed code, and the meaning of rule levels does not change in minor/patch versions. This means that PHPStan will not look for new categories of errors in a minor/patch version. New rules are added only in major versions, and also as part of bleeding edge which is an opt-in preview of the next major version.

Type inference capabilities #

As bugs get fixed, PHPStan gets smarter, and figures out more precise information about existing code. This can lead to unavoidable changes in understanding analysed code, and to old errors stopped being reported, or new errors started being reported.

The nature of static analyser is that the output can change even in minor/patch version, because any single change leads to code being understood a bit differently, and therefore breaking someone’s build.

Minimizing impact of type inference changes #

When PHPStan stops reporting a false-positive, it reports an ignored error no longer being present. So half of the reasons why PHPStan can fail after minor/patch version upgrade can be prevented by setting reportUnmatchedIgnoredErrors to false.

Users usually welcome when PHPStan gets smarter so using the caret version range (like "phpstan/phpstan": "^1.10.60") in composer.json is encouraged. In combination with committed composer.lock your build will be stable anyway, but you’ll get new PHPStan versions when you run composer update.

If you value build stability over everything else, and you don’t have a committed composer.lock file [1], lock PHPStan version to a specific patch version: "phpstan/phpstan": "1.10.60" and use Dependabot or a similar solution to get notified about new releases and perform automatic upgrades.

  1. Which is typical for open-source projects that need to stay compatible with a range of dependencies versions. ↩︎

Edit this page on GitHub

© 2016–2024 Ondřej Mirtes