MC-19366: Adds a tokenizer for GraphQL schema files

Author: jean-bernard-valentaten

Magento2/ruleset.xml

@@ -3,7 +3,7 @@
     <description>Magento Coding Standard</description>
 
     <!-- File extensions to be checked. -->
-    <arg name="extensions" value="php,phtml"/>
+    <arg name="extensions" value="php,phtml,graphqls/GraphQL"/>
 
     <!-- Severity 10 errors: Critical code issues. -->
     <rule ref="Generic.Functions.CallTimePassByReference">
@@ -522,6 +522,10 @@
     <rule ref="Squiz.WhiteSpace.SuperfluousWhitespace.EmptyLines">
         <severity>0</severity>
     </rule>
+    <rule ref="Magento2.GraphQL.ValidTypeName">
+        <severity>6</severity>
+        <type>warning</type>
+    </rule>
 
     <!-- Severity 5 warnings: PHPDoc formatting and commenting issues. -->
     <rule ref="Magento2.Commenting.ClassAndInterfacePHPDocFormatting">

PHP_CodeSniffer/Tokenizers/GraphQL.php

@@ -0,0 +1,52 @@
+<?php
+/**
+ * Copyright © Magento. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+namespace PHP_CodeSniffer\Tokenizers;
+
+use PHP_CodeSniffer\Config;
+
+/**
+ * Implements a tokenizer for GraphQL files.
+ */
+class GraphQL extends JS
+{
+
+    protected $additionalTokenValues = [
+        'type'      => 'T_CLASS',
+        'interface' => 'T_CLASS',
+        'enum'      => 'T_CLASS',
+        '#'         => 'T_COMMENT',
+    ];
+
+    /**
+     * Constructor.
+     *
+     * @param string $content
+     * @param Config $config
+     * @param string $eolChar
+     * @throws \PHP_CodeSniffer\Exceptions\TokenizerException
+     */
+    public function __construct($content, Config $config, $eolChar = '\n')
+    {
+        //add our token values
+        $this->tokenValues = array_merge(
+            $this->tokenValues,
+            $this->additionalTokenValues
+        );
+
+        //let parent do its job (which will start tokenizing)
+        parent::__construct($content, $config, $eolChar);
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function processAdditional()
+    {
+        //NOP Does nothing intentionally
+    }
+
+}

composer.json

@@ -14,6 +14,11 @@
     "require-dev": {
         "phpunit/phpunit": "^4.0 || ^5.0 || ^6.0 || ^7.0"
     },
+    "autoload": {
+        "classmap": [
+            "PHP_CodeSniffer/Tokenizers/"
+        ]
+    },
     "scripts": {
         "post-install-cmd": "vendor/bin/phpcs --config-set installed_paths ../../..",
         "post-update-cmd": "vendor/bin/phpcs --config-set installed_paths ../../.."