Skip to content

Improve documentation for glob paths, allowMissingFiles="true" #11709

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
kkmuffme wants to merge 1 commit into
base: 6.x
Choose a base branch
from
Open

Improve documentation for glob paths, allowMissingFiles="true" #11709

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions config.xsd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,8 @@
<xs:element name="file" minOccurs="0" maxOccurs="unbounded" type="NameAttributeType" />
<xs:element name="ignoreFiles" minOccurs="0" maxOccurs="1" type="IgnoreFilesType" />
</xs:choice>

<xs:attribute name="allowMissingFiles" type="xs:string" />
<xs:anyAttribute processContents="skip" />
</xs:complexType>

Expand Down Expand Up @@ -545,6 +547,7 @@
</xs:choice>

<xs:attribute name="type" type="ErrorLevelType" use="required" />
<xs:attribute name="allowMissingFiles" type="xs:string" />
<xs:anyAttribute processContents="skip" />
</xs:complexType>
</xs:element>
Expand All @@ -564,6 +567,7 @@
</xs:choice>

<xs:attribute name="type" type="ErrorLevelType" use="required" />
<xs:attribute name="allowMissingFiles" type="xs:string" />
<xs:anyAttribute processContents="skip"/>
</xs:complexType>
</xs:element>
Expand All @@ -585,6 +589,7 @@
</xs:choice>

<xs:attribute name="type" type="ErrorLevelType" use="required" />
<xs:attribute name="allowMissingFiles" type="xs:string" />
<xs:anyAttribute processContents="skip" />
</xs:complexType>
</xs:element>
Expand All @@ -605,6 +610,7 @@
</xs:choice>

<xs:attribute name="type" type="ErrorLevelType" use="required" />
<xs:attribute name="allowMissingFiles" type="xs:string" />
<xs:anyAttribute processContents="skip" />
</xs:complexType>
</xs:element>
Expand All @@ -625,6 +631,7 @@
</xs:choice>

<xs:attribute name="type" type="ErrorLevelType" use="required" />
<xs:attribute name="allowMissingFiles" type="xs:string" />
<xs:anyAttribute processContents="skip" />
</xs:complexType>
</xs:element>
Expand All @@ -645,6 +652,7 @@
</xs:choice>

<xs:attribute name="type" type="ErrorLevelType" use="required" />
<xs:attribute name="allowMissingFiles" type="xs:string" />
<xs:anyAttribute processContents="skip" />
</xs:complexType>
</xs:element>
Expand All @@ -665,6 +673,7 @@
</xs:choice>

<xs:attribute name="type" type="ErrorLevelType" use="required" />
<xs:attribute name="allowMissingFiles" type="xs:string" />
<xs:anyAttribute processContents="skip" />
</xs:complexType>
</xs:element>
Expand All @@ -685,6 +694,8 @@
</xs:choice>

<xs:attribute name="type" type="ErrorLevelType" use="required" />
<xs:attribute name="allowMissingFiles" type="xs:string" />
<xs:anyAttribute processContents="skip" />
</xs:complexType>
</xs:element>
</xs:sequence>
Expand All @@ -703,6 +714,7 @@
</xs:choice>

<xs:attribute name="type" type="ErrorLevelType" use="required" />
<xs:attribute name="allowMissingFiles" type="xs:string" />
<xs:anyAttribute processContents="skip" />
</xs:complexType>
</xs:element>
Expand Down
6 changes: 4 additions & 2 deletions docs/running_psalm/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -635,15 +635,17 @@ is not being used to suppress an issue.
## 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. 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.
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, all files/folders including ignored ones are required to exist. An `allowMissingFiles` attribute can be added on `projectFiles` or `ignoreFiles` to suppress errors if any of the paths do not exist.
Additionally PHP glob patterns are supported for all file and directory paths everywhere in the config.
```xml
<projectFiles>
<directory name="src" />
<ignoreFiles>
<directory name="src/Stubs" />
</ignoreFiles>
<ignoreFiles allowMissingFiles="true">
<directory name="path-that-may-not-exist" />
<directory name="path-that/**/may-not-exist" />
<directory name="**/foo" />
</ignoreFiles>
</projectFiles>
```
Expand Down
7 changes: 7 additions & 0 deletions docs/running_psalm/dealing_with_code_issues.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,13 @@ Some issue types allow the use of `referencedMethod`, `referencedClass` or `refe
<file name="some_bad_file.php" /> <!-- all InvalidReturnType issues in this file are suppressed -->
</errorLevel>
</InvalidReturnType>
<InvalidGlobal>
<errorLevel type="suppress" allowMissingFiles="true">
<directory name="**/emails/" />
<directory name="**/views/" />
<directory name="**/templates/" />
</errorLevel>
</InvalidGlobal>
<UndefinedMethod>
<errorLevel type="suppress">
<referencedMethod name="Bar\Bat::bar" /> <!-- not supported for all types of errors -->
Expand Down
Loading