Merge pull request #46 from tighten/adc/fix-forbidden-functions

Add custom `UseConfigOverEnv` sniff
tighten · Oct 21, 2022 · 624cd35 · 624cd35
2 parents 9bfd9ed + b971086
commit 624cd35
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 3 deletions.
diff --git a/standards/Tighten/Sniffs/PHP/UseConfigOverEnvSniff.php b/standards/Tighten/Sniffs/PHP/UseConfigOverEnvSniff.php
@@ -0,0 +1,12 @@
+<?php
+
+namespace Tighten\Sniffs\PHP;
+
+use PHP_CodeSniffer\Standards\Generic\Sniffs\PHP\ForbiddenFunctionsSniff;
+
+class UseConfigOverEnvSniff extends ForbiddenFunctionsSniff
+{
+    public $forbiddenFunctions = [
+        'env' => 'config',
+    ];
+}
diff --git a/standards/Tighten/ruleset.xml b/standards/Tighten/ruleset.xml
@@ -48,7 +48,6 @@
     </rule>
 
     <!-- No compact() and no 'dumps' -->
-    <!-- Use config() over env() -->
     <rule ref="Generic.PHP.ForbiddenFunctions">
         <properties>
             <property name="forbiddenFunctions" type="array">
@@ -57,10 +56,12 @@
                 <element key="dump" value="null"/>
                 <element key="var_dump" value="null"/>
                 <element key="ray" value="null"/>
-                <element key="env" value="config"/>
             </property>
         </properties>
-        <!-- This will also allow all other forbidden functions in confg directory -->
+    </rule>
+
+    <!-- Use config() over env() -->
+    <rule ref="Tighten.PHP.UseConfigOverEnv">
         <exclude-pattern>/config/*</exclude-pattern>
     </rule>