CS updates adding rules with properties to phpcs.xml.dist.

paul-m · paul-m · commit f1ae71d60b10 · 2018-07-18T20:09:59.000-07:00
diff --git a/block_example/src/Controller/BlockExampleController.php b/block_example/src/Controller/BlockExampleController.php
@@ -3,6 +3,7 @@
 namespace Drupal\block_example\Controller;
 
 use Drupal\examples\Utility\DescriptionTemplateTrait;
+
 /**
  * Controller routines for block example routes.
  */
diff --git a/cache_example/src/Form/CacheExampleForm.php b/cache_example/src/Form/CacheExampleForm.php
@@ -11,7 +11,6 @@
 use Symfony\Component\DependencyInjection\ContainerInterface;
 use Symfony\Component\HttpFoundation\RequestStack;
 
-
 /**
  * Form with examples on how to use cache.
  */
diff --git a/content_entity_example/src/Form/ContactSettingsForm.php b/content_entity_example/src/Form/ContactSettingsForm.php
@@ -11,6 +11,7 @@
  * @ingroup content_entity_example
  */
 class ContactSettingsForm extends FormBase {
+
   /**
    * Returns a unique string identifying the form.
    *
diff --git a/email_example/tests/src/Functional/EmailExampleTest.php b/email_example/tests/src/Functional/EmailExampleTest.php
@@ -5,7 +5,6 @@
 use Drupal\Core\Test\AssertMailTrait;
 use Drupal\Tests\examples\Functional\ExamplesBrowserTestBase;
 
-
 /**
  * Tests for the email_example module.
  *
diff --git a/field_example/src/Plugin/Field/FieldType/RgbItem.php b/field_example/src/Plugin/Field/FieldType/RgbItem.php
@@ -19,6 +19,7 @@
  * )
  */
 class RgbItem extends FieldItemBase {
+
   /**
    * {@inheritdoc}
    */
diff --git a/field_example/tests/src/Functional/FieldExampleMenuTest.php b/field_example/tests/src/Functional/FieldExampleMenuTest.php
@@ -2,7 +2,6 @@
 
 namespace Drupal\Tests\field_example\Functional;
 
-
 /**
  * Test the user-facing menus in Field Example.
  *
diff --git a/field_permission_example/css/field_permission_example.css b/field_permission_example/css/field_permission_example.css
@@ -3,18 +3,18 @@
  * CSS for Field Example.
  */
 .stickynote {
-    background: #fefabc;
-    padding: 0.8em;
-    font-family: cursive;
-    font-size: 1.1em;
-    color: #def9ff;
-    width: 15em;
-    -moz-transform: rotate(2deg);
-    -webkit-transform: rotate(2deg);
-    -o-transform: rotate(2deg);
-    -ms-transform: rotate(2deg);
-    transform: rotate(2deg);
-    -moz-box-shadow: 0 4px 6px #333;
-    -webkit-box-shadow: 0 4px 6px #333;
-    box-shadow: 0 4px 6px #333;
+  background: #fefabc;
+  padding: 0.8em;
+  font-family: cursive;
+  font-size: 1.1em;
+  color: #def9ff;
+  width: 15em;
+  -moz-transform: rotate(2deg);
+  -webkit-transform: rotate(2deg);
+  -o-transform: rotate(2deg);
+  -ms-transform: rotate(2deg);
+  transform: rotate(2deg);
+  -moz-box-shadow: 0 4px 6px #333;
+  -webkit-box-shadow: 0 4px 6px #333;
+  box-shadow: 0 4px 6px #333;
 }
diff --git a/field_permission_example/field_permission_example.module b/field_permission_example/field_permission_example.module
@@ -153,7 +153,6 @@ function field_permission_example_entity_field_access($operation, FieldDefinitio
   return AccessResult::forbidden();
 }
 
-
 /**
  * Implements hook_ENTITY_TYPE_access().
  *
@@ -176,6 +175,7 @@ function field_permission_example_entity_test_access(EntityInterface $entity, $o
   }
   return AccessResult::neutral();
 }
+
 /**
  * @} End of "defgroup field_permission_example".
  */
diff --git a/field_permission_example/src/Controller/FieldPermissionExampleController.php b/field_permission_example/src/Controller/FieldPermissionExampleController.php
@@ -4,6 +4,7 @@
 
 use Drupal\Core\Controller\ControllerBase;
 use Drupal\Core\Link;
+
 /**
  * Controller routines for field permission example routes.
  */
diff --git a/field_permission_example/src/Plugin/Field/FieldType/FieldNote.php b/field_permission_example/src/Plugin/Field/FieldType/FieldNote.php
@@ -19,6 +19,7 @@
  * )
  */
 class FieldNote extends FieldItemBase {
+
   /**
    * {@inheritdoc}
    */
diff --git a/js_example/css/jsweights.css b/js_example/css/jsweights.css
@@ -1,4 +1,4 @@
 .js-weights div {
-    font-size: 20px;
-    font-weight: bold;
+  font-size: 20px;
+  font-weight: bold;
 }
diff --git a/js_example/tests/src/Functional/JsExampleTest.php b/js_example/tests/src/Functional/JsExampleTest.php
@@ -1,6 +1,7 @@
 <?php
 
 namespace Drupal\Tests\js_example\Functional;
+
 use Drupal\Tests\examples\Functional\ExamplesBrowserTestBase;
 
 /**
diff --git a/menu_example/src/Routing/MenuExampleDynamicRoutes.php b/menu_example/src/Routing/MenuExampleDynamicRoutes.php
@@ -33,7 +33,7 @@ public function routes() {
     ];
 
     foreach ($tabs as $path => $title) {
-      $machine_name = 'examples.menu_example.'. str_replace('/', '_', $path);
+      $machine_name = 'examples.menu_example.' . str_replace('/', '_', $path);
       $routes[$machine_name] = new Route(
         // Path to attach this route to:
         '/examples/menu-example/' . $path,
diff --git a/node_type_example/tests/src/Functional/NodeTypeExampleTest.php b/node_type_example/tests/src/Functional/NodeTypeExampleTest.php
@@ -154,7 +154,6 @@ public function testNodeCreation() {
     $this->assertText($body);
   }
 
-
   /**
    * Verify that user can uninstall and then reinstall node_type_example.
    */
diff --git a/phpcs.xml.dist b/phpcs.xml.dist
@@ -12,14 +12,14 @@
   <rule ref="Drupal.CSS"/>
   <rule ref="Drupal.Classes"/>
   <rule ref="Drupal.Commenting">
-      <exclude name="Drupal.Commenting.DocComment.MissingShort"/>
-      <!-- TagsNotGrouped has false positives for @code/@endcode. See
-        https://www.drupal.org/node/2502837 -->
-      <exclude name="Drupal.Commenting.DocComment.TagsNotGrouped"/>
-      <!-- We have to document hooks in a non-standard way in order to be
+    <exclude name="Drupal.Commenting.DocComment.MissingShort"/>
+    <!-- TagsNotGrouped has false positives for @code/@endcode. See
+         https://www.drupal.org/node/2502837 -->
+    <exclude name="Drupal.Commenting.DocComment.TagsNotGrouped"/>
+    <!-- We have to document hooks in a non-standard way in order to be
         informative -->
-      <exclude name="Drupal.Commenting.HookComment.HookParamDoc"/>
-      <exclude name="Drupal.Commenting.HookComment.HookReturnDoc"/>
+    <exclude name="Drupal.Commenting.HookComment.HookParamDoc"/>
+    <exclude name="Drupal.Commenting.HookComment.HookReturnDoc"/>
   </rule>
   <rule ref="Drupal.ControlStructures"/>
   <rule ref="Drupal.Files"/>
@@ -30,11 +30,25 @@
   <rule ref="Drupal.Semantics"/>
   <rule ref="Drupal.Strings"/>
   <rule ref="Drupal.WhiteSpace"/>
+  <rule ref="Drupal.Files.TxtFileLineLength.TooLong"/>
 
-  <rule ref="Generic.Files.LineEndings"/>
+  <rule ref="Generic.CodeAnalysis.UselessOverridingMethod">
+    <!-- We exclude this rule so that we can demonstrate where to add your own
+         validation code to a form. -->
+    <exclude name="Generic.CodeAnalysis.UselessOverridingMethod.Found"/>
+  </rule>
+  <rule ref="Generic.Files.LineEndings">
+    <properties>
+      <property name="eolChar" value="\n"/>
+    </properties>
+  </rule>
   <rule ref="Generic.Formatting.SpaceAfterCast"/>
   <rule ref="Generic.Functions.FunctionCallArgumentSpacing"/>
-  <rule ref="Generic.Functions.OpeningFunctionBraceKernighanRitchie"/>
+  <rule ref="Generic.Functions.OpeningFunctionBraceKernighanRitchie">
+    <properties>
+      <property name="checkClosures" value="true"/>
+    </properties>
+  </rule>
   <rule ref="Generic.PHP.DeprecatedFunctions"/>
   <rule ref="Generic.PHP.DisallowShortOpenTag"/>
   <rule ref="Generic.PHP.LowerCaseKeyword"/>
@@ -44,21 +58,44 @@
   <rule ref="MySource.Debug.DebugCode"/>
 
   <rule ref="PSR2.Classes.PropertyDeclaration"/>
+  <rule ref="PSR2.Namespaces.NamespaceDeclaration.BlankLineAfter"/>
+  <rule ref="PSR2.Namespaces.UseDeclaration.SpaceAfterLastUse"/>
 
   <rule ref="Squiz.Arrays.ArrayBracketSpacing"/>
   <rule ref="Squiz.CSS.ClassDefinitionOpeningBraceSpace"/>
   <rule ref="Squiz.CSS.ColonSpacing"/>
   <rule ref="Squiz.CSS.DisallowMultipleStyleDefinitions"/>
   <rule ref="Squiz.CSS.EmptyClassDefinition"/>
   <rule ref="Squiz.CSS.EmptyStyleDefinition"/>
+  <rule ref="Squiz.CSS.Indentation">
+    <properties>
+      <property name="indent" value="2"/>
+    </properties>
+  </rule>
   <rule ref="Squiz.CSS.MissingColon"/>
   <rule ref="Squiz.CSS.SemicolonSpacing"/>
   <rule ref="Squiz.Commenting.DocCommentAlignment"/>
   <rule ref="Squiz.ControlStructures.ForEachLoopDeclaration"/>
   <rule ref="Squiz.ControlStructures.ForLoopDeclaration"/>
+  <rule ref="Squiz.Functions.FunctionDeclarationArgumentSpacing">
+    <properties>
+      <property name="equalsSpacing" value="1"/>
+    </properties>
+  </rule>
   <rule ref="Squiz.PHP.LowercasePHPFunctions"/>
   <rule ref="Squiz.PHP.NonExecutableCode"/>
   <rule ref="Squiz.Scope.MethodScope"/>
+  <rule ref="Squiz.Strings.ConcatenationSpacing">
+    <properties>
+      <property name="spacing" value="1"/>
+      <property name="ignoreNewlines" value="true"/>
+    </properties>
+  </rule>
+  <rule ref="Squiz.WhiteSpace.FunctionSpacing">
+    <properties>
+      <property name="spacing" value="1"/>
+    </properties>
+  </rule>
   <rule ref="Squiz.WhiteSpace.LanguageConstructSpacing"/>
 
   <rule ref="Squiz.WhiteSpace.SemicolonSpacing"/>
diff --git a/phpunit_example/src/DisplayManager.php b/phpunit_example/src/DisplayManager.php
@@ -2,7 +2,6 @@
 
 namespace Drupal\phpunit_example;
 
-
 /**
  * An example class to demonstrate unit testing.
  *
diff --git a/phpunit_example/src/ProtectedPrivates.php b/phpunit_example/src/ProtectedPrivates.php
@@ -2,7 +2,6 @@
 
 namespace Drupal\phpunit_example;
 
-
 /**
  * A class with features to show how to do unit testing.
  *
diff --git a/render_example/src/Form/RenderExampleDemoForm.php b/render_example/src/Form/RenderExampleDemoForm.php
@@ -8,7 +8,6 @@
 use Drupal\Core\Config\ConfigFactoryInterface;
 use Symfony\Component\DependencyInjection\ContainerInterface;
 
-
 /**
  * Provides the form for toggling module features on and off.
  *
diff --git a/testing_example/tests/src/Functional/SkeletonTest.php b/testing_example/tests/src/Functional/SkeletonTest.php
@@ -1,6 +1,7 @@
 <?php
 
 namespace Drupal\Tests\testing_example\Functional;
+
 /**
  * How the namespace works.
  *

Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,7 @@`
`11`	`11`	`* @ingroup content_entity_example`
`12`	`12`	`*/`
`13`	`13`	`class ContactSettingsForm extends FormBase {`
	`14`	`+`
`14`	`15`	`/**`
`15`	`16`	`* Returns a unique string identifying the form.`
`16`	`17`	`*`
Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,6 @@`
`5`	`5`	`use Drupal\Core\Test\AssertMailTrait;`
`6`	`6`	`use Drupal\Tests\examples\Functional\ExamplesBrowserTestBase;`
`7`	`7`
`8`		`-`
`9`	`8`	`/**`
`10`	`9`	`* Tests for the email_example module.`
`11`	`10`	`*`
Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,6 @@`
`2`	`2`
`3`	`3`	`namespace Drupal\Tests\field_example\Functional;`
`4`	`4`
`5`		`-`
`6`	`5`	`/**`
`7`	`6`	`* Test the user-facing menus in Field Example.`
`8`	`7`	`*`
Original file line number	Diff line number	Diff line change
`@@ -153,7 +153,6 @@ function field_permission_example_entity_field_access($operation, FieldDefinitio`
`153`	`153`	`return AccessResult::forbidden();`
`154`	`154`	`}`
`155`	`155`
`156`		`-`
`157`	`156`	`/**`
`158`	`157`	`* Implements hook_ENTITY_TYPE_access().`
`159`	`158`	`*`
`@@ -176,6 +175,7 @@ function field_permission_example_entity_test_access(EntityInterface $entity, $o`
`176`	`175`	`}`
`177`	`176`	`return AccessResult::neutral();`
`178`	`177`	`}`
	`178`	`+`
`179`	`179`	`/**`
`180`	`180`	`* @} End of "defgroup field_permission_example".`
`181`	`181`	`*/`