Disable/Suppress diagnostic for specific line?

[braxtons12]

Is there any way to suppress one of phpactor's built-in diagnostics, but only for a specific line?

there are times when phpactor will give a diagnostic for e.g. "worse.missing_member" because it doesn't understand the generic context like other analysis tools like psalm or PHPStan would, but I don't want to disable the diagnostic globally, just in the specific location.

E.g. how phpstan has /** @phpstan-ignore <diagnostic name> */ and psalm has /** @psalm-suppress <diagnostic name> */

[dantleech]

Not currently no, but not sure that's a great idea as it introduces IDE specific annotations into a shared codebase that's agnostic of the IDE

[braxtons12]

This is how every other static analysis tool for every language out there works today.

clang-tidy, clang-format, eslint, phpstan, psalm, sonar lint, clippy, etc.

It causes no harm to anyone working on the codebase not using those tools (although I would argue if a project is using static analysis tools, then every engineer working on it should also be using those tools), and gives engineers using them the capability to suppress false-positives when they come up.

[dantleech]

I'd argue that those tools are integral to a project, where as the IDE you are using is a developer choice. Phpactor's diagnostics are primarily to draw attention to problems fixable with code actions. It is not there to prove the correctness of your code.

You can disable Phpactor's diagnostics, specifically or globally and depend on f.e. the PHPStan integration while still benefiting from code actions.

So I'd be disinclined to introduce an /** @phpactor-ignore */ annotation, because Phpactors diagnostics should never be blocking and I'd personally not see /** @phpstactor-ignore @phpstan-ignore-next-line @psalm-surpress */ if that would even work 😅

[braxtons12]

So I'd be disinclined to introduce an /** @phpactor-ignore / annotation, because Phpactors diagnostics should never be blocking and I'd personally not see /* @phpstactor-ignore @phpstan-ignore-next-line @psalm-surpress */ if that would even work 😅

Yeah this is not about phpactor diagnostics being blocking/nonblocking w.r.t. to code review, CI or anything like that, nor is it about using phpactor's diagnostics to prove correctness, and disabling a single diagnostic (or all diagnostics) globally is not the right solution either, because just because a particular diagnostic is a false positive in one specific location does not mean it should be disabled across the board.

The goal here is to be able to suppress specific isolated occurrences so that when someone using phpactor in the project sees a red/orange squiggly, they know it's something they should actually look at, and similarly, don't waste time looking at a diagnostic that isn't correct (because it has been suppressed with the hypothetical annotation).

[nickkadutskyi]

I have the same issue.
In Laravel I am using Query Scopes where I will add a method on a model that will attach additional conditions to the query. This method then will be accessible on corresponding query builder for that model. This uses a lot of magic and confuses all the tooling, and I wouldn't use this unless there were some repository implementation in Laravel.

For such case it would be cool to suppress such warnings.

Here is some code with the same behavior but different errors.

Simple example:
phpactor: Method "current" does not exist on class "Illuminate\Database\Eloquent\Relations\HasMany" [worse.missing_member]

        $currentSchedule = $accessPoint
            ->schedules()
            ->current($accessPoint->timezone)
            ->first();

Expanded example:
phpactor: Method "current" does not exist on class "Illuminate\Database\Eloquent\Builder" [worse.missing_member]

        $currentSchedule = $accessPoint
            ->schedules()->where(
                function (Builder $query) use ($accessPoint) {
                    $query->current($accessPoint->timezone);
                }
            )
            ->first();