✨ Banned Functions Rule

Author: martinsoenen

README.md

@@ -47,6 +47,12 @@ For all available options, please take a look at the PHPStan documentation: **ht
 
 ## Rules
 
+### Banned Functions Rule
+
+*Identifier : xefi.bannedFunctions*
+
+Ensure banned functions like `dd()` are not called.
+
 ### Boolean Property Naming Rule
 
 *Identifier : xefi.booleanPropertyNaming*

extension.neon

@@ -1,4 +1,5 @@
 rules:
+    - Xefi\PHPStanRules\Rules\BannedFunctionsRule
     - Xefi\PHPStanRules\Rules\BooleanPropertyNamingRule
     - Xefi\PHPStanRules\Rules\MaxLinePerClassRule
     - Xefi\PHPStanRules\Rules\MaxLinePerMethodRule

src/Rules/BannedFunctionsRule.php

@@ -0,0 +1,40 @@
+<?php
+
+namespace Xefi\PHPStanRules\Rules;
+
+use PhpParser\Node;
+use PhpParser\Node\Name;
+use PHPStan\Analyser\Scope;
+use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleErrorBuilder;
+
+class BannedFunctionsRule implements Rule
+{
+    const BANNED_FUNCTIONS = ['dd'];
+
+    public function getNodeType(): string
+    {
+        return Node\Expr\FuncCall::class;
+    }
+
+    public function processNode(Node $node, Scope $scope): array
+    {
+        $errors = [];
+
+        if (! $node->name instanceof Name) {
+            return [];
+        }
+
+        $functionName = $node->name->toString();
+
+        if (in_array($functionName, self::BANNED_FUNCTIONS, true)) {
+            $errors[] = RuleErrorBuilder::message(
+                sprintf('Method %s() is prohibited. Remove it or write in the logs using `Log::debug()` instead.', $functionName)
+            )
+            ->identifier('xefi.bannedFunctions')
+            ->build();
+        }
+
+        return $errors;
+    }
+}

tests/Rules/BannedFunctionsRuleTest.php

@@ -0,0 +1,28 @@
+<?php declare(strict_types = 1);
+
+namespace Xefi\PHPStanRules\Tests\Rules;
+
+use Xefi\PHPStanRules\Rules\BannedFunctionsRule;
+use PHPStan\Rules\Rule;
+use PHPStan\Testing\RuleTestCase;
+
+/**
+ * @extends RuleTestCase<BannedFunctionsRule>
+ */
+class BannedFunctionsRuleTest extends RuleTestCase
+{
+    protected function getRule(): Rule
+    {
+        return new BannedFunctionsRule();
+    }
+
+    public function testRuleDetectsBannedFunctions(): void
+    {
+        $this->analyse([__DIR__ . '/data/BannedFunctionsRule/BannedFunctionsClass.php'], [
+            [
+                'Method dd() is prohibited. Remove it or write in the logs using `Log::debug()` instead.',
+                3
+            ],
+        ]);
+    }
+}

tests/Rules/data/BannedFunctionsRule/BannedFunctionsClass.php

@@ -0,0 +1,5 @@
+<?php
+
+dd('stop');
+array_merge(['a'], ['b']);
+echo 'test';