Add custom NoTopLevelDefineSniff sniff

Author: gmazzap

Inpsyde/Sniffs/CodeQuality/NoTopLevelDefineSniff.php

@@ -0,0 +1,52 @@
+<?php declare(strict_types=1); # -*- coding: utf-8 -*-
+/*
+ * This file is part of the php-coding-standards package.
+ *
+ * (c) Inpsyde GmbH
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Inpsyde\InpsydeCodingStandard\Sniffs\CodeQuality;
+
+use Inpsyde\InpsydeCodingStandard\Helpers;
+use PHP_CodeSniffer\Files\File;
+use PHP_CodeSniffer\Sniffs\Sniff;
+
+/**
+ * @package php-coding-standards
+ * @license http://opensource.org/licenses/MIT MIT
+ */
+final class NoTopLevelDefineSniff implements Sniff
+{
+    /**
+     * @return int[]
+     */
+    public function register()
+    {
+        return [T_STRING];
+    }
+
+    /**
+     * @param File $file
+     * @param int $position
+     */
+    public function process(File $file, $position)
+    {
+        $token = $file->getTokens()[$position];
+
+        if (($token['content'] ?? '') !== 'define'
+            || ($token['level'] ?? -1) !== 0
+            || !Helpers::isFunctionCall($file, $position)
+        ) {
+            return;
+        }
+
+        $file->addWarning(
+            'Do not use "define" for top-level constant definition. Prefer "const" instead.',
+            $position,
+            'Found'
+        );
+    }
+}

tests/fixtures/no-top-level-define.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace Inpsyde\InpsydeCodingStandard\Tests\Fixtures;
+
+// @phpcsSniff CodeQuality.NoTopLevelDefine
+
+if (!defined('X')) {
+    define('X', 1);
+}
+
+if (false) {
+    define('Y', 1);
+}
+
+// @phpcsWarningOnNextLine
+define('Z', 1);
+
+const ZZZ = 1;