Psalm uses an XML config file. A barebones example looks like this:
<?xml version="1.0"?> <psalm> <projectFiles> <directory name="src" /> </projectFiles> </psalm>
<psalm /> attributes
enabling this will make Psalm very strict, such that it needs to be able to evaluate the type of every single statement, and emitting a bevy of
Mixed*issues if the types cannot be determined. Defaults to
whether or not to use types as defined in docblocks. Defaults to
if not using all docblock types, you can still use docblock property types. Defaults to
false(though only relevant if
@methodannotation normally only applies to classes with a
__callmethod. Setting this to
trueallows you to use the
@methodannotation to override inherited method return types. Defaults to
if true we force strict typing on numerical and string operations (see https://github.com/vimeo/psalm/issues/24). Defaults to
false, Psalm will not complain when a function with no return types is missing an explicit
@returnannotation. Defaults to
Some like to use
assertfor type checks. If
true, Psalm will process assertions inside
assertcalls. Defaults to
Setting this to
falsemeans 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
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
true, strings can be coerced to
class-string, with Psalm emitting a
TypeCoercionissue. If disabled, that issue changes to a more serious one. Defaults to
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
InvalidStringClassissue is emitted. Defaults to
true(no issues emitted).
true, the results of method calls without arguments passed arguments are remembered between repeated calls of that method on a given object. Defaults to
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)
Occasionally a param default will not match up with the docblock type. By default, Psalm emits an issue. Setting this flag to
truecauses it to expand the param type to include the param default. Defaults to
true, Psalm will check that the developer has supplied
@throwsdocblocks for every exception thrown in a given function or method. Defaults to
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.
useful in testing, things makes Psalm throw a regular-old exception when it encounters an error. Defaults to
whether or not to show issues in files that are used by your project files, but which are not included in
<projectFiles>. Defaults to
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.
whether or not to allow
includecalls in your PHP. Defaults to
Allows you to hard-code a serializer for Psalm to use when caching data. By default, Psalm uses
ext-igbinaryif the version is greater or equal to 2.0.5, otherwise it defaults to PHP's built-in serializer.
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
xml <projectFiles> <directory name="src" /> <ignoreFiles> <directory name="src/Stubs" /> </ignoreFiles> </projectFiles>
A list of extensions to search over. See Checking non-PHP files to understand how to extend this.
A list of
<plugin filename="path_to_plugin.php" />entries. See the Plugins section for more information.
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.
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" />
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" />.