danog/psalm
1
0
Fork 0
mirror of https://github.com/danog/psalm.git synced 2024-12-03 10:07:52 +01:00
Code Issues Projects Releases Wiki Activity
13,542 Commits 43 Branches 314 Tags 108 MiB
c754a0ea08
Commit Graph

833 Commits

Author SHA1 Message Date
rhertogh
fa107d5e01 Updated docs for comments in Array Shapes with // in the key 2023-07-15 20:15:37 +02:00
rhertogh
2e00fd08c3 Updated docs for comments in Array Shapes 2023-07-15 19:25:17 +02:00
Christophe Coevoet
7e6e37b106
Fix the link reference in the doc 2023-06-27 17:56:03 +02:00
kkmuffme
9d1558b3ca make compressor configurable 
Fix https://github.com/vimeo/psalm/issues/9905
Suppress throws for igbinary_unserialize like it was done for @unserialize
 2023-06-18 20:22:02 +02:00
Jano Paetzold
bdca3144a0
Document classAndDescendants configuration tag 
As stated in #3286, this is still undocumented.
 2023-06-02 17:00:13 +02:00
RobChett
f491a53ff0 Document advanced array shape unsealing syntax 2023-05-14 10:15:34 +01:00
Jack Worman
f41da745d1 UnsupportedPropertyReferenceUsage 2023-05-12 14:12:12 -05:00
Mark McEver
dcafc2e53d Documented suggestions for HTML user input 2023-05-12 13:02:13 -05:00
RobChett
aa85669645 Change the Issue type and add documentation 2023-05-07 11:34:33 +01:00
RobChett
de877f1dcf Add support for @psalm-inheritors 2023-05-07 11:33:38 +01:00
orklah
a5effd2d2d
Merge pull request #9681 from robchett/no-seal-methods_and_no-seal-propeties 
Add support for @psalm-no-seal-properties and @psalm-no-seal-methods
 2023-05-02 19:20:34 +02:00
orklah
2a221f6359
Merge pull request #9706 from robchett/document_mixin 
Document @mixin
 2023-04-27 19:16:44 +02:00
Grégoire Paris
09dd8c370f
Make it easier to find how to promote Trace 
I have used this once before then forgot how to do it, which is a shame
because this is super handy.
 2023-04-26 21:41:24 +02:00
RobChett
1d45d22ebe Move @mixin examples to local documentation 2023-04-25 21:09:04 +01:00
RobChett
3503ccfe29 Fix dead links in documentation and fix typos 2023-04-25 07:44:29 +01:00
RobChett
662dc07df2 Add description of @mixin to the documentation 2023-04-25 07:44:29 +01:00
Jano Paetzold
d3a92f29a8 Replace @template T as X with @template T of X in documentation 
According to 1986c8b4a8 (r108961921), `as` is an alias to `of`. However, only `of` is documented (in docs/annotating_code/templated_annotations.md). That caused me confusion reading this.

I think as long as the alias is not documented, it's better to not use it in the docs. Even if it was documented, it would probably be better to not use aliases to avoid confusion.
 2023-04-24 16:04:28 +02:00
RobChett
4d9d7cebd9 Add support for @psalm-no-seal-properties and @psalm-no-seal-methods 2023-04-20 07:47:50 +01:00
Daniel Beardsley
bf00ecae91
Config: document default on new option 
Also add it to the config schema.
 2023-03-27 10:44:38 -07:00
Daniel Beardsley
5ff933f2a5
@property annotations: allow *not* implying @psalm-seal-properties 
Add a setting that allows usage of `@property` to *augment* classes that
use __get() and __set(). Previously, using `@property` once would force
you to exhaustively list all possible properties. This didn't use to be
the case, but was changed in df33405635

This was really unexpected for our team and for a while we thought it
was a psalm bug until I found the above commit.

We are using `__get()` for ORM objects and we want to use `@property` to
explicitly document some of columns without being forced to document
every column.
 2023-03-24 23:35:41 -07:00
Yannick Gottschalk
85a1c83591 Added to documentation and tests that api can be used instead of psalm-api 2023-03-20 13:34:44 +01:00
Yannick Gottschalk
a4895c3588 Added to documentation that psalm-api can be used on methods 2023-03-20 13:34:44 +01:00
Bruce Weirdan
98d96fbe9c
Forbid private final methods 
Fixes vimeo/psalm#8374
 2023-03-03 02:00:09 -04:00
Bruce Weirdan
eb63eddce1
Added a page explaining how to add a new issue type 2023-02-15 23:12:14 -04:00
Bruce Weirdan
e6aa63731d
Flag docblock parameters that have no counterparts in function signature 
Fixes vimeo/psalm#3166
 2023-02-15 22:04:26 -04:00
Bruce Weirdan
ee823619b8
Flag direct constructor calls 
Fixes vimeo/psalm#2975
 2023-02-15 20:14:00 -04:00
Bruce Weirdan
07dfb5f2aa
Update docs/running_psalm/issues/UnusedProperty.md 
Co-authored-by: Theodore Brown <theodorejb@outlook.com>
 2023-02-14 22:00:17 -04:00
Bruce Weirdan
38e15c9817
Added note on properties used in constructor only 
Fixes vimeo/psalm#7955
 2023-02-14 21:01:52 -04:00
Bruce Weirdan
085e8f6fb2
Forbid implementing some interfaces 
- `Throwable` can only be implemented when classes extend one of
  `Exception` or `Error`
- `UnitEnum` and `BackedEnum` cannot be implemented by user-defined
  classes

Refs vimeo/psalm#7722
 2023-02-12 02:48:50 -04:00
Bitwise Operators
9f07f5fe9a docs: Add entry to utility types mentioning using value-of<> with BackedEnum 2023-02-09 08:53:30 +01:00
Matthew Brown
d450b40da8
Remove some logic that didn't need to be there (#9209) 
* Remove check to see what breaks

* Simplify following logic

* Add tests from @kkmuffme‘s branch

* Reduce scope of fix

* Clean up logic a little

* Add failing test

* Improvements

* Fix for non-Paradoxical Condition result
 2023-02-03 21:08:16 -05:00
Bitwise Operators
a1ad738889 docs: Add information on pure-callables to documentation (see #9132) 2023-01-19 08:39:07 +01:00
Jack Worman
56f6dfecc8 Report unused baseline entries 2023-01-17 22:02:21 -05:00
Jack Worman
f9aa2d5ad3 Support constants in traits 2023-01-17 16:37:44 -05:00
maniaba
d9c66c93ca
Update ForbiddenCode.md 2023-01-13 11:21:34 +01:00
Daniil Gentili
0f7eed0dca fixes 2022-12-30 21:51:27 +01:00
Daniil Gentili
9b4857a606 Fix 2022-12-30 21:48:28 +01:00
Daniil Gentili
2a7043a7fb Fix remaining markdown header 2022-12-30 21:46:54 +01:00
orklah
406946d4c4
Merge pull request #9031 from danog/misc_fixes 
Misc fixes
 2022-12-30 21:28:11 +01:00
Daniil Gentili
9684be9d73 More markdown fixes 2022-12-30 21:02:59 +01:00
Daniil Gentili
0b67844420 Improve variable naming and improve docs 2022-12-30 21:00:38 +01:00
orklah
dbcfe62c52
Merge pull request #8987 from jack-worman/Always_check_unused_methods_and_properties 
Add @psalm-api annotation
 2022-12-28 15:20:48 +01:00
Jack Worman
f9e9aad990 restrictReturnTypes configuration 2022-12-24 11:25:56 -06:00
Jack Worman
703a1e1698 @psalm-api 2022-12-23 16:13:46 -06:00
David Schwarz / Ringsdorf
3e1dd8d190
doc: FilterIterator added to list of built-in templates. 2022-12-17 07:02:07 +01:00
Daniil Gentili
cca276768e
List refactoring v5 (#8820) 
* Squash

* Remove BC break

* Suppress

* Possibly fix

* Fixes

* Fix test

* Trigger build

* Update psl

* Update psl

* Fixes

* Fixes

* Cleanup

* fix

* Fix build

* Do not consider never when getting the max count

* Add assertion

* Cleanup

* Fix

* Cleanup
 2022-12-13 21:40:19 +01:00
Bruce Weirdan
19a1005bc3
Forbid most magic methods on enums 
Fixes vimeo/psalm#8889

Additionally this fixes case-sensitivity of
MethodSignatureMustOmitReturnType issue

Fixes vimeo/psalm#8888
 2022-12-12 03:03:20 -04:00
John Cornell
153f8224d1
Fixed typo 2022-12-08 14:42:56 -05:00
Barney Laurance
d6c7c86362 Remove unecassary subheadings in error levels documentation 2022-12-02 00:07:37 +00:00
Barney Laurance
cd18cdc554 Re-order list of errors in docs 
I think it makes more sense to have the errors that almost always appear
(level 7 errors) next to the errors that always appear, instead of
the level 1, least likely to appear errors being next to the ones that
always appear.

This also makes the order more similar to that output by the new
--by-issue-level format report.

Some time it might be nice to see if there's a way to auto generate most
of this docs page from the actual issue class definitions, or have
a test that checks the list of issues for each level is accurate and
complete.
 2022-12-02 00:04:43 +00:00