Fix crash in code action

.circleci/config.yml

@@ -68,9 +68,10 @@ jobs:
       - run:
           name: Analyse PHPUnit
           command: bin/test-with-real-projects.sh phpunit
-      - run:
-          name: Analyse Psl
-          command: bin/test-with-real-projects.sh psl
+      # PSL requires its own plugin that is not yet compatible with Psalm 5
+      # - run:
+          # name: Analyse Psl
+          # command: bin/test-with-real-projects.sh psl
       - run:
           name: Analyse Collections
           command: bin/test-with-real-projects.sh collections

.github/workflows/ci.yml

@@ -9,7 +9,7 @@ jobs:
       - name: Set up PHP
         uses: shivammathur/setup-php@v2
         with:
-          php-version: '7.1'
+          php-version: '7.4'
           tools: composer:v2
           coverage: none
 

.github/workflows/pr-labels.yml

@@ -10,4 +10,4 @@ jobs:
         with:
           mode: minimum
           count: 1
-          labels: "release:typo, release:fix, release:feature, release:deprecation, release:internal, release:docs"
+          labels: "release:typo, release:fix, release:feature, release:deprecation, release:internal, release:docs, release:removed"

UPGRADING.md

@@ -0,0 +1,164 @@
+# Upgrading from Psalm 4 to Psalm 5
+## Changed
+ - [BC] The parameter `$php_version` of `Psalm\Type\Atomic::create()` renamed
+   to `$analysis_php_version_id` and changed from `array|null` to `int|null`.
+   Previously it accepted PHP version as `array{major_version, minor_version}`
+   while now it accepts version ID, similar to how [`PHP_VERSION_ID` is
+   calculated](https://www.php.net/manual/en/reserved.constants.php#constant.php-version-id).
+
+ - [BC] The parameter `$php_version` of `Psalm\Type::parseString()` renamed to
+   `$analysis_php_version_id` and changed from `array|null` to `int|null`.
+   Previously it accepted PHP version as `array{major_version, minor_version}`
+   while now it accepts version ID.
+
+ - [BC] Parameter 0 of `canBeFullyExpressedInPhp()` of the classes listed below
+   changed name from `php_major_version` to `analysis_php_version_id`.
+   Previously it accepted major PHP version as int (e.g. `7`), while now it
+   accepts version ID. Classes affected:
+    - `Psalm\Type\Atomic`
+    - `Psalm\Type\Atomic\Scalar`
+    - `Psalm\Type\Atomic\TArray`
+    - `Psalm\Type\Atomic\TArrayKey`
+    - `Psalm\Type\Atomic\TAssertionFalsy`
+    - `Psalm\Type\Atomic\TCallable`
+    - `Psalm\Type\Atomic\TCallableObject`
+    - `Psalm\Type\Atomic\TCallableString`
+    - `Psalm\Type\Atomic\TClassConstant`
+    - `Psalm\Type\Atomic\TClassString`
+    - `Psalm\Type\Atomic\TClassStringMap`
+    - `Psalm\Type\Atomic\TClosedResource`
+    - `Psalm\Type\Atomic\TClosure`
+    - `Psalm\Type\Atomic\TConditional`
+    - `Psalm\Type\Atomic\TDependentGetClass`
+    - `Psalm\Type\Atomic\TDependentGetDebugType`
+    - `Psalm\Type\Atomic\TDependentGetType`
+    - `Psalm\Type\Atomic\TDependentListKey`
+    - `Psalm\Type\Atomic\TEnumCase`
+    - `Psalm\Type\Atomic\TFalse`
+    - `Psalm\Type\Atomic\TGenericObject`
+    - `Psalm\Type\Atomic\TIntMask`
+    - `Psalm\Type\Atomic\TIntMaskOf`
+    - `Psalm\Type\Atomic\TIntRange`
+    - `Psalm\Type\Atomic\TIterable`
+    - `Psalm\Type\Atomic\TKeyedArray`
+    - `Psalm\Type\Atomic\TKeyOfClassConstant`
+    - `Psalm\Type\Atomic\TList`
+    - `Psalm\Type\Atomic\TLiteralClassString`
+    - `Psalm\Type\Atomic\TLowercaseString`
+    - `Psalm\Type\Atomic\TMixed`
+    - `Psalm\Type\Atomic\TNamedObject`
+    - `Psalm\Type\Atomic\TNever`
+    - `Psalm\Type\Atomic\TNonEmptyLowercaseString`
+    - `Psalm\Type\Atomic\TNonspecificLiteralInt`
+    - `Psalm\Type\Atomic\TNonspecificLiteralString`
+    - `Psalm\Type\Atomic\TNull`
+    - `Psalm\Type\Atomic\TNumeric`
+    - `Psalm\Type\Atomic\TNumericString`
+    - `Psalm\Type\Atomic\TObject`
+    - `Psalm\Type\Atomic\TObjectWithProperties`
+    - `Psalm\Type\Atomic\TPositiveInt`
+    - `Psalm\Type\Atomic\TResource`
+    - `Psalm\Type\Atomic\TScalar`
+    - `Psalm\Type\Atomic\TTemplateIndexedAccess`
+    - `Psalm\Type\Atomic\TTemplateParam`
+    - `Psalm\Type\Atomic\TTraitString`
+    - `Psalm\Type\Atomic\TTrue`
+    - `Psalm\Type\Atomic\TTypeAlias`
+    - `Psalm\Type\Atomic\TValueOfClassConstant`
+    - `Psalm\Type\Atomic\TVoid`
+    - `Psalm\Type\Union`
+
+ - [BC] Parameter 3 of `toPhpString()` of methods listed below changed name
+   from `php_major_version` to `analysis_php_version_id`. Previously it
+   accepted major PHP version as int (e.g. `7`), while now it accepts version
+   ID. Classes affected:
+    - `Psalm\Type\Atomic`
+    - `Psalm\Type\Atomic\CallableTrait`
+    - `Psalm\Type\Atomic\TAnonymousClassInstance`
+    - `Psalm\Type\Atomic\TArray`
+    - `Psalm\Type\Atomic\TArrayKey`
+    - `Psalm\Type\Atomic\TAssertionFalsy`
+    - `Psalm\Type\Atomic\TBool`
+    - `Psalm\Type\Atomic\TCallable`
+    - `Psalm\Type\Atomic\TCallableObject`
+    - `Psalm\Type\Atomic\TClassConstant`
+    - `Psalm\Type\Atomic\TClassString`
+    - `Psalm\Type\Atomic\TClassStringMap`
+    - `Psalm\Type\Atomic\TClosedResource`
+    - `Psalm\Type\Atomic\TConditional`
+    - `Psalm\Type\Atomic\TEmpty`
+    - `Psalm\Type\Atomic\TEnumCase`
+    - `Psalm\Type\Atomic\TFloat`
+    - `Psalm\Type\Atomic\TGenericObject`
+    - `Psalm\Type\Atomic\TInt`
+    - `Psalm\Type\Atomic\TIterable`
+    - `Psalm\Type\Atomic\TKeyedArray`
+    - `Psalm\Type\Atomic\TKeyOfClassConstant`
+    - `Psalm\Type\Atomic\TList`
+    - `Psalm\Type\Atomic\TLiteralClassString`
+    - `Psalm\Type\Atomic\TMixed`
+    - `Psalm\Type\Atomic\TNamedObject`
+    - `Psalm\Type\Atomic\TNever`
+    - `Psalm\Type\Atomic\TNull`
+    - `Psalm\Type\Atomic\TNumeric`
+    - `Psalm\Type\Atomic\TObject`
+    - `Psalm\Type\Atomic\TObjectWithProperties`
+    - `Psalm\Type\Atomic\TResource`
+    - `Psalm\Type\Atomic\TScalar`
+    - `Psalm\Type\Atomic\TString`
+    - `Psalm\Type\Atomic\TTemplateIndexedAccess`
+    - `Psalm\Type\Atomic\TTemplateParam`
+    - `Psalm\Type\Atomic\TTraitString`
+    - `Psalm\Type\Atomic\TTypeAlias`
+    - `Psalm\Type\Atomic\TValueOfClassConstant`
+    - `Psalm\Type\Atomic\TVoid`
+    - `Psalm\Type\Union`
+ - While not a BC break per se, all classes / interfaces / traits / enums under
+   `Psalm\Internal` namespace are now marked `@internal`.
+ - [BC] Parameter 1 of `Psalm\Type\Atomic\TNamedObject::__construct()` changed name from `was_static` to `is_static`
+ - [BC] Parameter 1 of `Psalm\Type\Atomic\TAnonymousClassInstance::__construct()` changed name from `was_static` to `is_static`
+ - [BC] Parameter 5 of `Psalm\Type::getStringFromFQCLN()` changed name from `was_static` to `is_static`
+ - [BC] Property `Psalm\Type\Atomic\TNamedObject::$was_static` was renamed to `$is_static`
+ - [BC] Method `Psalm\Type\Union::isFormerStaticObject()` was renamed to `isStaticObject()`
+ - [BC] Method `Psalm\Type\Union::hasFormerStaticObject()` was renamed to `hasStaticObject()`
+
+## Removed
+ - [BC] Property `Psalm\Codebase::$php_major_version` was removed, use
+   `Psalm\Codebase::$analysis_php_version_id`.
+ - [BC] Property `Psalm\Codebase::$php_minor_version` was removed, use
+   `Psalm\Codebase::$analysis_php_version_id`.
+ - [BC] Class `Psalm\Type\Atomic\TEmpty` was removed
+ - [BC] Method `Psalm\Type\Union::isEmpty()` was removed
+ - [BC] Property `Psalm\Config::$allow_phpstorm_generics` was removed
+ - [BC] Property `Psalm\Config::$exit_functions` was removed
+ - [BC] Method `Psalm\Type::getEmpty()` was removed
+ - [BC] Legacy hook interfaces have been removed:
+   -  `Psalm\Plugin\Hook\MethodReturnTypeProviderInterface`
+   -  `Psalm\Plugin\Hook\BeforeFileAnalysisInterface`
+   -  `Psalm\Plugin\Hook\AfterFileAnalysisInterface`
+   -  `Psalm\Plugin\Hook\AfterMethodCallAnalysisInterface`
+   -  `Psalm\Plugin\Hook\AfterClassLikeVisitInterface`
+   -  `Psalm\Plugin\Hook\StringInterpreterInterface`
+   -  `Psalm\Plugin\Hook\AfterExpressionAnalysisInterface`
+   -  `Psalm\Plugin\Hook\AfterEveryFunctionCallAnalysisInterface`
+   -  `Psalm\Plugin\Hook\PropertyExistenceProviderInterface`
+   -  `Psalm\Plugin\Hook\AfterFunctionLikeAnalysisInterface`
+   -  `Psalm\Plugin\Hook\FunctionParamsProviderInterface`
+   -  `Psalm\Plugin\Hook\FunctionReturnTypeProviderInterface`
+   -  `Psalm\Plugin\Hook\FunctionExistenceProviderInterface`
+   -  `Psalm\Plugin\Hook\AfterAnalysisInterface`
+   -  `Psalm\Plugin\Hook\MethodVisibilityProviderInterface`
+   -  `Psalm\Plugin\Hook\MethodParamsProviderInterface`
+   -  `Psalm\Plugin\Hook\AfterClassLikeExistenceCheckInterface`
+   -  `Psalm\Plugin\Hook\PropertyTypeProviderInterface`
+   -  `Psalm\Plugin\Hook\AfterFunctionCallAnalysisInterface`
+   -  `Psalm\Plugin\Hook\MethodExistenceProviderInterface`
+   -  `Psalm\Plugin\Hook\AfterCodebasePopulatedInterface`
+   -  `Psalm\Plugin\Hook\AfterClassLikeAnalysisInterface`
+   -  `Psalm\Plugin\Hook\PropertyVisibilityProviderInterface`
+   -  `Psalm\Plugin\Hook\AfterStatementAnalysisInterface`
+ - [BC] Method `Psalm\Issue\CodeIssue::getLocation()` was removed
+ - [BC] Method `Psalm\Issue\CodeIssue::getFileName()` was removed
+ - [BC] Method `Psalm\Issue\CodeIssue::getMessage()` was removed
+ - [BC] Method `Psalm\DocComment::parse()` was removed
+ - [BC] Class `Psalm\Type\Atomic\THtmlEscapedString` has been removed

composer.json

@@ -14,7 +14,7 @@
         }
     ],
     "require": {
-        "php": "^7.1|^8",
+        "php": "^7.4 || ~8.0.0 || ~8.1.0",
         "ext-SimpleXML": "*",
         "ext-ctype": "*",
         "ext-dom": "*",
@@ -28,30 +28,30 @@
         "composer/semver": "^1.4 || ^2.0 || ^3.0",
         "composer/xdebug-handler": "^1.1 || ^2.0 || ^3.0",
         "dnoegel/php-xdg-base-dir": "^0.1.1",
-        "felixfbecker/advanced-json-rpc": "^3.0.3",
+        "felixfbecker/advanced-json-rpc": "^3.1",
         "felixfbecker/language-server-protocol": "^1.5",
         "netresearch/jsonmapper": "^1.0 || ^2.0 || ^3.0 || ^4.0",
         "nikic/php-parser": "^4.13",
         "openlss/lib-array2xml": "^1.0",
-        "sebastian/diff": "^3.0 || ^4.0",
+        "sebastian/diff": "^4.0",
         "symfony/console": "^3.4.17 || ^4.1.6 || ^5.0 || ^6.0",
-        "webmozart/path-util": "^2.3"
+        "symfony/filesystem": "^5.4 || ^6.0"
     },
     "provide": {
         "psalm/psalm": "self.version"
     },
     "require-dev": {
         "ext-curl": "*",
-        "bamarni/composer-bin-plugin": "^1.2",
+        "bamarni/composer-bin-plugin": "^1.4",
         "brianium/paratest": "^4.0||^6.0",
         "php-parallel-lint/php-parallel-lint": "^1.2",
         "phpdocumentor/reflection-docblock": "^5",
         "phpmyadmin/sql-parser": "5.1.0||dev-master",
-        "phpspec/prophecy": ">=1.9.0",
+        "phpspec/prophecy": ">=1.10.2",
         "phpunit/phpunit": "^9.0",
         "psalm/plugin-phpunit": "^0.16",
         "slevomat/coding-standard": "^7.0",
-        "squizlabs/php_codesniffer": "^3.5",
+        "squizlabs/php_codesniffer": "^3.6",
         "symfony/process": "^4.3 || ^5.0 || ^6.0",
         "weirdan/prophecy-shim": "^1.0 || ^2.0"
     },
@@ -80,11 +80,7 @@
     "autoload": {
         "psr-4": {
             "Psalm\\": "src/Psalm/"
-        },
-        "files": [
-            "src/functions.php",
-            "src/spl_object_id.php"
-        ]
+        }
     },
     "autoload-dev": {
         "psr-4": {

config.xsd

@@ -16,14 +16,6 @@
             <xs:element name="mockClasses" type="MockClassesType" minOccurs="0" maxOccurs="1" />
             <xs:element name="stubs" type="StubsType" minOccurs="0" maxOccurs="1" />
             <xs:element name="plugins" type="PluginsType" minOccurs="0" maxOccurs="1" />
-            <xs:element name="exitFunctions" type="ExitFunctionsType" minOccurs="0" maxOccurs="1">
-                <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. Replaced by documenting never as a return type. It is going to be removed in Psalm 5.
-                    </xs:documentation>
-                </xs:annotation>
-            </xs:element>
             <xs:element name="forbiddenFunctions" type="ExitFunctionsType" minOccurs="0" maxOccurs="1" />
             <xs:element name="issueHandlers" type="IssueHandlersType" minOccurs="0" maxOccurs="1" />
             <xs:element name="ignoreExceptions" type="ExceptionsType" minOccurs="0" maxOccurs="1" />
@@ -40,25 +32,7 @@
         <xs:attribute name="serializer" type="xs:string" />
 
         <xs:attribute name="addParamDefaultToDocblockType" type="xs:boolean" default="false" />
-
-        <xs:attribute name="allowCoercionFromStringToClassConst" 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. Has no effect since Psalm 3 and is going to be removed in Psalm 5.
-                </xs:documentation>
-            </xs:annotation>
-        </xs:attribute>
-
         <xs:attribute name="allowFileIncludes" type="xs:boolean" default="true" />
-        <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" />
@@ -144,6 +118,7 @@
     <xs:complexType name="ProjectDirectoryAttributeType">
         <xs:attribute name="name" type="xs:string" use="required" />
         <xs:attribute name="ignoreTypeStats" type="xs:string" />
+        <xs:attribute name="resolveSymlinks" type="xs:boolean" />
         <xs:attribute name="useStrictTypes" type="xs:string" />
         <xs:anyAttribute processContents="skip"/>
     </xs:complexType>

docs/annotating_code/type_syntax/atomic_types.md

@@ -52,19 +52,20 @@ Atomic types are the basic building block of all type information used in Psalm.
 - `value-of<Foo\Bar::ARRAY_CONST>`
 - `T[K]`
 
-## Top types, bottom types and empty
+## Top types, bottom types
 
 ### `mixed`
 
 This is the _top type_ in PHP's type system, and represents a lack of type information. Psalm warns about `mixed` types when the `totallyTyped` flag is turned on, or when you're on level 1.
 
 ### `never`
+It can be aliased to `no-return` or `never-return` in docblocks. Note: it replaced the old `empty` type that used to exist in Psalm
 
-This is the _bottom type_ in PHP's type system, and usually represents a return type for a function that can never actually return, such as `die()`, `exit()`, or a function that always throws an exception. It may also be written in docblocks as `no-return` or `never-return`.
-
-### `empty`
-
-A type that's equivalent to a "coming soon" sign. Psalm uses this type when it’s awaiting more information — a good example is the type of the empty array `[]`, which Psalm types as `array<empty, empty>`. Psalm treats `empty` in a somewhat similar fashion to `never` when combining types together — `empty|int` becomes `int`, just as `never|string` becomes `string`.
+This is the _bottom type_ in PHP's type system. It's used to describe a type that has no possible value. It can happen in multiple cases:
+- the actual `never` type from PHP 8.1 (can be used in docblocks for older versions). This type can be used as a return type for functions that will never return, either because they always throw exceptions or always exit()
+- an union type that have been stripped for all its possible types. (For example, if a variable is `string|int` and we perform a is_bool() check in a condition, the type of the variable in the condition will be `never` as the condition will never be entered)
+- it can represent a placeholder for types yet to come — a good example is the type of the empty array `[]`, which Psalm types as `array<never, never>`, the content of the array is void so it can accept any content
+- it can also happen in the same context as the line above for templates that have yet to be defined
 
 ## Other
 

docs/annotating_code/type_syntax/scalar_types.md

@@ -73,9 +73,3 @@ Strings that don't pass this type check:
 A non empty string, lowercased or both at once.
 
 `empty` here is defined as all strings except the empty string `''`. Another type `non-falsy-string` is effectively a subtype of `non-empty-string`, and also precludes the string value `'0'`.
-
-### html-escaped-string (deprecated)
-
-A string which can safely be used in a html context.
-
-_This type will be removed in Psalm 5.x._

docs/running_psalm/configuration.md

@@ -134,17 +134,6 @@ If true we force strict typing on numerical and string operations (see https://g
 ```
 Setting this to `false` means that any function calls will cause Psalm to forget anything it knew about object properties within the scope of the function it's currently analysing. This duplicates functionality that Hack has. Defaults to `true`.
 
-#### allowPhpStormGenerics
-
-```xml
-<psalm
-  allowPhpStormGenerics="[bool]"
->
-```
-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

docs/running_psalm/issues/InvalidScalarArgument.md

@@ -1,6 +1,10 @@
 # InvalidScalarArgument
 
-Emitted when a scalar value is passed to a method that expected another scalar type
+Emitted when a scalar value is passed to a method that expected another scalar type.
+
+This is only emitted in situations where Psalm can be sure that PHP tries to coerce one scalar type to another.
+
+In all other cases `InvalidArgument` is emitted.
 
 ```php
 <?php

docs/running_psalm/plugins/plugins_type_system.md

@@ -27,16 +27,14 @@ The classes are as follows:
 
 `TNull` - denotes the `null` type
 
-`TNever` - denotes the `no-return`/`never-return` type for functions that never return, either throwing an exception or terminating (like the builtin `exit()`).
+`TNever` - denotes the `no-return`/`never-return` type for functions that never return, either throwing an exception or terminating (like the builtin `exit()`). Also used for union types that can have no possible types (impossible intersections for example).  Empty arrays `[]` have the type `array<never, never>`.
 
 `TMixed` - denotes the `mixed` type, used when you don’t know the type of an expression.
 
 `TNonEmptyMixed `- as above, but not empty. Generated for `$x` inside the `if` statement `if ($x) {...}` when `$x` is `mixed` outside.
 
 `TEmptyMixed` - as above, but empty. Generated for `$x` inside the `if` statement `if (!$x) {...}` when `$x` is `mixed` outside.
 
-`TEmpty` - denotes the `empty` type, used to describe a type corresponding to no value whatsoever. Empty arrays `[]` have the type `array<empty, empty>`.
-
 `TIterable` - denotes the [`iterable` type](https://www.php.net/manual/en/language.types.iterable.php) (which can also result from an `is_iterable` check).
 
 `TResource` - denotes the `resource` type (e.g. a file handle).
@@ -141,7 +139,7 @@ if (true === $first) {
 
 `TCallableString` - denotes the `callable-string` type, used to represent an unknown string that is also `callable`.
 
-`THtmlEscapedString`, `TSqlSelectString` - these are special types, specifically for consumption by plugins.
+`TSqlSelectString` - this is a special type, specifically for consumption by plugins.
 
 `TLowercaseString` - denotes a string where every character is lowercased. (which can also result from a `strtolower` call).