1
0
mirror of https://github.com/danog/psalm.git synced 2024-11-26 20:34:47 +01:00
Commit Graph

484 Commits

Author SHA1 Message Date
Brown
cf26ab0ea9 Use html entities 2020-04-27 23:11:05 -04:00
Brown
5c2fd5863b Fix escaping 2020-04-27 23:08:43 -04:00
Brown
e73fe89c01 Fix quoting maybe 2020-04-27 23:01:30 -04:00
Matthew Brown
d3b814578c
Revert "chore: remove backticks because of escaping issue in docs (#3242)" (#3251)
This reverts commit 686c2d780d.
2020-04-27 22:57:11 -04:00
feek
686c2d780d
chore: remove backticks because of escaping issue in docs (#3242) 2020-04-27 22:49:51 -04:00
Markus Staab
5c511ad95d
docs: mention cacheDirectory default value (#3184) 2020-04-19 08:04:41 -04:00
Valentin Udaltsov
29394552a2
Update MixedArgumentTypeCoercion.md (#3129) 2020-04-12 19:52:50 -04:00
Šimon Podlipský
2a7be233bb
Remove dead link (#3112)
* Remove dead link

* Fix typos
2020-04-09 08:14:43 -04:00
m0003r
28f740fddb
@psalm-trace is now a specific low-level issue, because plain debug print breaks structured output (after #3080) (#3106) 2020-04-08 21:03:05 -04:00
lhchavez
be87bb7300
Support intersection types for object-like arrays (#3064)
This change allows expressing the intersection of multiple object-like
arrays. The resulting type will contain the (merged via intersection)
properties of all the object-like arrays involved in the intersection.

This should allow to express the resulting type of an `array_merge()`
operation, which is tricky to do in the context of a templated type.
2020-04-08 09:35:53 -04:00
m0003r
11edb22c72
Implement @psalm-trace annotation, fixes #3079 (#3080) 2020-04-06 12:42:22 -04:00
Matthew Brown
6ac6c54a34
Fix defaults 2020-04-06 09:28:49 -04:00
Matthew Brown
a1be95dc19
remove dead link 2020-04-05 17:24:05 -04:00
Matthew Brown
ec7c8e5f59
Remove dead link 2020-04-05 17:23:23 -04:00
Matthew Brown
476b248a1e
Delete docblock_type_syntax.md 2020-04-02 09:41:12 -04:00
Matthew Brown
500b4eb13b
Add content from redundant page 2020-04-02 09:40:17 -04:00
Matthew Brown
194f02507d Allow conditional types to reference class constants 2020-03-29 13:37:37 -04:00
Matthew Brown
9055c4a79b Add documentation for conditional types
Fixes #3005
2020-03-29 11:14:03 -04:00
iggyvolz
94b246b987
Initial commit (#3013) 2020-03-24 18:32:57 -04:00
Matthew Brown
010b805397
Fix issue description 2020-03-23 23:55:51 -04:00
Matthew Brown
e8fbba5de2
Improve words 2020-03-23 23:54:48 -04:00
Matthew Brown
2043e857ba
Increase header weight 2020-03-22 18:42:19 -04:00
Matthew Brown
e5579332cd Add explanation for MixedMethodCall 2020-03-21 17:33:37 -04:00
Matthew Brown
e6a0fe0973
Add a better description to PossiblyInvalidArgument 2020-03-21 15:33:40 -04:00
Markus Staab
4079b53b93
Fix typo (#2999) 2020-03-21 10:19:30 -04:00
Matthew Brown
e49a5dd55d Add more docs 2020-03-21 10:13:11 -04:00
Matthew Brown
3f2615290d Update docs once more 2020-03-21 09:48:35 -04:00
Matthew Brown
d22fe29a60 Switch around docs 2020-03-21 09:36:21 -04:00
Matthew Brown
476480ef41 Add opening <?php tags to all PHP snippets 2020-03-21 09:24:41 -04:00
Matthew Brown
f6ea701bdc Add a couple more documented things 2020-03-21 00:39:00 -04:00
Matthew Brown
40bd743e49 Add a few more about type mismatches 2020-03-20 21:55:34 -04:00
Matthew Brown
33dc3a62be Improve example code 2020-03-20 19:19:24 -04:00
Matthew Brown
84bfba04c8 Add opening PHP tags to examples 2020-03-20 19:13:56 -04:00
Matthew Brown
dd0898c4df
Add how to fix for PossiblyUndefinedArrayOffset 2020-03-20 15:20:54 -04:00
Matthew Brown
7afb4b4cd5 Add some more docs 2020-03-20 00:21:11 -04:00
Matthew Brown
cc77910338 Fix indentation 2020-03-19 16:37:17 -04:00
Matthew Brown
7ba0d27d6c Fix formatting 2020-03-19 12:42:41 -04:00
Matthew Brown
f0f9b2d01b Add suffix 2020-03-19 12:34:48 -04:00
Matthew Brown
2f62e2d9f5 Move issues to separate pages 2020-03-19 12:32:49 -04:00
Matthew Brown
c3e94b3e54
Separate formatting
Fixes #2988
2020-03-18 19:15:44 -04:00
Matthew Brown
b2574ad1a3
Add weird break 2020-03-18 19:14:04 -04:00
Matthew Brown
da456b62db
Add more whitespace 2020-03-18 19:12:02 -04:00
Claas Augner
a5f581e294
Fix #2984 - Document Generator type syntax (#2986) 2020-03-18 09:28:32 -04:00
yaegassy
6d4e809491
Add coc.nvim for language server document (#2980)
* Add coc.nvim for language server document

* Add psalm.xml.dist to coc.nvim's rootPatterns
2020-03-17 09:04:43 -04:00
Matthew Brown
7017fe3ca4 Fix indentation 2020-03-16 09:51:45 -04:00
Matthew Brown
96a1a0c04f
Remove cast from docblock example 2020-03-16 09:46:43 -04:00
Matthew Brown
6d8e8ba5e2
Add more suggestions 2020-03-16 09:42:17 -04:00
Matthew Brown
f22f5e38f1
Add a how to fix section for MixedAssignment 2020-03-16 09:30:51 -04:00
Alexey Kopytko
9e64670e42
Add hyperlink in templated_annotations.md (#2976) 2020-03-15 23:28:37 -04:00
Matthew Brown
0aca01faea Improve fix to #2805 2020-03-14 01:09:12 -04:00
Maks Rafalko
b6873b0e72 ignoreInternalFunctionFalseReturn default to false in XSD, but documentations says true
See 27598f508e/config.xsd (L46)
2020-03-12 09:12:23 -04:00
Matthew Brown
ef64e6e8eb Improve abstract call handling 2020-03-11 10:36:39 -04:00
Matthew Brown
0d62fbdf98 Detect erroneous abstract static method calls 2020-03-11 10:18:40 -04:00
Philip Hofstetter
d315822bfa make skipping of checks after invalid includes configurable
as suggested in the PR it's best to make the setting configurable.

In order not to break existing installations, we default to keeping the
old behaviour, but in a later version of psalm, we might change the
default.
2020-02-27 18:49:23 -05:00
Matthew Brown
106102d0a5
Add line break 2020-02-23 00:41:19 -05:00
Matthew Brown
a706f4d722 Fix #2242 - warn when using mutable dependencies 2020-02-22 10:04:46 -05:00
Brown
7d99a15072 Fix #2805 - forbid passing in mutable class to mutation-free context 2020-02-21 18:25:35 -05:00
Tarmo Leppänen
f51384e74e Update dealing_with_code_issues.md 2020-02-20 13:47:13 -05:00
Matthew Brown
306ed07cfc
Update readme 2020-02-18 23:50:53 -05:00
Matthew Brown
2e4154d76e Add better defaults and documentation 2020-02-18 20:30:37 -05:00
Matthew Brown
320f3ec863 Update level config name 2020-02-17 22:43:13 -05:00
Matthew Brown
a55686b6e4 Move to more appropriate location 2020-02-17 22:21:04 -05:00
Matthew Brown
2cb3d0f9f3 Fix error level docs 2020-02-17 22:19:28 -05:00
Matthew Brown
a2c2a55ae6 Update documentation 2020-02-17 22:06:28 -05:00
Matthew Brown
ced092874a Make config generation smarter 2020-02-17 22:05:58 -05:00
Philip Hofstetter
395cf587d3 add plugin hook to be called after every function call
compared to AfterFunctionCallAnalysisInterface which gets only called
after a call to a function declared within the project, a plugin
implementing AfterEveryFunctionCallAnalysisInterface will get called for
every function call, including calls of PHP builtins.

On the other hand, this interface doesn't allow modification of the code
nor tweaking the return type, but it's still useful for accounting
purposes and for depreacting calls to PHP builtins

this fixes #2804
2020-02-13 09:10:24 -05:00
Bruce Weirdan
ae0b1a6acb Fix #2802
/cc: @zmitic
2020-02-12 17:43:33 -05:00
Roland Franssen
a7355fa734 Update typing_in_psalm.md 2020-02-07 10:55:44 -05:00
Matthew Brown
b3f6b56f9c Add support for @psalm-readonly-allow-private-mutation 2020-02-02 15:56:08 -05:00
Matthew Brown
93c613b5a3 Adjusted for actual implementation 2020-02-02 15:39:24 -05:00
Christian Kolb
fd6cdf61c7 Update naming to mutate 2020-02-02 15:39:24 -05:00
Christian Kolb
143756800f Add documentation for new @psalm-private-set annotation 2020-02-02 15:39:24 -05:00
Philip Hofstetter
40497e4f4c document phpVersion setting 2020-01-30 08:48:53 -05:00
Matthew Brown
5c3ec7a531 Fix #2696 - make sure static property references are prevented in pure functions 2020-01-27 22:55:20 -05:00
Barney Laurance
4a4c0f1362 Clarify documentation of --diff and --diff-methods (#2680)
* Clarify documentation of --diff and --diff-methods

* Save Psalm cache in CircleCI
2020-01-25 10:50:11 -05:00
Brown
0f659d996d Add documentation for new issue 2020-01-23 14:33:07 -05:00
HenkPoley
72b5b22474 Mention how to annotate psalm specific annotations (#2648)
* Mention how to annotate psalm specific annotations

Might be nice to mention how to annotate psalm specific annotations, without trampling over PhpDoc annotations.

* Fix key type

Co-authored-by: Matthew Brown <github@muglug.com>
2020-01-17 08:47:21 -05:00
Bruce Weirdan
17857163fc Modular config files (#2635)
This change introduces an option to have the configuration split across
several files using standard XInclude tags. This may be useful for more
complex configs, or to include auto-generated parts into a manually
written config file.
2020-01-16 15:57:52 -05:00
Jacob Dreesen
26bf183430 Fix typos (#2639) 2020-01-16 08:36:18 -05:00
Pavel Batečko
87debfe954 Support suppressing all issues with @psalm-suppress all (#2584)
* Support suppressing all issues using @psalm-suppress all

* Document @psalm-suppress all
2020-01-12 10:38:32 -05:00
HenkPoley
d22b13262f [For PhpStorm] How to find the global install of the language server under Windows (#2582)
* Handholding to find the global install of the language server under Windows

* Hint about a 'proper' timeout for things like Laravel
2020-01-10 08:47:01 -05:00
Brown
083fbc55e1 Add more specific UndefinedMagicMethod issue 2020-01-06 14:23:33 -05:00
Matthew Brown
4e85967184 Fix tests 2020-01-05 21:58:18 -05:00
Matthew Brown
daf6b6391d
Punctuation 2020-01-02 16:21:15 -05:00
LeSuisse
88c496121e Add an example on how to use @psalm-immutable annotation with an anonymous class (#2544)
Related to #2543
2020-01-02 14:09:11 -05:00
Markus Podar
270a99f57d Add sample for optional keys in array shapes (#2538) 2020-01-01 13:53:32 -05:00
Ruud Kamphuis
ca31931a53 Explain bool assertions (#2528) 2019-12-29 09:22:09 -05:00
Matthew Brown
a2a2d8cd97
Delimit quotes 2019-12-21 14:15:02 +00:00
Grégoire Paris
cde7c80786 Spell "covariant" properly (#2487) 2019-12-19 17:49:51 +00:00
Matthew Brown
c2464ebb71 fix link 2019-12-19 10:41:15 +00:00
Matthew Brown
7b6061efe3 Add section on template covariance 2019-12-19 10:36:14 +00:00
Valentin Udaltsov
bb52c4ce75 Update callable_types.md (#2482)
Spread operator must be a suffix in callables
2019-12-19 00:28:04 +00:00
Matthew Brown
fb85b81908 Add note about using the Phar 2019-12-18 15:35:18 +00:00
Leo Cavalcante
1bc2bb6386 Update PhpStorm usage (#2410)
There is a new option that defaults to Artifact. It should be Executable.
Windows can't figure out that the PHP interpreter will run a shell script that then calls  PHP (not sure if this even works on Unix)
And added a PHP bin dir example for Wins
2019-12-04 13:36:30 -05:00
Matthew Brown
6ce6ad4483
Add note about Shepherd 2019-12-03 09:53:37 -05:00
Brown
af5f83602e Break out more specific possibly defined offset errors 2019-11-11 09:59:56 -05:00
Bruce Weirdan
79acbadfad Added InvalidParent issue (#2320)
Refs vimeo/psalm#2304
2019-11-11 00:21:43 -05:00
ADmad
065653c58f Fix param name in example (#2317) 2019-11-09 16:26:06 -05:00
Jáchym Toušek
f2c82fa212 Add support for Iterator<X> type (#2285)
* Add support for Iterator<X> type

* Fix tests
2019-10-30 18:00:27 +00:00
Matthew Brown
4ee037923a
add link to lists 2019-10-11 09:58:34 -04:00
Matthew Brown
f25fe29c73
Add documentation for lists 2019-10-11 09:56:46 -04:00
Matthew Brown
79f2f4197a
Fix typo 2019-09-26 16:20:42 -04:00
Brown
cf799d0926 Fix #2173 - remove @var annotations automatically 2019-09-26 15:08:05 -04:00
Matthew Brown
9c629414a7 Fix #2138 - complain when inheriting from immutable interfaces without annotation 2019-09-21 22:52:30 -04:00
Brown
c5ef2516b5 Fix #2150 - add detection for unnecessary @var annotations
And also remove them from codebase
2019-09-19 11:59:43 -04:00
Matthew Brown
9ad6c36d9b
Conditionally verify that array offsets exist (#2147)
* Check array offsets idea

* Clean up some issues

* Add a few light fixes

* Add docs
2019-09-18 14:21:06 -04:00
SignpostMarv
943705ce0e load an xdebug stub when required, re: vimeo/psalm#2118 (#2133)
* load an xdebug stub when required, re: vimeo/psalm#2118

* correcting case sensitivity of XDebug to Xdebug

* only load the Xdebug stub when needed
2019-09-14 10:13:39 -04:00
Jacob Dreesen
34d98f9f42 Fix description of @psalm-external-mutation-free (#2110) 2019-09-09 14:52:30 -04:00
Brown
56c884845f Static methods inside @psalm-immutable class should be permitted
Fixes #2109
2019-09-09 10:38:55 -04:00
Matthew Brown
f8b8f35c03 Add docs for @psalm-pure 2019-09-08 15:25:12 -04:00
Matthew Brown
5d08c47e4b Add docs for immutable ideas 2019-09-08 15:21:30 -04:00
Matthew Brown
51e552665e Fix #2061 - add config to allow suppression of string increment issues 2019-09-01 17:49:37 -04:00
Matthew Brown
dee2cf3281 Detect use of static inside pure function 2019-08-31 21:31:53 -04:00
Matthew Brown
6d07663d70 Annotate method getters more accurately 2019-08-30 16:40:32 -04:00
lhchavez
3e5f6b16b7 Add documentation for the <globals> project setting (#2068)
This change exposes the documentation for the <globals> project setting.
2019-08-25 23:47:39 -04:00
Markus Staab
51bf0b4001 document psalter --allow-backwards-incompatible-changes=false option (#2056) 2019-08-25 23:47:06 -04:00
Brown
95c61db513 Add a PossibleRawObjectIteration issue 2019-08-20 12:06:02 -04:00
Matthew Brown
2a5e0d8f39 Fix #1444 - track unused suppressions 2019-08-18 14:27:50 -04:00
lhchavez
c98c160907 Allow explicitly-annotated mixed assignments (#2030)
This change makes it possible to assign mixed expressions to variables
if an annotation is explicitly added to the variable. This allows the
use of `call_user_func` without needing to suppress issues.

Fixes: #1374
2019-08-17 11:22:43 -04:00
Matthew Brown
5c1b4d5a2a
Fix underscore 2019-08-16 22:28:31 -04:00
Matthew Brown
476f9ae353
Fix type links 2019-08-16 22:27:58 -04:00
Matthew Brown
88e8f105e0
Remove code from links 2019-08-16 22:24:11 -04:00
Matthew Brown
fafb7ee7e1
Remove thing that needn't be code 2019-08-16 22:21:17 -04:00
Matthew Brown
8228a0f9a5
Add more descriptive text for InvalidDocblockParamName 2019-08-15 10:52:24 -04:00
Brown
b5614d03f8 Add detection for unused function calls 2019-08-13 13:15:23 -04:00
Matthew Brown
89416c6f4f
AddWord 2019-08-13 09:24:50 -04:00
Matthew Brown
b53446e11d
Add documentation for findUnusedVariables and findUnusedCode 2019-08-13 09:24:20 -04:00
Matthew Brown
7c6b1581d3 Add warnings about uninitialised properties to mixed as well 2019-08-11 00:22:28 -04:00
Matthew Brown
85c9b6bb44
Add documentation for automatically removing UnusedVariable 2019-08-09 11:40:46 -04:00
Brown
04c12a36fe Fix docs example for impurity 2019-08-07 15:39:51 -04:00
Matthew Brown
b2c0993cdc Add framework for taint analysis to Psalm
Ref #611
2019-08-04 10:37:36 -04:00
Chad Burrus
7ded79bb27 typo fix : "you" -> "your" (#1976) 2019-07-30 13:22:26 -04:00
Matthew Brown
90854c4094 Fix broken behaviour when analysing interface test methods 2019-07-28 19:44:36 -04:00
Mikko Pesari
82e79aae20 Fix ignoreExceptions tags (#1966) 2019-07-24 07:50:40 -04:00
Matthew Brown
3df248eea2 Add concept of purity to functions and methods 2019-07-18 01:31:48 -04:00
Roland Franssen
e58660f38b Add docs for optional ObjectLike (#1942)
* Add docs for optional ObjectLike

ref #634

* Update plugins_type_system.md

* Use better letters
2019-07-17 22:54:01 -04:00
Barney Laurance
94f934627c Work in progress - resolve directories from config file location (#1904)
* Add resolveFromConfigFile config option

Treats all paths as relative to the location of the config file, not
the current working directory of the process.

This commit just changes psalm, further commits will be needed to
apply the change to psalter and the LSP server.

* Copy asset xml files into project root for testing, delete during teardown

Needed since paths are now resolved relative to the position of the
file.

Not sure why I only saw a test failre for 1.xml - would have expected it
for all eight files.

* Fix following rebase

* Move psalm --init handly code above working directory setting code

If there's no psalm.xml yet we can't use the location of psalm.xml to
set our working directory

* Move Psalm version output code above working directory resolution

Working directory doesn't need to be known to output version constant

* Rely on new config file based working directory in end to end test

* Dont use rely on config dir for --alter - not currently working

* Fix code style error

* Add failing test for supporting config without `resolveFromConfigFile="true"`

* Don't treat config directory as a path to check

* Document resolveFromConfigFile setting
2019-07-06 12:21:39 -04:00
Tyson Andre
220513c5f2 Fix typos with codespell (#1870) 2019-06-28 13:59:09 -04:00
Brown
6a95aeb7e2 Fix 404 2019-06-27 17:35:24 -04:00
Brown
0d3f5af18c Break out docblock_type_syntax.md into separate files 2019-06-27 17:00:26 -04:00
Dave Liddament
af1decf30c Add missing links to documentation (#1858)
Not sure how index for docs are generated. The hope is this should fix #1857
2019-06-27 14:36:27 -04:00
Ivan
5bb28cc493 fix typo (#1819) 2019-06-20 09:05:22 -04:00
Matthew Brown
4823e35f8e
Add rename namespace command 2019-06-19 19:49:42 -04:00
Matthew Brown
f06cd85ad0
Fix link 2019-06-19 14:21:07 -04:00
Matthew Brown
51e31ba9c9
Add separate file for adding_assertions 2019-06-19 14:19:40 -04:00
Matthew Brown
95fc208ce3
Break out assertion syntax into separate file 2019-06-19 14:19:14 -04:00
Matthew Brown
d0e84f1b88
remove slash 2019-06-19 01:39:11 -04:00
Matthew Brown
9ad6e7c024
Remove a word 2019-06-19 01:24:14 -04:00
Matthew Brown
0cd8e71368
Fix formatting 2019-06-19 01:23:49 -04:00
Matthew Brown
a46dddde4b
Add newline 2019-06-19 01:21:29 -04:00