danog/psalm-plugin-laravel
1
0
Fork 0
mirror of https://github.com/danog/psalm-plugin-laravel.git synced 2025-01-22 13:21:19 +01:00
Code Issues Packages Projects Releases Wiki Activity

chore: touch up readme

Browse Source
This commit is contained in:
Feek 2020-04-18 13:44:42 -07:00
parent a603f224db
commit 025faba0de
1 changed files with 23 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@ -1,14 +1,34 @@
# Psalm plugin for Laravel
[![Packagist](https://img.shields.io/packagist/v/psalm/plugin-laravel.svg)](https://packagist.org/packages/psalm/plugin-laravel)
[![Packagist](https://img.shields.io/packagist/dt/psalm/plugin-laravel.svg)](https://packagist.org/packages/psalm/plugin-laravel)
![Type coverage](https://shepherd.dev/github/psalm/laravel-psalm-plugin/coverage.svg)
![dev-master Tests](https://img.shields.io/github/workflow/status/psalm/psalm-plugin-laravel/Run%20Tests?label=dev-master%20tests)
## Installation
## Overview
This package brings static analysis and type support to projects using Laravel. Our goal is to find as many type-related
bugs as possible, therefore increasing developer productivity and application health. Find bugs without the overhead
of writing tests!
First [install Psalm](https://psalm.dev/quickstart) in your project, making sure to run `--init`, then run the following commands:
## Quickstart
Please refer to the [full Psalm documentation](https://psalm.dev/quickstart) for a more detailed guide on introducing Psalm
into your project.
First, start by installing Psalm if you have not done so already:
```bash
composer require --dev vimeo/psalm
./vendor/bin/psalm --init
```
Next, install this package and enable the plugin
```bash
composer require --dev psalm/plugin-laravel
vendor/bin/psalm-plugin enable psalm/plugin-laravel
./vendor/bin/psalm-plugin enable psalm/plugin-laravel
```
Finally, run Psalm to analyze your codebase
```bash
./vendor/bin/psalm
```
## How it works