danog/psalm
1
0
Fork 0
mirror of https://github.com/danog/psalm.git synced 2024-11-27 04:45:20 +01:00
Code Issues Projects Releases Wiki Activity
13,781 Commits 43 Branches 314 Tags 108 MiB
0ab4c2ac4b
Commit Graph

838 Commits

Author SHA1 Message Date
AndrolGenhald
285740a753 Merge branch '4.x' 2022-07-07 15:01:38 -05:00
Thomas Landauer
3bca297fba
Bringing back <?php 2022-06-21 22:45:45 +02:00
Thomas Landauer
80bcc8b5e3
Improving second link too :-) 2022-06-21 21:55:32 +02:00
Thomas Landauer
7201f0941b
Improving link syntax 2022-06-21 20:56:20 +02:00
Thomas Landauer
fd2683fcc6
Adding common problem cases and possible solutions 
See https://github.com/vimeo/psalm/issues/8133#issuecomment-1162010190

Don't know if this is the best way to explain this, but it's a start :-)

Is there a better way to add the link to https://psalm.dev/docs/annotating_code/supported_annotations/#psalm-mutation-free ?

I also removed the `<?php` tag from the code block.
 2022-06-21 20:23:23 +02:00
Barney Laurance
c064edcbb7
use backticks in docs 2022-06-06 18:26:35 +01:00
Barney Laurance
a7c92661fa
Use int<1,max> to define positivity 2022-06-06 17:05:59 +01:00
Barney Laurance
99372a2286
Clarify in docs that zero is not considered a positive-int 
I wasn't sure from reading the docs whether or not Psalm consider zero to be positive.
 2022-06-06 16:13:30 +01:00
orklah
ec9a9994f5
Merge pull request #8022 from AndrolGenhald/bugfix/8018-improve-failure-case-for-references 
Improve handling of unsupported references (fixes #8018).
 2022-05-27 19:09:05 +02:00
Rudolph Gottesheim
6f00a72446
Fix a typo in MissingConstructor.md 2022-05-27 11:04:00 +02:00
AndrolGenhald
31b4dceaf4 Improve handling of unsupported references (fixes #8018). 2022-05-26 18:28:23 -05:00
Mathieu Rochette
9b2cf438a5
fix small error in plugins_type_system.md 
int-mask → int-mask-of
 2022-05-02 11:08:51 +02:00
Matt Brown
2ef993928c Document @psalm-ignore-variable-* 2022-04-27 01:46:13 -04:00
Matt Brown
20351c6667 Avoid json_encode when serializing non-UTF8 literals 
`\Psalm\Internal\Clause::$hash` basically holds a hash on
arbitrary input literals, used for later comparison. Using
`json_encode` fails when dealing with non-UTF8 literals,
which has been replaced by plain PHP `serialize`.

Resolves: #7771
 2022-04-27 01:42:37 -04:00
Mark McEver
6e3c305dc0
Documented the allowMissingFiles attribute for ignoreFiles 2022-04-14 10:03:21 -05:00
Mark McEver
ea424d79a6
Merge branch 'master' into master 2022-04-13 12:30:37 -05:00
Mark McEver
d28ead12e0
Documented the allowMissingFiles attribute for ignoreFiles 2022-04-13 12:29:06 -05:00
Jeremiasz Major
ce25b39b5d
Document @psalm-ignore-variable-* 2022-04-08 00:30:23 +02:00
Jeremiasz Major
23ad8d6684
Fix typos 2022-04-07 21:50:19 +02:00
Jeremiasz Major
f4f1a26cf9
Document @psalm-yield 2022-04-07 21:43:12 +02:00
Jordi Boggiano
1eb8b5a853
without with 2022-03-23 14:49:51 +01:00
Jordi Boggiano
88a93294b4
Fix int-mask-of doc example 2022-03-23 12:19:07 +01:00
Daniil Gentili
e7ec124ebb
Add documentation for maxStringLength and maxShapedArraySize configs 2022-03-15 11:05:57 +01:00
Daniil Gentili
d4170feb0f
Add documentation for maxStringLength and maxShapedArraySize configs 2022-03-15 10:14:36 +01:00
Patrick Remy
95de0c8dd6
docs: add key-of and value-of to utility types chapter 2022-02-24 18:50:57 +01:00
Patrick Remy
51f3b9869b
docs: add properties-of type to plugins type system 2022-02-24 18:50:35 +01:00
Patrick Remy
8ebc9b599f
docs: describe template support of properties-of<T> 2022-02-23 21:53:02 +01:00
Patrick Remy
5e74445f70
docs: add utility types chapter 2022-02-22 20:51:17 +01:00
Bruce Weirdan
d7d846edc8
Merge branch '4.x' into upstream-master 2022-02-20 02:31:15 +02:00
AndrolGenhald
c1077f32d3 Improve documentation for InvalidGlobal to explain that it's sometimes valid. 2022-02-18 11:36:25 -06:00
AndrolGenhald
bd963e4baa Fix issue documentation links. 2022-02-17 13:04:25 -06:00
AndrolGenhald
d09e420939 Add @psalm-check-type and @psalm-check-type-exact. 
I initially added these as part of my TryAnalyzer rewrite to allow testing complicated `finally` types like this:
```
$foo = 1;
try {
        $foo = 2;
} catch (Exception $_) {
        $foo = 3;
} finally {
        $bar = $foo;
        /** @psalm-check-type-exact $bar = 1|2|3 */;
}
/** @psalm-check-type-exact $bar = 2|3 */;
```
Using the `'assertions'` in tests doesn't work since the type is different inside the `finally`.

I decided to extract the new annotation from the rest of my changes and do a separate pull request since I think others may find it useful, and it should be much easier to review than the entire TryAnalyzer rewrite.
 2022-02-17 10:37:13 -06:00
Daniil Gentili
eb3df40fbb
Add option to disable @var parsing everywhere except for properties. 2022-02-15 10:04:56 +01:00
AndrolGenhald
cc2334f40d More class const improvements. 
Add InvalidClassConstType issue as alternative to LessSpecificClassConstType when type isn't contravariant.
Handle final class consts (#6395).
Use double quotes for types in class const issues.
 2022-02-13 17:19:25 -06:00
orklah
85fca56850 remove totallyTyped 2022-02-12 10:19:14 +01:00
m1ke
810880c71b Alter order of precedence and upated docs to match 2022-02-11 11:12:36 +00:00
Bruce Weirdan
11e60fa261
Merge branch '4.x' into upstream-master 2022-02-11 03:51:48 +02:00
Bruce Weirdan
8a41d61925
Apply suggestions from code review 
Co-authored-by: AndrolGenhald <AndrolGenhald@users.noreply.github.com>
 2022-02-06 00:49:27 +02:00
orklah
e40bcc2d29 doc about property initialization 2022-02-05 12:27:53 +01:00
AndrolGenhald
94eda1a9f9 Fix bullet indentation in documentation. 2022-02-02 14:48:24 -06:00
AndrolGenhald
9429010fda Fix documentation for <globals> config. 2022-02-02 14:38:01 -06:00
Bruce Weirdan
f61193b798
Reinstate MethodSignatureMustProvideReturnType 
It's never emitted, but is there for BC.
 2022-01-31 23:38:15 +02:00
orklah
2e01e9b7cd
Merge pull request #7396 from Patrick-Remy/feat/key-of-value-of-improvements 
feat: make key-of/value-of usable with non-const arrays
 2022-01-31 21:39:01 +01:00
Bruce Weirdan
603714518b
Revert "PHP 8.1: Report missing typehints in overridden native methods" 2022-01-31 14:37:42 +02:00
Daniil Gentili
8d0c1c62e8
Ensure all template parameters are specified in classes, interfaces, traits 2022-01-31 10:06:31 +01:00
Bruce Weirdan
997592de64
Merge pull request #7530 from ohader/issue-7528 2022-01-31 10:36:47 +02:00
Oliver Hader
f5986950a2
[FEATURE] Introduce BeforeStatementAnalysisEvent 
As counterpart to existing `AfterStatementAnalysisEvent` - invoked in
`\Psalm\Internal\Analyzer\StatementsAnalyzer` - this changed introcued
a corresponding `BeforeStatementAnalysisEvent`.

Resolves: #7534
 2022-01-30 19:27:19 +01:00
Oliver Hader
e3602bbfe1
[FEATURE] Allow to intercept adding issue in IssueBuffer 
This change introduces new `BeforeAddIssueEvent` which is invoked
from `IssueBuffer::add`, which allows to collect and intercept code
issue in a generic way.

Resolves: #7528
 2022-01-30 17:46:08 +01:00
Oliver Hader
62a0ece035
!!! Allow plugins to modify Config::$fileExtensions early 
ProjectAnalyzer consumed Config::$fileExtensions early in its
constructor - without having processed plugins' modifications,
registering their custom scanners or analyzer implementations.

This change
* adds new specific interface \Psalm\Plugin\FileExtensionsInterface
  to be used by plugin implementations
* extracts file extension handling from \Psalm\PluginRegistrationSocket
  and interface \Psalm\Plugin\RegistrationInterface to a new dedicated
  \Psalm\PluginFileExtensionsSocket and new interface
  \Psalm\Plugin\FileExtensionsInterface
  !!! this is a breaking change in PluginRegistrationSocket !!!
* adds runtime in-memory cache for Config::$plugins
* calls new method Config::processPluginFileExtensions(), providing
  modifications to file extension only early in ProjectAnalyzer
* adjusts documentation
 2022-01-30 13:06:00 +01:00
orklah
4609bc4e25
Merge pull request #7471 from klimick/function-dynamic-storage-provider 
Function dynamic storage provider
 2022-01-28 18:46:26 +01:00
adrew
5b78125d11 Add doc for DynamicFunctionStorageProviderInterface 2022-01-28 15:18:30 +03:00
AndrolGenhald
5c01913456 Remove deprecated loadXdebugStub attribute. 2022-01-27 16:55:20 -06:00
AndrolGenhald
5cd3b68ab3 Add documentation for enableExtensions and disableExtensions. 2022-01-27 16:31:09 -06:00
Patrick Remy
8cd5ccd076
feat: make value-of<T> capable for template types 2022-01-27 22:28:40 +01:00
Patrick Remy
2880d046ce
feat: make key-of/value-of usable with non-const arrays 2022-01-27 22:22:14 +01:00
orklah
9168cef2d4 Merge remote-tracking branch 'upstream/4.x' into upstream-master6 2022-01-26 21:06:25 +01:00
AndrolGenhald
e268a05307 Minor fixes after rebasing. 2022-01-26 12:57:19 -06:00
AndrolGenhald
f9450656e1 Add support for references and improve UnusedVariable checks (fixes #7254). 2022-01-26 12:55:47 -06:00
AndrolGenhald
b68c6116d8 Use PHP 8.1 when testing AmbiguousConstantInheritance. 2022-01-25 15:49:09 -06:00
AndrolGenhald
0b81f46bb1 Fixes after rebasing. 2022-01-25 15:31:09 -06:00
AndrolGenhald
0edf260d8b Improve class constant static analysis. 
Add class const covariance support (fixes #5589).
Add check for overriding const from interface in PHP < 8.1 (fixes #7108).
Add check for ambiguous const inheritance.
 2022-01-25 15:20:17 -06:00
orklah
7c8441baec
Merge pull request #7123 from AndrolGenhald/feature/942-type-annotate-class-constants 
Support type annotations for class consts (fixes #942).
 2022-01-25 20:54:40 +01:00
Bruce Weirdan
3a6dc9b458
Merge pull request #7431 from zoonru/disable_suppress_all 2022-01-24 11:25:32 +02:00
orklah
63b802bff4 remove TPositiveInt 2022-01-23 23:49:23 +01:00
AndrolGenhald
7d256975e4 Fix cs/psalm errors after rebase. 2022-01-22 17:06:54 -06:00
AndrolGenhald
558208e44e Add type checking for class const assignments, fix several other const issues. 2022-01-22 17:06:54 -06:00
AndrolGenhald
c18a155f77 Support type annotations for class consts (fixes #942). 2022-01-22 17:06:53 -06:00
orklah
841d4f4429 improve support for enum_exists 2022-01-22 18:27:24 +01:00
orklah
af1888b631 Merge remote-tracking branch 'upstream/4.x' into upstream-master4 2022-01-22 17:48:42 +01:00
m1ke
6107148fce Alter order of precedence and upated docs to match 2022-01-20 15:24:21 +00:00
m1ke
06aafa78ad Wording for threads config doc 2022-01-20 10:22:22 +00:00
m1ke
df48eabbd2 Add new config item to docs 2022-01-20 09:50:12 +00:00
orklah
5a6dccd4a9
Merge pull request #7420 from orklah/remove-old-things 
Remove forbidEcho
 2022-01-19 20:32:19 +01:00
orklah
4e5711030d
Merge pull request #7429 from ricardoboss/update-baseline-docs 
Added documentation for baseline files
 2022-01-19 20:02:08 +01:00
Ricardo Boss
ae954f0cdc
Update dealing_with_code_issues.md 2022-01-19 13:34:51 +01:00
Ricardo Boss
bd1385df72
Added context for updating the baseline files 2022-01-19 13:32:47 +01:00
Daniil Gentili
4cfe1a0773
Add configuration option to disable @psalm-suppress all 2022-01-19 13:24:26 +01:00
Daniil Gentili
ef4dd656d0
Update 2022-01-19 12:29:49 +01:00
Daniil Gentili
9021b13b65
Update 2022-01-19 12:29:44 +01:00
Daniil Gentili
d970661182
Add separate issue 2022-01-19 12:20:50 +01:00
Ricardo Boss
1c3d15f5df
Added documentation for baseline files 2022-01-19 12:07:20 +01:00
orklah
dceaa117cf remove forbidEcho 2022-01-18 18:25:18 +01:00
orklah
5f749c8a33 remove forbidEcho 2022-01-18 18:14:39 +01:00
orklah
b633619a2c Merge remote-tracking branch 'upstream/4.x' into upstream-master 2022-01-14 21:01:25 +01:00
orklah
d786e9deef deprecate attribute forbidEcho 2022-01-14 19:31:03 +01:00
AndrolGenhald
6d385fd8f0 Fix documentation for ComplexMethod/ComplexFunction. 
Looks like I misunderstood them.
 2022-01-12 14:37:52 -06:00
AndrolGenhald
240032568c Add test for issues.md to ensure all documented issues are listed. 2022-01-12 14:29:23 -06:00
Daniil Gentili
d6ca1d727e
Fix typo in documentation filename 2022-01-11 14:18:04 +01:00
Daniil Gentili
a35ccfb0cb
Revert misguided changes 2022-01-10 10:19:12 +01:00
Daniil Gentili
4445612ebb
Improve docs 2022-01-10 10:11:28 +01:00
Daniil Gentili
b530f23acc
PHP 8.2: seal all properties by default, add configuration key for lower versions 2022-01-10 10:11:28 +01:00
Bruce Weirdan
afa6497051
Dropped THtmlEscapedString 2022-01-03 22:48:59 +02:00
Bruce Weirdan
e6472deddb
Dropped html-escaped-string docs 2022-01-03 20:54:22 +02:00
Bruce Weirdan
ab60d311c2
Merge pull request #7188 from vimeo/muglug-use-invalidscalarargument-less 2022-01-03 06:04:42 +02:00
Bruce Weirdan
f19e4cedc1
Merge pull request #6705 from orklah/phpstorm-generics-removal 2022-01-03 06:03:36 +02:00
Matthew Brown
83911c7408
Remove unnecessary references to empty in TypeCombiner 2022-01-03 04:10:41 +02:00
orklah
0747b48d06
remove TEmpty 2022-01-03 04:09:59 +02:00
orklah
4f7c1d05c1
remove support for allowPhpstormGenerics 2022-01-02 15:06:04 +02:00
Matthew Brown
ae0063051a
Add better documentation 2022-01-02 14:56:18 +02:00
Bruce Weirdan
36d5a2a83c
Merge pull request #7019 from zoonru/no_ksort_list 2022-01-02 07:37:21 +02:00
AndrolGenhald
dd631c0c85 Skip reference tests, allow assertions on magic properties (fixes #6770). 2021-12-30 16:23:59 -06:00
Daniil Gentili
edc797d1c2
Add docs 2021-12-30 11:56:16 +01:00
Philip Hofstetter
fdeb1954c2
update docs for enum case deprecation 2021-12-22 06:16:42 +01:00
Kamil Tekiela
01d64e606c
Removed misleading parentheses after language construct 2021-12-18 15:20:58 +00:00
ralila
2ff739be4f Replace all-tests with tests 2021-11-30 22:43:54 +01:00
Bruce Weirdan
85f2083acb
Flag duplicate constants 
Fixes vimeo/psalm#6882
Addresses p1 from vimeo/psalm#6471
 2021-11-11 00:44:17 +02:00
Bruce Weirdan
0f8ef45110
Forbid properties on enums 
Fixes vimeo/psalm#6472
 2021-11-06 21:57:49 +02:00
Daniil Gentili
5fae548e62
Add template support to @psalm-self-out 2021-10-28 10:44:37 +02:00
Mathieu Rochette
3f2733ed2c
Small documentation fix 2021-10-21 15:08:42 +02:00
Bruce Weirdan
acad03779b
Update docs/running_psalm/configuration.md 2021-10-20 16:17:54 +03:00
orklah
05f63ef16a wording 2021-10-20 07:06:44 +02:00
orklah
3db477e3c5 deprecate allowPhpStormGenerics 2021-10-19 23:37:35 +02:00
Bruce Weirdan
f328610142
Update docs/annotating_code/type_syntax/scalar_types.md 2021-10-04 23:45:47 +03:00
sasezaki
f03f362431
Declare html-escaped-string is deprecated on doc 2021-10-04 21:00:54 +09:00
orklah
0e83afdb86
Merge pull request #6518 from orklah/fix-truthy 
improvements of alwaysTruthy/alwaysFalsy
 2021-10-04 13:29:49 +02:00
orklah
8b07e69645
Merge pull request #6514 from zoonru/if-this-is 
Add if-this-is
 2021-10-04 09:49:26 +02:00
orklah
28edc25f65 fix doc 2021-10-02 10:01:05 +02:00
Daniil Gentili
741c9ee471
Fixes 2021-09-22 10:26:21 +02:00
Daniil Gentili
15fccc6a07
Add docs 2021-09-21 17:35:44 +02:00
Scott Vanderbeek
a5af5bde23
Update language_server.md 2021-09-21 08:15:06 -07:00
Daniil Gentili
7e0b489efe
Merge remote-tracking branch 'origin/master' into if-this-is 2021-09-21 12:12:15 +02:00
Scott Vanderbeek
866fa5ef36
Update to Phpstorm support 
I've added clarifying information that Phpstorm supports psalm out of the box since 2020.3 release, and removed the LSP information.
 2021-09-20 15:35:53 -07:00
KM
ae4282ad5c
SublimeText configuration 
I have updated SublimeText configuration values for easier integration.
 2021-09-08 18:28:52 +05:30
Bruce Weirdan
d7ef94f98d
[skip-ci] typos 2021-09-08 00:02:02 +03:00
Bruce Weirdan
b4f024b1fe
Basic enum checks 
* Duplicate cases
* Duplicate case values
* Invalid case values: value on a pure enum case, missing value on a
backed enum case, backing type / case type mismatch
* Literal expression evaluation for case values

Fixes vimeo/psalm#6426
Fixes vimeo/psalm#6427
 2021-09-07 12:35:38 +03:00
Bruce Weirdan
a494fc160b
Merge pull request #6436 from orklah/list-doc 2021-09-06 01:01:38 +03:00
orklah
4602e4ae22 change definition of list regarding is_list RFC 2021-09-05 23:03:55 +02:00
Bruce Weirdan
7b11024886
Flag invalid backing types for enums 
Fixes vimeo/psalm#6428
 2021-09-05 20:12:24 +03:00
Bruce Weirdan
de4b344803
Merge pull request #6400 from craigfrancis/taint-limits 
Add section on limitations
 2021-09-04 21:32:22 +03:00
Bruce Weirdan
6e2131da43
s/aded/added/ 2021-09-04 19:27:09 +03:00
Bruce Weirdan
8c54e68efd
Added documentation on callmap editing 2021-09-04 17:39:29 +03:00
Bruce Weirdan
68ad0b2b8f
Update number of contributors 2021-09-04 16:30:16 +03:00
Craig Francis
3d65a8aca9 Add section on limitations 2021-09-04 12:46:15 +01:00
USAMI Kenta
4985109e56
Remove unnecessary [ 2021-08-12 12:08:00 +09:00
Tyson Andre
0ae573a158 [skip ci] Fix typos in docs/ 2021-08-05 16:39:14 -04:00
Bruce Weirdan
c62adf9652
Merge pull request #6198 from mmcev106/master 2021-07-31 00:23:45 +03:00
Mark McEver
92f6639e68
Minor wording change in taint analysis docs 2021-07-30 13:11:22 -05:00
Mark McEver
b574878f19
Clarified when it is safe to run taint analysis 2021-07-28 08:56:52 -05:00
orklah
b8fd6b6f8a add documentation 2021-07-22 23:36:39 +02:00
Grégoire Paris
26f8e5b333
Add negated identity with false case 
This is the opposite of === true and works the same.
 2021-07-17 03:20:23 +03:00
Bruce Weirdan
bee4e83eca
Merge pull request #6047 from simonhammes/docs-assert-method-return-values 
Docs: Add example for method call assertions (#6035)
 2021-07-05 08:44:03 +03:00
Danny Kirkham
fb1dd4c4b4
Update Sublime LSP to match latest version 
I noticed the current config didn't work on the Sublime Text LSP plugin, I've updated it to the latest version of the config for the plugin
 2021-07-04 21:46:15 +01:00
Simon
f80ea4a623 Docs: Add example for method call assertions 2021-07-04 21:34:22 +02:00
Antonio Mangiacapra
3bc519512c
Fix typo in ConfigIssue.md 
"future versions" instead of "feature versions"
 2021-07-02 11:59:26 +02:00
Matthew Brown
74ec3affc2
Add reference to the has_quotes taint 2021-06-26 16:04:04 -04:00
Bruce Weirdan
f24f361a95
Add documentation and schema entry for inferPropertyTypesFromConstructor 
Fixes vimeo/psalm#5974
 2021-06-22 21:20:10 +03:00
Matthew Brown
fc88f4f0ee
Simplify UnusedForeachValue example 2021-06-21 13:57:53 -04:00
orklah
df42172f8e
update documentation about authoring plugins (#5958) 2021-06-20 14:12:07 -04:00
Bruce Weirdan
e552925af6
Emit separate type of issue when foreach value is unused (#5932) 
* Emit separate type of issue when foreach value is unused

Fixes vimeo/psalm#5929

* Fixed var name case sensitivity
 2021-06-17 00:40:24 -04:00
Matthew Brown
b1b1072f41
Fix formatting 2021-06-16 11:53:45 -04:00