style(phpcs): Enable DrupalPractice coding standard checking (#1074)

Author: Dylan203

examples/graphql_composable/graphql_composable.info.yml

@@ -6,3 +6,4 @@ core: 8.x
 dependencies:
   - graphql:graphql
   - node:node
+core_version_requirement: ^8 || ^9

examples/graphql_example/graphql_examples.info.yml

@@ -6,3 +6,4 @@ core: 8.x
 dependencies:
   - graphql:graphql
   - node:node
+core_version_requirement: ^8 || ^9

phpcs.xml.dist

@@ -6,6 +6,22 @@
   <arg name="extensions" value="inc,install,module,php,profile,test,theme,yml"/>
 
   <rule ref="Drupal"></rule>
+  <rule ref="DrupalPractice"></rule>
+
+  <!-- TODO: check if we can fix those reported errors in code-->
+  <rule ref="DrupalPractice.CodeAnalysis.VariableAnalysis.UnusedVariable">
+    <exclude-pattern>src/Plugin/GraphQL/DataProducer/DataProducerProxy.php</exclude-pattern>
+    <exclude-pattern>src/Plugin/GraphQL/DataProducer/Field/EntityReference.php</exclude-pattern>
+    <exclude-pattern>src/Plugin/GraphQL/DataProducer/Routing/RouteEntity.php</exclude-pattern>
+    <exclude-pattern>src/Plugin/GraphQL/DataProducer/Entity/EntityLoadMultiple.php</exclude-pattern>
+    <exclude-pattern>src/Plugin/GraphQL/DataProducer/Entity/EntityLoad.php</exclude-pattern>
+    <exclude-pattern>tests/src/Kernel/DataProducer/MenuTest.php</exclude-pattern>
+  </rule>
+
+  <rule ref="DrupalPractice.CodeAnalysis.VariableAnalysis.UndefinedVariable">
+    <exclude-pattern>src/Plugin/GraphQL/DataProducer/Field/EntityReference.php</exclude-pattern>
+    <exclude-pattern>tests/src/Kernel/DataProducer/MenuTest.php</exclude-pattern>
+  </rule>
 
   <!-- TODO: those rules are disabled for now until we fix the coding standards for them. -->
   <rule ref="Drupal.Commenting.ClassComment.Missing">

src/Form/ServerForm.php

@@ -102,10 +102,10 @@ public function form(array $form, FormStateInterface $formState) {
     }
 
     $form['label'] = [
-      '#title' => t('Label'),
+      '#title' => $this->t('Label'),
       '#type' => 'textfield',
       '#default_value' => $server->label(),
-      '#description' => t('The human-readable name of this server.'),
+      '#description' => $this->t('The human-readable name of this server.'),
       '#required' => TRUE,
       '#size' => 30,
     ];
@@ -118,15 +118,15 @@ public function form(array $form, FormStateInterface $formState) {
         'exists' => ['Drupal\graphql\Entity\Server', 'load'],
         'source' => ['label'],
       ],
-      '#description' => t('A unique machine-readable name for this server. It must only contain lowercase letters, numbers, and underscores.'),
+      '#description' => $this->t('A unique machine-readable name for this server. It must only contain lowercase letters, numbers, and underscores.'),
     ];
 
     $form['schema'] = [
-      '#title' => t('Schema'),
+      '#title' => $this->t('Schema'),
       '#type' => 'select',
       '#options' => $schemas,
       '#default_value' => $schema,
-      '#description' => t('The schema to use with this server.'),
+      '#description' => $this->t('The schema to use with this server.'),
       '#ajax' => [
         'callback' => '::ajaxSchemaConfigurationForm',
         'progress' => [
@@ -158,34 +158,34 @@ public function form(array $form, FormStateInterface $formState) {
     }
 
     $form['endpoint'] = [
-      '#title' => t('Endpoint'),
+      '#title' => $this->t('Endpoint'),
       '#type' => 'textfield',
       '#default_value' => $server->get('endpoint'),
-      '#description' => t('The endpoint for http queries. Has to start with a forward slash. For example "/graphql".'),
+      '#description' => $this->t('The endpoint for http queries. Has to start with a forward slash. For example "/graphql".'),
       '#required' => TRUE,
       '#size' => 30,
       '#field_prefix' => $this->requestContext->getCompleteBaseUrl(),
     ];
 
     $form['batching'] = [
-      '#title' => t('Allow query batching'),
+      '#title' => $this->t('Allow query batching'),
       '#type' => 'checkbox',
       '#default_value' => !!$server->get('batching'),
-      '#description' => t('Whether batched queries are allowed.'),
+      '#description' => $this->t('Whether batched queries are allowed.'),
     ];
 
     $form['caching'] = [
-      '#title' => t('Enable caching'),
+      '#title' => $this->t('Enable caching'),
       '#type' => 'checkbox',
       '#default_value' => !!$server->get('caching'),
-      '#description' => t('Whether caching of queries and partial results is enabled.'),
+      '#description' => $this->t('Whether caching of queries and partial results is enabled.'),
     ];
 
     $form['debug'] = [
-      '#title' => t('Enable debugging'),
+      '#title' => $this->t('Enable debugging'),
       '#type' => 'checkbox',
       '#default_value' => !!$server->get('debug'),
-      '#description' => t('In debugging mode, error messages contain more verbose information in the query response.'),
+      '#description' => $this->t('In debugging mode, error messages contain more verbose information in the query response.'),
     ];
 
     $form['actions'] = [

src/Plugin/GraphQL/DataProducer/DataProducerProxy.php

@@ -14,8 +14,8 @@
 use Drupal\graphql\Plugin\DataProducerPluginCachingInterface;
 use Drupal\graphql\Plugin\DataProducerPluginInterface;
 use Drupal\graphql\Plugin\DataProducerPluginManager;
-use GraphQL\Type\Definition\ResolveInfo;
 use Symfony\Component\HttpFoundation\RequestStack;
+use GraphQL\Type\Definition\ResolveInfo;
 
 /**
  * Data producers proxy class.

src/Plugin/GraphQL/DataProducer/Entity/EntityRendered.php

@@ -11,7 +11,6 @@
 use Drupal\Core\Render\RendererInterface;
 use Drupal\graphql\GraphQL\Execution\ResolveContext;
 use Drupal\graphql\Plugin\GraphQL\DataProducer\DataProducerPluginBase;
-use GraphQL\Type\Definition\ResolveInfo;
 use Symfony\Component\DependencyInjection\ContainerInterface;
 
 /**

src/Plugin/GraphQL/DataProducer/Routing/RouteLoad.php

@@ -6,7 +6,6 @@
 use Drupal\Core\Path\PathValidatorInterface;
 use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
 use Drupal\graphql\Plugin\GraphQL\DataProducer\DataProducerPluginBase;
-use Drupal\redirect\RedirectRepository;
 use Symfony\Component\DependencyInjection\ContainerInterface;
 
 /**

src/Plugin/GraphQL/Schema/ComposableSchema.php

@@ -7,6 +7,7 @@
 use Drupal\Core\Form\FormStateInterface;
 use Drupal\Core\Plugin\PluginFormInterface;
 use Drupal\graphql\GraphQL\ResolverRegistry;
+use Drupal\Core\StringTranslation\StringTranslationTrait;
 
 /**
  * @Schema(
@@ -15,6 +16,7 @@
  * )
  */
 class ComposableSchema extends SdlSchemaPluginBase implements ConfigurableInterface, PluginFormInterface {
+  use StringTranslationTrait;
 
   /**
    * {@inheritdoc}
@@ -76,7 +78,7 @@ public function buildConfigurationForm(array $form, FormStateInterface $form_sta
     $form['extensions'] = [
       '#type' => 'checkboxes',
       '#required' => FALSE,
-      '#title' => t('Enabled extensions'),
+      '#title' => $this->t('Enabled extensions'),
       '#options' => [],
       '#default_value' => $this->configuration['extensions'] ?? [],
     ];

tests/modules/graphql_persisted_queries_test/graphql_persisted_queries_test.info.yml

@@ -5,4 +5,4 @@ package: Testing
 core: 8.x
 hidden: TRUE
 dependencies:
-  - graphql
+  - graphql:graphql