21 KiB
Configuration
Psalm uses an XML config file (by default, psalm.xml). A barebones example looks like this:
<?xml version="1.0"?>
<psalm>
<projectFiles>
<directory name="src" />
</projectFiles>
</psalm>
Configuration file may be split into several files using XInclude tags (c.f. previous example):
psalm.xml
<?xml version="1.0"?>
<psalm
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="https://getpsalm.org/schema/config"
xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd"
xmlns:xi="http://www.w3.org/2001/XInclude"
>
<xi:include href="files.xml"/>
</psalm>
files.xml
<?xml version="1.0" encoding="UTF-8"?>
<projectFiles xmlns="https://getpsalm.org/schema/config">
<file name="Bar.php" />
<file name="Bat.php" />
</projectFiles>
Optional <psalm /> attributes
Coding style
errorLevel
<psalm
errorLevel="[int]"
/>
This corresponds to Psalm‘s error-detection level.
reportMixedIssues
<psalm
reportMixedIssues="[bool]"
/>
Setting this to "false" hides all issues with Mixed types in Psalm’s output. If not given, this defaults to "false" when errorLevel is 3 or higher, and "true" when the error level is 1 or 2.
totallyTyped
Deprecated This setting has been replaced by reportMixedIssues which is automatically enabled when errorLevel is 1.
resolveFromConfigFile
<psalm
resolveFromConfigFile="[bool]"
/>
If this is enabled, relative directories mentioned in the config file will be resolved relative to the location of the config file. If it is disabled, or absent they will be resolved relative to the working directory of the Psalm process.
New versions of Psalm enable this option when generating config files. Older versions did not include it.
useDocblockTypes
<psalm
useDocblockTypes="[bool]"
>
Whether or not to use types as defined in docblocks. Defaults to true.
useDocblockPropertyTypes
<psalm
useDocblockPropertyTypes="[bool]"
>
If not using all docblock types, you can still use docblock property types. Defaults to false (though only relevant if useDocblockTypes is false).
docblockPropertyTypesSealProperties
<psalm
docblockPropertyTypesSealProperties="[bool]"
>
Whether using @property in class docblocks should imply @psalm-seal-properties. Defaults to true.
usePhpDocMethodsWithoutMagicCall
<psalm
usePhpDocMethodsWithoutMagicCall="[bool]"
>
The PHPDoc @method annotation normally only applies to classes with a __call method. Setting this to true allows you to use the @method annotation to override inherited method return types. Defaults to false.
usePhpDocPropertiesWithoutMagicCall
<psalm
usePhpDocPropertiesWithoutMagicCall="[bool]"
>
The PHPDoc @property, @property-read and @property-write annotations normally only apply to classes with __get/__set methods. Setting this to true allows you to use the @property, @property-read and @property-write annotations to override property existence checks and resulting property types. Defaults to false.
disableVarParsing
<psalm
disableVarParsing="[bool]"
/>
Disables parsing of @var PHPDocs everywhere except for properties. Setting this to true can remove many false positives due to outdated @var annotations, used before integrations of Psalm generics and proper typing, enforcing Single Source Of Truth principles. Defaults to false.
strictBinaryOperands
<psalm
strictBinaryOperands="[bool]"
>
If true we force strict typing on numerical and string operations (see https://github.com/vimeo/psalm/issues/24). Defaults to false.
rememberPropertyAssignmentsAfterCall
<psalm
rememberPropertyAssignmentsAfterCall="[bool]"
>
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.
allowStringToStandInForClass
<psalm
allowStringToStandInForClass="[bool]"
>
When true, strings can be used as classes, meaning $some_string::someMethod() is allowed. If false, only class constant strings (of the form Foo\Bar::class) can stand in for classes, otherwise an InvalidStringClass issue is emitted. Defaults to false.
disableSuppressAll
<psalm
disableSuppressAll="[bool]"
>
When true, disables wildcard suppression of all issues with @psalm-suppress all. Defaults to false.
memoizeMethodCallResults
<psalm
memoizeMethodCallResults="[bool]"
>
When true, the results of method calls without arguments passed are remembered between repeated calls of that method on a given object. Defaults to false.
hoistConstants
<psalm
hoistConstants="[bool]"
>
When true, constants defined in a function in a file are assumed to be available when requiring that file, and not just when calling that function. Defaults to false (i.e. constants defined in functions will only be available for use when that function is called)
addParamDefaultToDocblockType
<psalm
addParamDefaultToDocblockType="[bool]"
>
Occasionally a param default will not match up with the docblock type. By default, Psalm emits an issue. Setting this flag to true causes it to expand the param type to include the param default. Defaults to false.
checkForThrowsDocblock
<psalm
checkForThrowsDocblock="[bool]"
>
When true, Psalm will check that the developer has supplied @throws docblocks for every exception thrown in a given function or method. Defaults to false.
checkForThrowsInGlobalScope
<psalm
checkForThrowsInGlobalScope="[bool]"
>
When true, Psalm will check that the developer has caught every exception in global scope. Defaults to false.
ignoreInternalFunctionFalseReturn
<psalm
ignoreInternalFunctionFalseReturn="[bool]"
>
When true, Psalm ignores possibly-false issues stemming from return values of internal functions (like preg_split) that may return false, but do so rarely. Defaults to false.
ignoreInternalFunctionNullReturn
<psalm
ignoreInternalFunctionNullReturn="[bool]"
>
When true, Psalm ignores possibly-null issues stemming from return values of internal array functions (like current) that may return null, but do so rarely. Defaults to false.
inferPropertyTypesFromConstructor
<psalm
inferPropertyTypesFromConstructor="[bool]"
>
When true, Psalm infers property types from assignments seen in straightforward constructors. Defaults to true.
findUnusedVariablesAndParams
<psalm
findUnusedVariablesAndParams="[bool]"
>
When true, Psalm will attempt to find all unused variables, the equivalent of running with --find-unused-variables. Defaults to false.
findUnusedCode
<psalm
findUnusedCode="[bool]"
>
When true, Psalm will attempt to find all unused code (including unused variables), the equivalent of running with --find-unused-code. Defaults to false.
findUnusedPsalmSuppress
<psalm
findUnusedPsalmSuppress="[bool]"
>
When true, Psalm will report all @psalm-suppress annotations that aren't used, the equivalent of running with --find-unused-psalm-suppress. Defaults to false.
ensureArrayStringOffsetsExist
<psalm
ensureArrayStringOffsetsExist="[bool]"
>
When true, Psalm will complain when referencing an explicit string offset on an array e.g. $arr['foo'] without a user first asserting that it exists (either via an isset check or via an object-like array). Defaults to false.
ensureArrayIntOffsetsExist
<psalm
ensureArrayIntOffsetsExist="[bool]"
>
When true, Psalm will complain when referencing an explicit integer offset on an array e.g. $arr[7] without a user first asserting that it exists (either via an isset check or via an object-like array). Defaults to false.
phpVersion
<psalm
phpVersion="[string]"
>
Set the php version Psalm should assume when checking and/or fixing the project. If this attribute is not set, Psalm uses the declaration in composer.json if one is present. It will check against the earliest version of PHP that satisfies the declared php dependency
This can be overridden on the command-line using the --php-version= flag which takes the highest precedence over both the phpVersion setting and the version derived from composer.json.
skipChecksOnUnresolvableIncludes
<psalm
skipChecksOnUnresolvableIncludes="[bool]"
>
When true, Psalm will skip checking classes, variables and functions after it comes across an include or require it cannot resolve. This allows code to reference functions and classes unknown to Psalm.
This defaults to false.
sealAllMethods
<psalm
sealAllMethods="[bool]"
>
When true, Psalm will treat all classes as if they had sealed methods, meaning that if you implement the magic method __call, you also have to add @method for each magic method. Defaults to false.
sealAllProperties
<psalm
sealAllProperties="[bool]"
>
When true, Psalm will treat all classes as if they had sealed properties, meaning that Psalm will disallow getting and setting any properties not contained in a list of @property (or @property-read/@property-write) annotations and not explicitly defined as a property. Defaults to false.
runTaintAnalysis
<psalm
runTaintAnalysis="[bool]"
>
When true, Psalm will run Taint Analysis on your codebase. This config is the same as if you were running Psalm with --taint-analysis.
reportInfo
<psalm
reportInfo="[bool]"
>
When false, Psalm will not consider issue at lower level than errorLevel as info (they will be suppressed instead). This can be a big improvement in analysis time for big projects. However, this config will prevent Psalm to count or suggest fixes for suppressed issue
allowNamedArgumentCalls
<psalm
allowNamedArgumentCalls="[bool]"
>
When false, Psalm will not report ParamNameMismatch issues in your code anymore. This does not replace the use of individual @no-named-arguments to prevent external access to a library's method or to reduce the type to a list when using variadics
triggerErrorExits
<psalm
triggerErrorExits="[string]"
>
Describe the behavior of trigger_error. always means it always exits, never means it never exits, default means it exits only for E_USER_ERROR. Default is default
Running Psalm
autoloader
<psalm
autoloader="[string]"
>
If your application registers one or more custom autoloaders, and/or declares universal constants/functions, this autoloader script will be executed by Psalm before scanning starts. Psalm always registers composer's autoloader by default.
throwExceptionOnError
<psalm
throwExceptionOnError="[bool]"
>
Useful in testing, this makes Psalm throw a regular-old exception when it encounters an error. Defaults to false.
hideExternalErrors
<psalm
hideExternalErrors="[bool]"
>
Whether or not to show issues in files that are used by your project files, but which are not included in <projectFiles>. Defaults to false.
hideAllErrorsExceptPassedFiles
<psalm
hideAllErrorsExceptPassedFiles="[bool]"
>
Whether or not to report issues only for files that were passed explicitly as arguments in CLI. This means any files that are loaded with require/include will not report either, if not set in CLI. Useful if you want to only check errors in a single or selected files. Defaults to false.
cacheDirectory
<psalm
cacheDirectory="[string]"
>
The directory used to store Psalm's cache data - if you specify one (and it does not already exist), its parent directory must already exist, otherwise Psalm will throw an error.
Defaults to $XDG_CACHE_HOME/psalm. If $XDG_CACHE_HOME is either not set or empty, a default equal to $HOME/.cache/psalm is used or sys_get_temp_dir() . '/psalm' when not defined.
allowFileIncludes
<psalm
allowFileIncludes="[bool]"
>
Whether or not to allow require/include calls in your PHP. Defaults to true.
serializer
<psalm
serializer="['igbinary'|'default']"
>
Allows you to hard-code a serializer for Psalm to use when caching data. By default, Psalm uses ext-igbinary if the version is greater than or equal to 2.0.5, otherwise it defaults to PHP's built-in serializer.
compressor
<psalm
compressor="['lz4'|'deflate'|'off']"
>
Allows you to hard-code a compressor for Psalm's cache. By default, Psalm uses ext-zlib deflate, if it's enabled.
threads
<psalm
threads="[int]"
>
Allows you to hard-code the number of threads Psalm will use (similar to --threads on the command line). This value will be used in place of detecting threads from the host machine, but will be overridden by using --threads or --debug (which sets threads to 1) on the command line
maxStringLength
<psalm
maxStringLength="1000"
>
This setting controls the maximum length of literal strings that will be transformed into a literal string type during Psalm analysis.
Strings longer than this value (by default 1000 bytes) will be transformed in a generic non-empty-string type, instead.
Please note that changing this setting might introduce unwanted side effects and those side effects won't be considered as bugs.
maxShapedArraySize
<psalm
maxShapedArraySize="100"
>
This setting controls the maximum size of shaped arrays that will be transformed into a shaped array{key1: "value", key2: T} type during Psalm analysis.
Arrays bigger than this value (100 by default) will be transformed in a generic non-empty-array type, instead.
Please note that changing this setting might introduce unwanted side effects and those side effects won't be considered as bugs.
restrictReturnTypes
<psalm
restrictReturnTypes="true"
>
Emits LessSpecificReturnType when the declared return type is not as tight as
the inferred return type.
This code:
function getOne(): int // declared type: int
{
return 1; // inferred type: 1 (int literal)
}
Will give this error: LessSpecificReturnType - The inferred return type '1' for a is more specific than the declared return type 'int'
To fix the error, you should specify the more specific type in the doc-block:
/**
* @return 1
*/
function getOne(): int
{
return 1;
}
Warning: Forcing a tighter type is not always the best course of action and
may cause unexpected results. The following code is invalid with
restrictReturnTypes="true":
class StandardCar {
/**
* @return list{'motor', 'brakes', 'wheels'}
*/
public function getSystems(): array {
return ['motor', 'brakes', 'wheels'];
}
}
class PremiumCar extends StandardCar {
/**
* @return list{'motor', 'brakes', 'wheels', 'rear parking sensor'}
*/
public function getSystems(): array {
return ['motor', 'brakes', 'wheels', 'rear parking sensor'];
}
}
ImplementedReturnTypeMismatch - The inherited return type 'list{'motor', 'brakes', 'wheels'}' for StandardCar::getSystems is different to the implemented return type for PremiumCar::getsystems 'list{'motor', 'brakes', 'wheels', 'rear parking sensor'}'
findUnusedBaselineEntry
Emits UnusedBaselineEntry when a baseline entry is not being used to suppress an issue.
Project settings
<projectFiles>
Contains a list of all the directories that Psalm should inspect. You can also specify a set of files and folders to ignore with the <ignoreFiles> directive. By default, ignored files/folders are required to exist. An allowMissingFiles attribute can be added for ignored files/folders than may or may not exist.
<projectFiles>
<directory name="src" />
<ignoreFiles>
<directory name="src/Stubs" />
</ignoreFiles>
<ignoreFiles allowMissingFiles="true">
<directory name="path-that-may-not-exist" />
</ignoreFiles>
</projectFiles>
<extraFiles>
Optional. Same format as <projectFiles>. Directories Psalm should load but not inspect.
<fileExtensions>
Optional. A list of extensions to search over. See Checking non-PHP files to understand how to extend this.
<enableExtensions>
Optional. A list of extensions to enable. By default, only extensions required by your composer.json will be enabled.
<enableExtensions>
<extension name="decimal"/>
<extension name="pdo"/>
</enableExtensions>
<disableExtensions>
Optional. A list of extensions to disable. By default, only extensions required by your composer.json will be enabled.
<disableExtensions>
<extension name="gmp"/>
</disableExtensions>
<plugins>
Optional. A list of <plugin filename="path_to_plugin.php" /> entries. See the Plugins section for more information.
<issueHandlers>
Optional. If you don't want Psalm to complain about every single issue it finds, the issueHandler tag allows you to configure that. Dealing with code issues tells you more.
<mockClasses>
Optional. Do you use mock classes in your tests? If you want Psalm to ignore them when checking files, include a fully-qualified path to the class with <class name="Your\Namespace\ClassName" />
<universalObjectCrates>
Optional. Do you have objects with properties that cannot be determined statically? If you want Psalm to treat all properties on a given classlike as mixed, include a fully-qualified path to the class with <class name="Your\Namespace\ClassName" />. By default, stdClass and SimpleXMLElement are configured to be universal object crates.
<stubs>
Optional. If your codebase uses classes and functions that are not visible to Psalm via reflection (e.g. if there are internal packages that your codebase relies on that are not available on the machine running Psalm), you can use stub files. Used by PhpStorm (a popular IDE) and others, stubs provide a description of classes and functions without the implementations.
You can find a list of stubs for common classes here.
List out each file with <file name="path/to/file.php" />. In case classes to be tested use parent classes
or interfaces defined in a stub file, this stub should be configured with attribute preloadClasses="true".
<stubs>
<file name="path/to/file.php" />
<file name="path/to/abstract-class.php" preloadClasses="true" />
</stubs>
<ignoreExceptions>
Optional. A list of exceptions to not report for checkForThrowsDocblock or checkForThrowsInGlobalScope. The class tag will make Psalm ignore only instances of the specified class, while classAndDescendants will make Psalm also ignore subclasses. If an exception has onlyGlobalScope set to true, only checkForThrowsInGlobalScope is ignored for that exception, e.g.
<ignoreExceptions>
<class name="fully\qualified\path\Exc" onlyGlobalScope="true" />
<classAndDescendants name="fully\qualified\path\OtherExc" />
</ignoreExceptions>
<globals>
Optional. If your codebase uses global variables that are accessed with the global keyword, you can declare their type. e.g.
<globals>
<var name="globalVariableName" type="type" />
</globals>
Some frameworks and libraries expose functionalities through e.g. $GLOBALS[DB]->query($query).
The following configuration declares custom types for super-globals ($GLOBALS, $_GET, ...).
<globals>
<var name="GLOBALS" type="array{DB: MyVendor\DatabaseConnection, VIEW: MyVendor\TemplateView}" />
<var name="_GET" type="array{data: array<string, string>}" />
</globals>
The example above declares global variables as shown below
$GLOBALSDBof typeMyVendor\DatabaseConnectionVIEWof typeMyVendor\TemplateView
$_GETdatae.g. like["id" => "123", "title" => "Nice"]
<forbiddenFunctions>
Optional. Allows you to specify a list of functions that should emit the ForbiddenCode issue type.
<forbiddenFunctions>
<function name="var_dump" />
<function name="dd" />
</forbiddenFunctions>
Accessing Psalm configuration in plugins
Plugins can access or modify the global configuration in plugins using singleton Psalm\Config.
$config = \Psalm\Config::getInstance();
if (!isset($config->globals['$GLOBALS'])) {
$config->globals['$GLOBALS'] = 'array{data: array<string, string>}';
}