add rules for debug statements in app/test/blade #23
Conversation
Treggats
force-pushed
the
feature/add-debug-statements-rules
branch
3 times, most recently
from
4ae502f to
cf65a3c
Compare
src/Rules/NoDebugInBlade.php
Outdated
| private static function hasDisallowedStatements(string $text): bool | ||
| { | ||
| return match (true) { | ||
| str_contains($text, '@dump') => true, |
There was a problem hiding this comment.
$text is the template, so using str_contains(..) to find currences. Can't, as far as I know, use an AST for this
tests/Rules/NoDebugInBladeTest.php
Outdated
| $this->analyse([__DIR__ . '/stubs/debug-in-view.blade.php'], [ | ||
| [ | ||
| 'No debug statements should be present in blade files.', | ||
| 1, |
There was a problem hiding this comment.
will always be on the first line, because of the str_contains(..)
Treggats
force-pushed
the
feature/add-debug-statements-rules
branch
from
1bf1ef5 to
9894194
Compare
Treggats
force-pushed
the
feature/add-debug-statements-rules
branch
3 times, most recently
from
db2c72f to
6b64e42
Compare
| count: 1 | ||
| path: tests/Rules/stubs/UseSpatieInvadeInsteadOfLivewire.php |
There was a problem hiding this comment.
stubs are no longer checked, so not needed anymore
| path: src/Rules/Debug/ChainedNoDebugInNamespaceRule.php | ||
|
|
||
| - | ||
| message: "#^Access to an undefined property PhpParser\\\\Node\\:\\:\\$name\\.$#" |
There was a problem hiding this comment.
PHPStan could not understand that the name property existed and I didn't how else to tell him that
| * @template T of Node | ||
| * @implements \PHPStan\Rules\Rule<T> | ||
| */ | ||
| abstract class BaseNoDebugRule implements Rule |
There was a problem hiding this comment.
base class with common methods over several classes
| */ | ||
| abstract class BaseNoDebugRule implements Rule | ||
| { | ||
| protected string $message; |
There was a problem hiding this comment.
holds the message (format) that PHPStan will report when errors are encountered
| { | ||
| protected string $message; | ||
|
|
||
| protected array $haystack = [ |
There was a problem hiding this comment.
default debug statements
|
|
||
| protected function hasDisallowedStatements(string|array $statement): bool | ||
| { | ||
| if (is_array($statement)) { |
There was a problem hiding this comment.
caters to both Blade and Namespace rules
| return null; | ||
| } | ||
|
|
||
| return match (strtolower($namespace)) { |
There was a problem hiding this comment.
allows re-use with different namespaces
| { | ||
| $this->haystack = [ | ||
| ...$this->haystack, | ||
| 'ddd', |
There was a problem hiding this comment.
expand on the default debug statements
Co-authored-by: Robert Boes <[email protected]>
Treggats
force-pushed
the
feature/add-debug-statements-rules
branch
from
6b64e42 to
91ef3d1
Compare
| return StaticCall::class; | ||
| } | ||
|
|
||
| public function processNode(Node $node, Scope $scope): array |
There was a problem hiding this comment.
This method is identical to the one in ChainedNoDebugInNamespaceRule. Maybe it's something that can be extracted to a parent class.
There was a problem hiding this comment.
I have thought of introducing a base class, as the lines 29-43 also are pretty much the same.
I chose not to for the sake of being explicit in what the rule does. I also like that I can see upon opening of this file what the checks are and what node is being processed
Sometimes you forget to remove debug statements. This PR adds rules to prevent or spot those occurences.