Add target for @psalm-suppress.

[rzvc]

I'm not sure if this has been brought up before (I searched, but nothing came up), so sorry if it's a duplicate.

I often find myself wanting to specify which variable/parameter/whatever I'm applying the suppression for. Preferably I would like to be able to do that all the time.

Consider a constructor that takes several parameters and one is unused. If @psalm-supress is used, it will suppress the issue for all other parameters too, even tho the other ones might not remain unused on purpose.

[AndrolGenhald]

I'm not sure, I wonder if it'd be better to allow the suppression to be applied more specifically instead like this. Are there cases where that wouldn't work?

[psalm-github-bot[bot]]

I found these snippets:

https://psalm.dev/r/821d4d3716

```php

[rzvc]

The only issue I have with that way of applying suppressions is that it makes the code more difficult to read, but otherwise it seems even more specific than the $target approach.

Maybe we can have both?

[AndrolGenhald]

The difficulty I see with having some sort of target is:

• It's currently allowed to have arbitrary descriptions after the issues list, we don't want to break existing suppressions because a description is retroactively parsed as a target
• How does it work when suppressing multiple issues (fyi, @psalm-suppress Issue1, Issue2, Issue3 is valid!), does it not work at all, apply to all issues, something else?
• How does the targeting actually work? I'd think we'd want this to be as generic as possible, so if you have takesInt(returnsFloat()) how do you target returnsFloat()? (this part seems likely to conflict with "descriptions are currently arbitrary", and I don't like just wrapping it in parentheses because I'm pretty sure I've seen descriptions for @psalm-suppress wrapped in parentheses...)

If you or someone else can find a way to do this while handling these issues well enough (perfection isn't possible here since the description is arbitrary, but as long as the vast majority of cases won't cause problems it should be ok) then it sounds cool, but I'm having trouble seeing how exactly it would work.

[weirdan]

Specifically for unused params / vars Psalm has an alternative shortcut: prefixing the variable name with underscore (https://psalm.dev/r/b3ec66ab6f)

[psalm-github-bot[bot]]

I found these snippets:

https://psalm.dev/r/b3ec66ab6f

```php

[rzvc]

• How does it work when suppressing multiple issues (fyi, @psalm-suppress Issue1, Issue2, Issue3 is valid!), does it not work at all, apply to all issues, something else?

Maybe something like this: @psalm-suppress Issue1:$target, Iussue2:function()?, Issue3 Some random comment.

This syntax would solve the function targeting too.

Edit: Also, if there are multiple targets for the same issue, I see no problem with parenthesis.

[AndrolGenhald]

Edit: Also, if there are multiple targets for the same issue, I see no problem with parenthesis.

For some reason I was caught up in having a space after the issue name, but for multiple instances of an issue I wonder if @psalm-suppress Issue1:$foo, Issue1:$bar would be better.

One issue that still exists is if the targeted code includes a comma, since that would interfere with the issue list parsing. We could just require that the target code is in parentheses (either in that case or for all cases), but then the parser is much more complicated since it can't just be an explode on ",".

[rzvc]

Unless you need something more sophisticated, this regex will parse all that:

/^[\t ]*@psalm-suppress
  ([\t ]+([a-z]\w*)
    (?:
     :(
       \$[a-z]\w*
       |
       [a-z]\w+(?4)
     )
     |
     (\((?:[^\(]|(?4))*?\))
    )?
    (?:,\s*(?1))?
  )?/gmix

https://regex101.com/r/GZ4QGP/2