Add UPGRADING-v6.md

fp4php · May 22, 2023 · b0f74d2 · b0f74d2
1 parent 28d4b0f
commit b0f74d2
Showing 1 changed file with 32 additions and 0 deletions.
diff --git a/UPGRADING-v6.md b/UPGRADING-v6.md
@@ -0,0 +1,32 @@
+## Update psalm to v5
+
+Since fp4php/functional v6 Psalm integration ships as separate package.
+Including the Psalm integration in the main fp4php/functional repository was a mistake.
+
+For migration:
+
+1. Remove old toolkit:
+
+```shell
+composer remove fp4php/psalm-toolkit
+```
+
+2. Install new psalm plugin:
+
+```shell
+composer require --dev fp4php/functional-psalm-plugin
+```
+
+3. Update psalm.xml:
+
+```diff
+<?xml version="1.0"?>
+<psalm ...>
+    ...
+    <plugins>
+-        <pluginClass class="Fp\Psalm\FunctionalPlugin"/>
+-        <pluginClass class="Fp\PsalmToolkit\Toolkit\Plugin"/>
++        <pluginClass class="Fp\PsalmPlugin\FunctionalPlugin"/>
+    </plugins>
+</psalm>
+```