php-standard-library/psalm-plugin

Psalm plugin for the PHP Standard Library

Installs: 1 228 559

Dependents: 31

Suggesters: 1

Security: 0

Stars: 23

Watchers: 4

Forks: 5

Open Issues: 1

Type:psalm-plugin

2.3.0 2023-11-28 12:22 UTC

This package is auto-updated.

Last update: 2024-06-28 13:44:30 UTC


README

PSL Psalm Plugin

Static analysis status Type Coverage Total Downloads Latest Stable Version License

Installation

Supported installation method is via composer:

composer require php-standard-library/psalm-plugin --dev

Usage

To enable the plugin, add the Psl\Psalm\Plugin class to your psalm configuration using psalm-plugin binary as follows:

php vendor/bin/psalm-plugin enable php-standard-library/psalm-plugin

Type improvements

Given the following example:

use Psl\Type;

$specification = Type\shape([
  'name' => Type\string(),
  'age' => Type\int(),
  'location' => Type\optional(Type\shape([
    'city' => Type\string(),
    'state' => Type\string(),
    'country' => Type\string(),
  ]))
]);

$input = $specification->coerce($_GET['user']);

/** @psalm-trace $input */

Psalm assumes that $input is of type array<"age"|"location"|"name", array<"city"|"country"|"state", string>|int|string>.

If we enable the php-standard-library/psalm-plugin plugin, you will get a more specific and correct type of array{name: string, age: int, location?: array{city: string, state: string, country: string}}.

Compatibility

PSL Psalm plugin Psalm
2.x ^2.1 v5
2.x ~2.0.0 v4
1.x 1.x v4

Sponsors

Thanks to our sponsors and supporters:

JetBrains

License

The MIT License (MIT). Please see LICENSE for more information.