add custom enum sniff

Author: LordSimal

CakePHP/Sniffs/NamingConventions/ValidEnumNameSniff.php

@@ -0,0 +1,46 @@
+<?php
+/**
+ * CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
+ * Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
+ *
+ * Licensed under The MIT License
+ * For full copyright and license information, please see the LICENSE.txt
+ * Redistributions of files must retain the above copyright notice.
+ *
+ * @copyright     Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
+ * @link          https://github.com/cakephp/cakephp-codesniffer
+ * @since         CakePHP CodeSniffer 0.1.10
+ * @license       https://www.opensource.org/licenses/mit-license.php MIT License
+ */
+
+/**
+ * Ensures enum names use the Enum suffix.
+ */
+namespace CakePHP\Sniffs\NamingConventions;
+
+use PHP_CodeSniffer\Files\File;
+use PHP_CodeSniffer\Sniffs\Sniff;
+
+class ValidEnumNameSniff implements Sniff
+{
+    /**
+     * @inheritDoc
+     */
+    public function register()
+    {
+        return [T_ENUM];
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function process(File $phpcsFile, $stackPtr)
+    {
+        $enumName = $phpcsFile->getDeclarationName($stackPtr);
+
+        if (!str_ends_with($enumName, 'Enum')) {
+            $error = 'Enums must have an "Enum" suffix.';
+            $phpcsFile->addError($error, $stackPtr, 'InvalidEnumName');
+        }
+    }
+}

CakePHP/Sniffs/NamingConventions/ValidTraitNameSniff.php

@@ -39,7 +39,7 @@ public function process(File $phpcsFile, $stackPtr)
         $tokens = $phpcsFile->getTokens();
         $traitName = $tokens[$stackPtr + 2]['content'];
 
-        if (substr($traitName, -5) !== 'Trait') {
+        if (!str_ends_with($traitName, 'Trait')) {
             $error = 'Traits must have a "Trait" suffix.';
             $phpcsFile->addError($error, $stackPtr, 'InvalidTraitName');
         }

CakePHP/Tests/NamingConventions/ValidEnumNameUnitTest.inc

@@ -0,0 +1,8 @@
+<?php
+enum Status: string {
+    case Draft = 'draft';
+}
+
+enum StatusEnum: string {
+    case Published = 'published';
+}

CakePHP/Tests/NamingConventions/ValidEnumNameUnitTest.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace CakePHP\Tests\NamingConventions;
+
+use PHP_CodeSniffer\Tests\Standards\AbstractSniffTestCase;
+
+class ValidEnumNameUnitTest extends AbstractSniffTestCase
+{
+    /**
+     * @inheritDoc
+     */
+    public function getErrorList()
+    {
+        return [
+            2 => 1,
+        ];
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function getWarningList()
+    {
+        return [];
+    }
+}