Merge pull request #7867 from mmcev106/master

Documented the allowMissingFiles attribute for ignoreFiles
vimeo · Apr 15, 2022 · b5b5c20 · b5b5c20
2 parents 3b8449a + 6e3c305
commit b5b5c20
Showing 1 changed file with 4 additions and 1 deletion.
diff --git a/docs/running_psalm/configuration.md b/docs/running_psalm/configuration.md
@@ -408,13 +408,16 @@ Allows you to hard-code the number of threads Psalm will use (similar to `--thre
 ## Project settings
 
 #### &lt;projectFiles&gt;
-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, e.g.
+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.
 ```xml
 <projectFiles>
   <directory name="src" />
   <ignoreFiles>
     <directory name="src/Stubs" />
   </ignoreFiles>
+  <ignoreFiles allowMissingFiles="true">
+    <directory name="path-that-may-not-exist" />
+  </ignoreFiles>
 </projectFiles>
 ```