Valinor/phpstan.neon.dist
Romain Canon b2e810e3ce feat!: allow mapping to any type
Previously, the method `TreeMapper::map` would allow mapping only to an
object. It is now possible to map to any type handled by the library.

It is for instance possible to map to an array of objects:

```php
$objects = (new \CuyZ\Valinor\MapperBuilder())->mapper()->map(
    'array<' . SomeClass::class . '>',
    [/* … */]
);
```

For simple use-cases, an array shape can be used:

```php
$array = (new \CuyZ\Valinor\MapperBuilder())->mapper()->map(
    'array{foo: string, bar: int}',
    [/* … */]
);

echo strtolower($array['foo']);
echo $array['bar'] * 2;
```

This new feature changes the possible behaviour of the mapper, meaning
static analysis tools need help to understand the types correctly. An
extension for PHPStan and a plugin for Psalm are now provided and can be
included in a project to automatically increase the type coverage.
2022-01-02 00:48:01 +01:00

27 lines
1.0 KiB
Plaintext

includes:
- qa/PHPStan/valinor-phpstan-configuration.php
- vendor/phpstan/phpstan-strict-rules/rules.neon
parameters:
level: max
paths:
- src
- tests
- qa/PHPStan
ignoreErrors:
# \PHPStan\Rules\BooleansInConditions
- '#Only booleans are allowed in .* given#'
# \PHPStan\Rules\DisallowedConstructs\DisallowedShortTernaryRule
- '#Short ternary operator is not allowed\. Use null coalesce operator if applicable or consider using long ternary\.#'
# \PHPStan\Rules\DisallowedConstructs\DisallowedEmptyRule
- '#Construct empty\(\) is not allowed\. Use more strict comparison\.#'
- '#Method [\w\\:]+_data_provider\(\) return type has no value type specified in iterable type#'
- message: '#Template type T of method CuyZ\\Valinor\\Mapper\\TreeMapper::map\(\) is not referenced in a parameter#'
path: src/Mapper/TreeMapper.php
stubFiles:
- qa/PHPStan/Stubs/Psr/SimpleCache/CacheInterface.stub
tmpDir: var/cache/phpstan