MC-19366: Adds sniff for type names

Author: jean-bernard-valentaten

Magento2/Sniffs/GraphQL/ValidTypeNameSniff.php

@@ -0,0 +1,32 @@
+<?php
+/**
+ * Copyright © Magento. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+namespace Magento2\Sniffs\GraphQL;
+
+use PHP_CodeSniffer\Standards\Squiz\Sniffs\Classes\ValidClassNameSniff;
+
+/**
+ * Detects types (<kbd>type</kbd>, <kbd>interface</kbd> and <kbd>enum</kbd>) that are not specified in
+ * <kbd>UpperCamelCase</kbd>.
+ */
+class ValidTypeNameSniff extends ValidClassNameSniff
+{
+
+    /**
+     * Defines the tokenizers that this sniff is using.
+     *
+     * @var array
+     */
+    public $supportedTokenizers = ['GraphQL'];
+
+    /**
+     * @inheritDoc
+     */
+    public function register()
+    {
+        return [T_CLASS];
+    }
+
+}

Magento2/Tests/GraphQL/ValidTypeNameUnitTest.graphqls

@@ -0,0 +1,44 @@
+# Valid type names.
+type ValidCamelCaseType {}
+interface ValidCamelCaseInterface {}
+enum ValidCamelCaseEnum {}
+
+# Incorrect usage of camel case.
+type invalidCamelCaseType {}
+type Invalid_Camel_Case_Type_With_Underscores {}
+interface invalidCamelCaseInterface {}
+interface Invalid_Camel_Case_Interface_With_Underscores {}
+enum invalidCamelCaseEnum {}
+enum Invalid_Camel_Case_Enum_With_Underscores {}
+
+# All lowercase
+type invalidlowercasetype {}
+interface invalidlowercaseinterface {}
+enum invalidlowercaseenum {}
+
+# All uppercase
+type VALIDUPPERCASETYPE {}
+type INVALID_UPPERCASE_TYPE_WITH_UNDERSCORES {}
+interface VALIDUPPERCASEINTERFACE {}
+interface INVALID_UPPERCASE_INTERFACE_WITH_UNDERSCORES {}
+enum VALIDUPPERCASECENUM {}
+enum INVALID_UPPERCASE_ENUM_WITH_UNDERSCORES {}
+
+# Mix camel case with uppercase
+type ValidCamelCaseTypeWITHUPPERCASE {}
+interface ValidCamelCaseInterfaceWITHUPPERCASE {}
+enum ValidCamelCaseEnumWITHUPPERCASE {}
+
+# Usage of numeric characters
+type ValidCamelCaseTypeWith1Number {}
+type ValidCamelCaseTypeWith12345Numbers {}
+type 5InvalidCamelCaseTypeStartingWithNumber {}
+type ValidCamelCaseTypeEndingWithNumber4 {}
+interface ValidCamelCaseInterfaceWith1Number {}
+interface ValidCamelCaseInterfaceWith12345Numbers {}
+interface 5InvalidCamelCaseInterfaceStartingWithNumber {}
+interface ValidCamelCaseInterfaceEndingWithNumber4 {}
+enum ValidCamelCaseEnumWith1Number {}
+enum ValidCamelCaseEnumWith12345Numbers {}
+enum 5InvalidCamelCaseEnumStartingWithNumber {}
+enum ValidCamelCaseEnumEndingWithNumber4 {}

Magento2/Tests/GraphQL/ValidTypeNameUnitTest.php

@@ -0,0 +1,77 @@
+<?php
+/**
+ * Copyright © Magento. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+namespace Magento2\Tests\GraphQL;
+
+use PHP_CodeSniffer\Config;
+use PHP_CodeSniffer\Tests\Standards\AbstractSniffUnitTest;
+
+/**
+ * Covers {@link \agento2\Sniffs\GraphQL\ValidTypeNameSniff}.
+ */
+class ValidTypeNameUnitTest extends AbstractSniffUnitTest
+{
+
+    protected function setUp()
+    {
+        //let parent do its job
+        parent::setUp();
+
+        //generate a config that allows ro use our GraphQL tokenizer
+        $config = new Config();
+        $config->extensions = array_merge(
+            $config->extensions,
+            [
+                'graphqls' => 'GraphQL'
+            ]
+        );
+
+        //and write back to a global that is used in base class
+        $GLOBALS['PHP_CODESNIFFER_CONFIG'] = $config;
+    }
+
+    /**
+     * Returns the lines where errors should occur.
+     *
+     * The key of the array should represent the line number and the value
+     * should represent the number of errors that should occur on that line.
+     *
+     * @return array<int, int>
+     */
+    protected function getErrorList()
+    {
+        return [
+            7 => 1,
+            8 => 1,
+            9 => 1,
+            10 => 1,
+            11 => 1,
+            12 => 1,
+            15 => 1,
+            16 => 1,
+            17 => 1,
+            21 => 1,
+            23 => 1,
+            25 => 1,
+            35 => 1,
+            39 => 1,
+            43 => 1,
+        ];
+    }
+
+    /**
+     * Returns the lines where warnings should occur.
+     *
+     * The key of the array should represent the line number and the value
+     * should represent the number of warnings that should occur on that line.
+     *
+     * @return array<int, int>
+     */
+    protected function getWarningList()
+    {
+        return [];
+    }
+}
+