Is Rector 1.0 compatible with the current documentation?

[LevFlavien]

Hello,

I have a project with Rector "0.15.25". It has become an issue because the documentation is not versioned. Rector API changes being hard to follow has already been mentioned here.

The latest version I can upgrade Rector to is 1.0 because we have PHPStan 1.0, and Rector requires 2.0.

So I'd like to know if I can use Rector 1.0 and rely on the current documentation of the rules? If so, for how long?

Thanks

[samsonasik]

For 0.15.25, you can read documentation under docs on your vendor/rector/rector

https://github.com/rectorphp/rector/tree/0.15.25/docs

[LevFlavien]

Thanks for the answer

I failed to mention our project is PHP 8.2 (it'll be upgraded soon or later). Rector 0.XX supports PHP up to 8.1 and 1.XX up to 8.2 which would have been ideal right now.

I take it that there's no doc for Rector 1.XX other than the source code itself then?

I'd like to trust this tool but there's no backward compatibility promise. If we eventually upgrade to Rector 2.XX, is there any safety that we won't have the same issue in the future?

[samsonasik]

I think you can take a look via web archive for that 2 years back https://web.archive.org/web/20231206121404/https://getrector.com/documentation