danog/Valinor
1
0
Fork 0
mirror of https://github.com/danog/Valinor.git synced 2024-11-26 20:24:40 +01:00
Code Issues Packages Projects Releases Wiki Activity
982f596b8b
Valinor/phpstan.neon.dist

34 lines
1.4 KiB
Plaintext
Raw Normal View History

feat: initial release 🎉
2021-11-28 17:43:02 +01:00
includes:
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.
2021-12-29 00:09:34 +01:00
- qa/PHPStan/valinor-phpstan-configuration.php
feat: initial release 🎉
2021-11-28 17:43:02 +01:00
- vendor/phpstan/phpstan-strict-rules/rules.neon
qa: require and include `phpstan/phpstan-phpunit` rules
2022-02-19 15:27:30 +01:00
- vendor/phpstan/phpstan-phpunit/extension.neon
feat: initial release 🎉
2021-11-28 17:43:02 +01:00
misc!: mark classes with `@internal` or `@api` annotation This change filters the scope of the public API that is provided by this library. Any class or interface that is not explicitly marked with an `@api` annotation should never be used outside this library — any change can and will be made without taking breaking changes rules into account. When a breaking change happens inside the public API scope, a major version will be released; refer to https://semver.org for more information. A new PHPStan extension is now part of the quality assurance process, ensuring that all classes/interfaces must provide either `@internal` or `@api` annotation.
2022-01-07 19:11:49 +01:00
rules:
- CuyZ\Valinor\QA\PHPStan\Extension\ApiAndInternalAnnotationCheck
feat: initial release 🎉
2021-11-28 17:43:02 +01:00
parameters:
level: max
paths:
- src
- tests
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.
2021-12-29 00:09:34 +01:00
- qa/PHPStan
feat: initial release 🎉
2021-11-28 17:43:02 +01:00
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#'
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.
2021-12-29 00:09:34 +01:00
- message: '#Template type T of method CuyZ\\Valinor\\Mapper\\TreeMapper::map\(\) is not referenced in a parameter#'
path: src/Mapper/TreeMapper.php
feat: allow injecting a cache implementation that is used by the mapper The cache implementation that was previously injected in the mapper builder must now be manually injected. This gives better control on when the cache should be enabled, especially depending on which environment the application is running. The library provides a cache implementation out of the box, which saves cache entries into the file system. It is also possible to use any PSR-16 compliant implementation, as long as it is capable of caching the entries handled by the library. ```php $cache = new \CuyZ\Valinor\Cache\FileSystemCache('path/to/cache-dir'); (new \CuyZ\Valinor\MapperBuilder()) ->withCache($cache) ->mapper() ->map(SomeClass::class, [/* … */]); ```
2022-05-22 20:43:01 +02:00
- message: '#Method CuyZ\\Valinor\\MapperBuilder::withCache\(\) has parameter \$cache with generic interface Psr\\SimpleCache\\\CacheInterface but does not specify its types: EntryType#'
path: src/MapperBuilder.php
feat: initial release 🎉
2021-11-28 17:43:02 +01:00
stubFiles:
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.
2021-12-29 00:09:34 +01:00
- qa/PHPStan/Stubs/Psr/SimpleCache/CacheInterface.stub
feat: initial release 🎉
2021-11-28 17:43:02 +01:00
tmpDir: var/cache/phpstan
Reference in New Issue Copy Permalink