mirror of
https://github.com/danog/psalm.git
synced 2024-12-02 09:37:59 +01:00
44 lines
1.1 KiB
Markdown
44 lines
1.1 KiB
Markdown
<img src="https://travis-ci.org/vimeo/psalm.svg?branch=master" />
|
|
|
|
<h1><img src="PsalmLogo.png" height="64" alt="logo" /></h1>
|
|
|
|
Psalm is a static analysis tool for finding errors in PHP applications.
|
|
|
|
- **v0.3.x** supports checking PHP 5.4 - 7.1 code, and requires PHP **5.5+** to run.
|
|
- **v0.2.x** supports checking PHP 5.4 - 7.0 code and requires PHP **5.4+** to run.
|
|
|
|
Check out the [wiki](https://github.com/vimeo/psalm/wiki) or [try a live demo](http://getpsalm.org/)!
|
|
|
|
## Quickstart Guide
|
|
|
|
Install via [Composer](https://getcomposer.org/):
|
|
|
|
```bash
|
|
composer require --dev "vimeo/psalm:dev-master"
|
|
composer install
|
|
```
|
|
|
|
Add a `psalm.xml` config:
|
|
|
|
```bash
|
|
cat > psalm.xml << EOF
|
|
<?xml version="1.0"?>
|
|
<psalm
|
|
stopOnFirstError="false"
|
|
useDocblockTypes="true"
|
|
>
|
|
<inspectFiles>
|
|
<directory name="src" />
|
|
</inspectFiles>
|
|
</psalm>
|
|
EOF
|
|
```
|
|
|
|
Then run Psalm with:
|
|
|
|
```bash
|
|
./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).
|