danog/psalm
1
0
Fork 0
mirror of https://github.com/danog/psalm.git synced 2024-11-30 04:39:00 +01:00
Code Issues Projects Releases Wiki Activity

Update docs with better introductory config

Browse Source
This commit is contained in:
Matthew Brown 2017-01-16 01:28:09 -05:00
parent c702ebe13c
commit 54ccd9dfd2
1 changed files with 6 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -30,6 +30,11 @@ cat > psalm.xml << EOF
<projectFiles>
<directory name="src" />
</projectFiles>
<issueHandlers>
<MissingReturnType errorLevel="info" />
<MissingClosureReturnType errorLevel="info" />
<MissingPropertyType errorLevel="info" />
</issueHandlers>
</psalm>
EOF
```
@ -40,4 +45,4 @@ Then run Psalm with:
./vendor/bin/psalm
```
The above config is spartan, and will show you *all* possible errors, including many that are likely irrelevant to you. A more lenient config is provided [here](examples/psalm.default.xml).
The above config is fairly spartan, and will show you *all* possible errors, including many that might be irrelevant to you. A more lenient config is provided [here](examples/psalm.default.xml), and you can learn about how to suppress certain issues [here](https://github.com/vimeo/psalm/wiki/Dealing-with-code-issues).