Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fkupper/psalm-laravel-collections
Stubs to let Psalm understand Laravel Collections better
https://github.com/fkupper/psalm-laravel-collections
collections generics laravel psalm psalm-plugin
Last synced: 2 months ago
JSON representation
Stubs to let Psalm understand Laravel Collections better
- Host: GitHub
- URL: https://github.com/fkupper/psalm-laravel-collections
- Owner: fkupper
- License: mit
- Created: 2020-08-10T18:25:45.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-04-06T14:33:21.000Z (over 3 years ago)
- Last Synced: 2024-09-27T20:20:56.833Z (3 months ago)
- Topics: collections, generics, laravel, psalm, psalm-plugin
- Language: Gherkin
- Homepage:
- Size: 12.7 KB
- Stars: 8
- Watchers: 3
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# psalm-laravel-collections
[](https://travis-ci.org/fkupper/psalm-laravel-collections)
[](//packagist.org/packages/fkupper/psalm-laravel-collections)
[](//packagist.org/packages/fkupper/psalm-laravel-collections)
A [Laravel](https://github.com/laravel/laravel)'s `\Illuminate\Support\Collection` plugin for [Psalm](https://github.com/vimeo/psalm) (requires Psalm v3) to help you find errors in some cases where you use collections.
## Installation:
```console
$ composer require --dev fkupper/psalm-laravel-collections
$ vendor/bin/psalm-plugin enable fkupper/psalm-laravel-collections
```
## Examples
### Accessing array with wrong key type
```php
/** @var Collection */
$c = new Collection(['a' => 'A', 'b' => 'B', 'c' => 'C']);
$items = $c->all();
$items[1];
```
### Adding an item of invalid type
```php
/** @var Collection */
$c = new Collection(["a", "b", "c"]);
// items type is deinfed as string, cannot add int
$c->add(1);
```
### Asserting collection item value type
```php
/**
* @param Collection
*/
function(Collection $coll): void {
$exception = $coll->first();
// psalm will report this typo
$exception->getMassage();
}
/**
* @param Collection
*/
function(Collection $coll): int {
$value = $coll->first();
// psalm will remind you forgot to cast that $value to int
return $value + 1;
}
```
### Better assertion of helper methods, like `Collection::filter`
```php
/**
* This function is using wrong types in the filter Closure params.
* @param Collection
*/
function(Collection $coll): void {
$filteredValues = $coll->filter(
// psalm will tell you that the Closure params are wrong
function (bool $value, float $key): bool {
return true;
}
)
}
/**
* @param Collection
*/
function(Collection $coll): void {
$filteredValues = $coll->filter(
function (int $value, string $key): bool {
return true;
}
)
// psalm understands that the result of the filter call
// is a collection of same type as it was before, so the value
// type is still string, therefore array cannot be added
$filteredValues->add(['something']);
}
```
## Work In Progress
This is a work in progress project, therefore not all Collection methods have had their templates extended, or tested.
Please report any issues you may find, and even beetter, make a pull request with a fix!