psalm/docs/configuration.md

Configuration

Psalm uses an XML config file. A barebones example looks like this:

<?xml version="1.0"?>
<psalm>
    <projectFiles>
        <directory name="src" />
    </projectFiles>
</psalm>

Options

• useDocblockTypes
  whether or not to use types as defined in docblocks. Defaults to true.
• useDocblockPropertyTypes
  if not using all docblock types, you can still use docblock property types. Defaults to false (though only relevant if useDocblockTypes is false.
• autoloader
  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
  useful in testing, things makes Psalm throw a regular-old exception when it encounters an error. Defaults to false.
• hideExternalErrors
  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.
• cacheDirectory
  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.
• allowFileIncludes
  whether or not to allow require/include calls in your PHP. Defaults to true.
• totallyTyped
  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 false.
• strictBinaryOperands
  if true we force strict typing on numerical and string operations (see https://github.com/vimeo/psalm/issues/24)
• requireVoidReturnType
  if false, Psalm will not complain when a function with no return types is missing an explicit @return annotation. Defaults to true.
• useAssertForType
  Some like to use assert for type checks. If true, Psalm will process assertions inside assert calls. Defaults to false.
• rememberPropertyAssignmentsAfterCall
  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.

Project settings

• <projectFiles>
  Contains a list of all the directories that Psalm should inspect
• <fileExtensions> (optional)
  A list of extensions to search over. See Checking non-PHP files to understand how to extend this.
• <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" />
• <stubs> (optional)
  If you 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" />.