psalm README

The project's README from github.com/vimeo/psalm. As one markdown file: README.md.

Psalm

Packagist Packagist Psalm coverage Psalm level

Psalm is a static analysis tool for finding errors in PHP applications.

Join the official Psalm news channel and the Psalm community on Telegram and Discord!

Installation

To get started, check out the installation guide.

Live Demo

You can play around with Psalm on its website.

Documentation

Documentation is available on Psalm’s website, generated from the docs folder.

Support Psalm development

You can support Psalm development by requesting a support contract from Daniil Gentili, the only active maintainer of Psalm.

Support contracts can cover full integration of Psalm into existing codebases, support for Psalm issues and development of additional Psalm features.

See here » for info, pricing and contact information.

Interested in contributing?

Have a look at CONTRIBUTING.md.

Who made this

Built by Matt Brown (@muglug).

Maintained by Daniil Gentili (@danog) and Alies Lapatsin (@alies-dev).

Former maintainers: Orklah (@orklah) and Bruce Weirdan (@weirdan).

The engineering team at Vimeo have provided a lot encouragement, especially @nbeliard, @erunion and @nickyr.

psalm (vimeo/psalm)

Searching Database…

5.9K ·GitHub
What is this?Psalm is a static analysis tool that scans PHP code to find errors and security vulnerabilities without running the application.
Is it a library I import, or a tool I run?It's a tool you run against your PHP project, not code you import into the app.
How do I get it running?The README doesn't list commands. It points to an installation guide on Psalm's website, and there is also a live demo there if you want to try it first.
What do I need on my side first?The README lists no requirements. Psalm targets PHP applications, so you need a PHP codebase to analyze. Check the installation guide for the exact environment.
What does type inference do in Psalm?Psalm works out the types of variables and return values from the code itself, so it can flag mismatched values even where you did not write explicit type hints.
What is taint analysis?It follows untrusted input, such as user data, from where it enters the app to where it is used, and warns when that data reaches a dangerous spot like a database query without proper handling.
Does it run on Windows and macOS too?The README does not list supported operating systems. As a PHP command-line tool it generally runs wherever PHP runs, but check the installation guide to confirm.
Creator
vimeo
Size
138.1 MB
Stars
5.9K
Age
9y
Commits · 90 Days