1
0
mirror of https://github.com/danog/psalm.git synced 2024-11-27 04:45:20 +01:00

Add documentation for maxStringLength and maxShapedArraySize configs

This commit is contained in:
Daniil Gentili 2022-03-15 11:05:57 +01:00
parent d4170feb0f
commit e7ec124ebb
Signed by: danog
GPG Key ID: 8C1BE3B34B230CA7

View File

@ -443,6 +443,8 @@ Allows you to hard-code the number of threads Psalm will use (similar to `--thre
This setting controls the maximum length of literal strings that will be transformed into a literal string type during Psalm analysis. This setting controls the maximum length of literal strings that will be transformed into a literal string type during Psalm analysis.
Strings longer than this value (by default 1000 bytes) will be transformed in a generic `non-empty-string` type, instead. Strings longer than this value (by default 1000 bytes) will be transformed in a generic `non-empty-string` type, instead.
Please note that changing this setting might introduce unwanted side effects and those side effects won't be considered as bugs.
#### maxShapedArraySize #### maxShapedArraySize
```xml ```xml
<psalm <psalm
@ -452,6 +454,8 @@ Strings longer than this value (by default 1000 bytes) will be transformed in a
This setting controls the maximum size of shaped arrays that will be transformed into a shaped `array{key1: "value", key2: T}` type during Psalm analysis. This setting controls the maximum size of shaped arrays that will be transformed into a shaped `array{key1: "value", key2: T}` type during Psalm analysis.
Arrays bigger than this value (100 by default) will be transformed in a generic `non-empty-array` type, instead. Arrays bigger than this value (100 by default) will be transformed in a generic `non-empty-array` type, instead.
Please note that changing this setting might introduce unwanted side effects and those side effects won't be considered as bugs.
## Project settings ## Project settings
#### &lt;projectFiles&gt; #### &lt;projectFiles&gt;