Giters

thecodingmachine / phpstan-strict-rules

A set of additional rules for PHPStan based on best practices followed at TheCodingMachine

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Prepare for PHPStan 1.0

ondrejmirtes opened this issue · comments

commented

Hello everyone 👋

I announced today that PHPStan 1.0 is going to be released on November 1st 2021.

I'm approaching you as one of the most popular PHPStan extensions. I'd love if you could prepare your code for PHPStan 1.0 in advance so that it's ready to release on the same day.

Here's a brief guide how to approach the upgrade:

  1. Create a branch 🌴
  2. Update your composer.json to "phpstan/phpstan": "^1.0", add "minimum-stability": "dev" and "prefer-stable": true if necessary.
  3. Update your code with the BC breaks below in mind. 🔧
  4. Fix the code so that it passes PHPStan's analysis 🤓
  5. Wait for PHPStan 1.0 release on November 1st, merge your branch and tag the next major version 👍

Thank you!

Here are the BC breaks. The list is huge but most of those have very little impact.

There are new rules around using PHPStan internals in regard to backward compatibility promise: https://phpstan.org/developing-extensions/backward-compatibility-promise

It's possible that not everything you use is covered by it - so I'm here to help you to transition to correct usage, or add some @api annotations in PHPStan itself so that more is covered by the promise. Let me know!

BC breaks for end-users

The following are interesting only if you create a custom ruleset in your configuration file:

BC breaks for extension developers