Merge pull request #6694 from orklah/deprecate-phpstorm-generics

deprecate allowPhpStormGenerics
vimeo · Oct 20, 2021 · 541a1ed · 541a1ed
2 parents 23a9896 + acad037
commit 541a1ed
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 1 deletion.
diff --git a/config.xsd b/config.xsd
@@ -44,7 +44,14 @@
         </xs:attribute>
 
         <xs:attribute name="allowFileIncludes" type="xs:boolean" default="true" />
-        <xs:attribute name="allowPhpStormGenerics" type="xs:boolean" default="false" />
+        <xs:attribute name="allowPhpStormGenerics" type="xs:boolean" default="false">
+            <xs:annotation>
+                <!-- note: for PHPStorm to mark the attribute as deprecated the doc entry has to be *single line* and start with the word `deprecated` -->
+                <xs:documentation xml:lang="en">
+                    Deprecated. PHPStorm now supports generics for the most part and @psalm- annotations can be used
+                </xs:documentation>
+            </xs:annotation>
+        </xs:attribute>
         <xs:attribute name="allowStringToStandInForClass" type="xs:boolean" default="false" />
         <xs:attribute name="checkForThrowsDocblock" type="xs:boolean" default="false" />
         <xs:attribute name="checkForThrowsInGlobalScope" type="xs:boolean" default="false" />

diff --git a/docs/running_psalm/configuration.md b/docs/running_psalm/configuration.md
@@ -143,6 +143,8 @@ Setting this to `false` means that any function calls will cause Psalm to forget
 ```
 Allows you to specify whether or not to use the typed iterator docblock format supported by PHP Storm e.g. `ArrayIterator|string[]`, which Psalm transforms to `ArrayIterator<string>`. Defaults to `false`.
 
+This flag is deprecated and will be removed in Psalm 5
+
 #### allowStringToStandInForClass
 
 ```xml